Function

This API is used to query cluster details.

URI

• URI format

  GET /v1.0/{project_id}/clusters/{cluster_id}

• Parameter description

  Table 1 URI parameter description

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

Request Message

Sample request

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7

Response Message

• Sample response

  {
      "cluster": {
          "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
          "status": "AVAILABLE",
          "name": "dws-1",
          "updated": "2018-02-10T14:28:14Z",
          "created": "2018-02-10T14:28:14Z",
          "user_name": "dbadmin",
          "sub_status": "READONLY",
          "task_status": "SNAPSHOTTING",
          "action_progress": {"SNAPSHOTTING": "20%"},
          "node_type":   "dws.m1.xlarge.ultrahigh",
          
          "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
          "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
          "number_of_node": 3,
          "availability_zone": "cn-north-4b",
          "port": 8000,
          "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
          "public_ip": {
              "public_bind_type": "auto_assign",
              "eip_id": "85b20d7e-9etypeb2a-98f3-3c8843ea3574",
              "eip_address": "100.95.157.20"
          },        
          "private_ip":["192.168.0.12","192.168.0.66"],        
          "public_endpoints": [
              {
                  "public_connect_info": "dws-1.cn-north-4.myhuaweicloud.com",
                  "jdbc_url": "jdbc:postgresql://dws-1.cn-north-4.myhuaweicloud.com/<YOUR_DATABASE_name>"
              }
           ],
          "endpoints": [
              {
                  "connect_info": "dws-1.cn-north-4.myhuaweicloud.com",
                  "jdbc_url": "jdbc:postgresql://dws-1.cn-north-4.myhuaweicloud.com/<YOUR_DATABASE_name>"
              }
           ],
          "version": "1.2.0",
          "maintain_window": {
              "day": "Wed",
              "start_time": "22:00",
              "end_time": "02:00"
          },
          "resize_info" : { 
              "target_node_num": "6",
              "origin_node_num": "3",
              "status": "GROWING",
              "start_time": "2018-02-14T14:28:14Z",
              "origin_node_type": "dws.m1.xlarge.ultrahigh",             "target_node_type": "dws.d2.xlarge"         }, 
          "enterprise_project_id": "6a6a18fe-417a-4188-9214-75fd08c22065",         "recent_event": 6, 
          "tags":[              { 
                  "key": "key1",                  "value": "value1"              }, 
              { 
                  "key": "key2",                  "value": "value2"              } 
            ], 
  
           "parameter_group": {               "id": "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
                "name": "Default-Parameter-Group-dws ",               "status": "In-Sync"
           } 
      }
  } 

• Parameter description

  Table 2 Response parameter description

  Parameter	Type	Description
  cluster	ClusterDetail object	Cluster object

  Table 3 ClusterDetail

  Parameter	Type	Description
  action_progress	Map<String,String>	The value indicates the state of an ongoing task. The value can be one of the following: GROWING RESTORING SNAPSHOTTING REPAIRING CREATING
  public_ip	PublicIp object	Public IP address. If the parameter is not specified, public connection is not used by default.
  number_of_node	Integer	Number of nodes
  recent_event	Integer	Number of events
  vpc_id	String	VPC ID
  user_name	String	Username of the administrator
  security_group_id	String	Security group ID
  private_ip	Array of strings	List of private network IP addresses
  parameter_group	ParameterGroup object	Parameter group details
  node_type	String	Node type
  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.
  id	String	Cluster ID
  failed_reasons	Object	Cause of failure. If the parameter is left empty, the cluster is in the normal state.
  availability_zone	String	AZ
  endpoints	Array of Endpoints objects	Private network connection information about the cluster.
  task_status	String	Cluster management task. The value can be one of the following: UNFREEZING FREEZING RESTORING SNAPSHOTTING GROWING REBOOTING SETTING_CONFIGURATION CONFIGURING_EXT_DATASOURCE DELETING_EXT_DATASOURCE REBOOT_FAILURE RESIZE_FAILURE
  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
  created	String	Cluster creation time. The format is ISO8601:YYYY-MM-DDThh:mm:ssZ.
  node_type_id	String	Node type ID
  node_detail	NodeDetail object	Node details
  version	String	Data warehouse version
  maintain_window	MaintainWindow object	Cluster maintenance window
  tags	Array of Tags objects	Labels in a cluster
  resize_info	ResizeInfo object	Cluster scale-out details
  enterprise_project_id	String	Enterprise project ID. The value 0 indicates the ID of the default enterprise project.
  port	Integer	Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.
  name	String	Cluster name
  subnet_id	String	Subnet ID
  updated	String	Last modification time of a cluster. The format is ISO8601:YYYY-MM-DDThh:mm:ssZ.
  status	String	Cluster status. The value can be one of the following: CREATING AVAILABLE UNAVAILABLE CREATION FAILED FROZEN

  Table 4 NodeDetail

  Parameter	Mandatory	Type	Description
  name	Yes	String	Node attribute
  value	Yes	String	Node attribute value

  Table 5 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 6 PublicEndpoints

  Parameter	Mandatory	Type	Description
  public_connect_info	No	String	Public network connection information
  jdbc_url	No	String	JDBC URL of the public network. The following is the default format: jdbc:postgresql://< public_connect_info>/<YOUR_DATABASE_name>

  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 MaintainWindow

  Parameter	Mandatory	Type	Description
  day	No	String	Maintenance time in each week in the unit of day. The value can be one of the following: Mon Tue Wed Thu Fri Sat Sun
  start_time	No	String	Maintenance start time. The format is HH:mm. The time zone is GMT+0.
  end_time	No	String	Maintenance end time. The format is HH:mm. The time zone is GMT+0.

  Table 9 ResizeInfo

  Parameter	Type	Description
  resize_status	String	Scale-out status. The value can be either of the following: GROWING RESIZE_FAILURE
  start_time	String	Scale-out start time. The format is ISO8601:YYYY-MM-DDThh:mm:ss.
  target_node_num	Integer	Number of nodes after the scale-out
  origin_node_num	Integer	Number of nodes before the scale-out

  Table 10 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 11 ParameterGroup

  Parameter	Mandatory	Type	Description
  id	Yes	String	Parameter group ID
  name	Yes	String	Parameter group name
  status	Yes	String	Cluster parameter status. The value can be one of the following: In-Sync: synchronized Applying: in application Pending-Reboot: restart for the modification to take effect Sync-Failure: application failure

Status Code

• Normal

  200

• Abnormal

  Table 12 Returned value description

  Returned Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	You do not have the permission to perform the operation.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	The service is unavailable.