List Connection Groups

GET 
/connection-groups/orgId/:orgId

List all Connection Groups for Organization.

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "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": {}
            }
          ]
        }
      ]
    }
  }
}

Example

{
  "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

This error occurs if JSON validation fails

application/json

Schema

Schema

any

Example (from schema)

{
  "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"
      ]
    }
  }
}

Example

{
  "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"
      ]
    }
  }
}

401

404

500

503

Loading...