DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Connection Groups

Connection Groups

Create And List

This API manages Connection Groups. Connection Groups are referred to in the Design Center UI as Data Warehouses.

HTTP REQUEST: GET

List all Connection Groups for Organization.

GET/connection-groups/orgId/{orgId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
400This error occurs if JSON validation fails
401
404
500
503
200 Response Body
{
  "status": {
    "code": 0,
    "message": "200 OK"
  },
  "responseCreated": "2018-03-29T21:43:45.491Z",
  "response": {
    "visibleQueryRoles": {
      "large_user_query_role": true,
      "small_user_query_role": true,
      "system_query_role": true,
      "canary_query_role": false
    },
    "results": {
      "count": 1,
      "values": [
        {
          "id": "d41b3ab5-db46-47ac-8417-3dca2579a131",
          "name": "Hive Warehouse",
          "organizationId": "default",
          "connectionId": "con1",
          "hdfsUri": "hdfs://atscale-01:8020",
          "defaultSchema": "as_adventure",
          "extraProperties": {},
          "subgroups": [
            {
              "id": "0eec2ea7-3c33-4f3b-a5d0-d7bde1e48e3a",
              "name": "atscale-hive-system",
              "hosts": "atscale-01,atscale-02",
              "port": 10510,
              "connectorType": "hive",
              "username": "atscale",
              "extraJdbcFlags": "",
              "queryRoles": [
                "large_user_query_role",
                "system_query_role"
              ],
              "extraProperties": {}
            },
            {
              "id": "fd8465df-d278-431c-a01c-2b77d8d5b098",
              "name": "atscale-hive-interactive",
              "hosts": "atscale-01,atscale-02",
              "port": 10510,
              "connectorType": "hive",
              "username": "atscale",
              "extraJdbcFlags": "",
              "queryRoles": [
                "small_user_query_role"
              ],
              "extraProperties": {}
            }
          ]
        }
      ]
    }
  }
}
400 Response Body
{
  "status": {
    "code": 0,
    "i18n_message": "JSON validation failed",
    "message": "JSON validation failed"
  },
  "responseCreated": "2018-03-29T22:05:50.667Z",
  "response": {
    "error": "json_validation",
    "message": "JSON validation failed",
    "i18n_message": "JSON validation failed",
    "code": 0,
    "more_info": {
      "/isDefault": [
        "error.path.missing"
      ]
    }
  }
}

HTTP REQUEST: POST

Create a new Connection Group.

POST/connection-groups/orgId/{orgId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
Request Body
{
  "platformType": "hadoop",
  "name": "Hive Warehouse 3",
  "connectionId": "con1",
  "overrideConnectionId": true,
  "aggregateSchema": "atscaleagg",
  "readOnly": false,
  "isImpersonationEnabled": false,
  "isCanaryAlwaysEnabled": false,
  "isPartialAggHitEnabled": false,
  "extraProperties": {
    "udafMode": "engine_managed",
    "udafSchema": "atscaleudaf",
    "fsArtifactInstallPath": "/user/atscaler/atscale/engine",
    "hadoopRpcProtection": "authentication",
    "useNameNode2": "false"
  },
  "filesystemType": "hdfs",
  "filesystemUri": "hdfs://hadoop-node-01.atscale.com:8020",
  "subgroups": [
    {
      "name": "impala-sql",
      "connectorType": "impala",
      "hosts": "hadoop-node-01.atscale.com",
      "port": 21050,
      "extraJdbcFlags": ";auth=noSasl",
      "isKerberosClientEnabled": false,
      "username": "username_value",
      "password": "password_value",
      "queryRoles": [
        "large_user_query_role",
        "system_query_role"
      ]
    }
  ]
}
200 Response Body
{
  "status": {
    "code": 0,
    "message": "200 OK"
  },
  "responseCreated": "2018-03-30T16:56:52.140Z",
  "response": {
    "created": true,
    "id": "f6499aec-0963-4cc5-b772-3e2d4bfa15a4"
  }
}