Querying the Cluster List

Function

This API is used to query and display the cluster list.

URI

• URI format

  GET /v1.0/{project_id}/clusters

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID. For details about how to obtain the ID, see Obtaining a Project ID.

Request

Request example

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters

Response

• Example response

  {
          "clusters": [
          {
          "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
          "status": "AVAILABLE",
          "sub_status": "READONLY",
          "task_status": "SNAPSHOTTING",
          "action_progress": {"SNAPSHOTTING": "20%"},
          "node_type":   "dws.d1.xlarge.ultrahigh",
          "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
          "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
          "number_of_node": 3,
          "availability_zone": "ae-ad-1",
          "port": 8000,
          "name": "dws-1",
          "version": "1.2.0",
          "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
          "user_name": "dbadmin",
          "public_ip": {
              "public_bind_type": "auto_assign",
              "eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
           },
          "public_endpoints": [
              {
                  "public_connect_info": "10.0.0.8:8000",
                  "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
              }
           ],
          "endpoints": [
              {
                  "connect_info": "192.168.0.12:8000",
                  "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
              }
           ] , 
          "updated": "2016-02-10T14:28:14Z",
          "created": "2016-02-10T14:26:14Z", 
          "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada",  
          "recent_event": 6
          "tags":[           
                   { 
                    "key": "key1",              
                    "value": "value1"           
                   }, 
                  { 
                  "key": "key2",              
                  "value": "value2"            
                  } 
                ], 
          }
      ]
  }

• Parameter description

  Table 2 Response parameter description

  Parameter	Type	Description
  clusters	Array of ClusterInfo objects	List of cluster objects
  count	Integer	Total number of cluster objects

  Table 3 ClusterInfo

  Parameter	Type	Description
  id	String	Cluster ID
  status	String	Cluster status. The value can be one of the following: CREATING AVAILABLE UNAVAILABLE CREATION FAILED
  sub_status	String	Sub-status of clusters in the AVAILABLE state. The value can be one of the following: NORMAL READONLY REDISTRIBUTING REDISTRIBUTION-FAILURE UNBALANCED UNBALANCED | READONLY DEGRADED DEGRADED | READONLY DEGRADED | UNBALANCED UNBALANCED | REDISTRIBUTING UNBALANCED | REDISTRIBUTION-FAILURE READONLY | REDISTRIBUTION-FAILURE UNBALANCED | READONLY | REDISTRIBUTION-FAILURE DEGRADED | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | READONLY
  task_status	String	Cluster management task. The value can be one of the following: RESTORING SNAPSHOTTING GROWING REBOOTING SETTING_CONFIGURATION CONFIGURING_EXT_DATASOURCE DELETING_EXT_DATASOURCE REBOOT_FAILURE RESIZE_FAILURE
  action_progress	Map<String,String>	Task information, consisting of a key and a value. The key indicates an ongoing task, and the value indicates the progress of the ongoing task. Valid key values include: GROWING RESTORING SNAPSHOTTING REPAIRING CREATING: The task is being created. Its value is the progress of the creation task. The following is an example: "action_progress": {"SNAPSHOTTING":"16%"}
  node_type	String	Node type
  subnet_id	String	Subnet ID
  security_group_id	String	Security group ID
  number_of_node	Integer	Number of nodes in a cluster. The value ranges from 3 to 256.
  availability_zone	String	AZ
  port	Integer	Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.
  name	String	Cluster name
  version	String	Data warehouse version
  vpc_id	String	VPC ID
  user_name	String	Username of the administrator
  public_ip	PublicIp object	Public IP address. If the parameter is not specified, public connection is not used by default.
  public_endpoints	Array of PublicEndpoints objects	Public network connection information about the cluster. If the parameter is not specified, the public network connection information is not used by default.
  endpoints	Array of Endpoints objects	Private network connection information about the cluster.
  updated	String	Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ
  created	String	Cluster creation time. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ
  tags	Tags object	Tags in a cluster
  recent_event	Integer	Number of events
  failed_reasons	FailedReason object	Cause of failure. If the parameter is left empty, the cluster is in the normal state.

  Table 4 PublicIp

  Parameter	Mandatory	Type	Description
  public_bind_type	Yes	String	Binding type of an EIP. The value can be one of the following: auto_assign not_use bind_existing
  eip_id	No	String	EIP ID

  Table 5 Tags

  Parameter	Type	Description
  value	String	Value. A value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/
  key	String	Key. A key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/

  Table 6 PublicEndpoints

  Parameter	Type	Description
  public_connect_info	String	Public network connection information
  jdbc_url	String	JDBC URL of the public network

  Table 7 Endpoints

  Parameter	Mandatory	Type	Description
  connect_info	Yes	String	Private network connection information
  jdbc_url	Yes	String	JDBC URL on the private network. The following is the default format: jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>

  Table 8 FailedReason

  Parameter	Type	Description
  error_code	String	Error code
  error_msg	String	Error message

Returned Value

• Normal

  200

• Exception

  Table 9 Returned values

  Returned Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authorization failed.
  403 Forbidden	No operation permission.
  404 Not Found	No resources found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	The service is unavailable.