Querying the Cluster List
Function
This API is used to query and display the cluster list.
Debugging
You can debug this API in API Explorer.
URI
1 |
GET /v1.0/{project_id}/clusters
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the ID, see Obtaining Project ID. |
Request Parameters
None
Response parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
clusters |
Array of ClusterInfo objects |
List of cluster objects |
count |
Integer |
Total number of cluster objects |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Cluster ID |
name |
String |
Cluster name |
status |
String |
Cluster status. The value can be one of the following: |
version |
String |
Data warehouse version |
updated |
String |
Last modification time of a cluster in ISO8601:YYYY-MM-DDThh:mm:ssZ format |
created |
String |
Cluster creation time. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ |
port |
Integer |
Cluster service port. |
endpoints |
Array of Endpoints objects |
Private network connection information about the cluster. |
nodes |
Array of Nodes objects |
Cluster instance |
tags |
Array of Tags objects |
Cluster tag |
user_name |
String |
Administrator user name |
number_of_node |
Integer |
Number of nodes in a cluster |
recent_event |
Integer |
Number of events |
availability_zone |
String |
AZ |
enterprise_project_id |
String |
Enterprise project ID. The value 0 indicates the ID of the default enterprise project. |
node_type |
String |
Node type. |
vpc_id |
String |
VPC ID, |
subnet_id |
String |
Subnet ID, |
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. |
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:
An example is as follows: "action_progress": {"SNAPSHOTTING":"16%"} |
sub_status |
String |
Sub-status of clusters in the AVAILABLE state. The value can be one of the following:
|
task_status |
String |
Cluster management task. The value can be one of the following: |
security_group_id |
String |
Security group ID |
failed_reasons |
FailedReason object |
Cause of failure. If the parameter is left empty, the cluster is in the normal state. |
Parameter |
Type |
Description |
---|---|---|
connect_info |
String |
Private network connection information |
jdbc_url |
String |
Intranet JDBC URL. The default format is jdbc:postgresql://<connect_info>/<YOUR_DATABASE_NAME> |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Cluster instance ID |
status |
String |
Cluster instance status |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Key. A tag key can contain a maximum of 128 characters. It cannot be an empty string or start or end with a space. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/ |
value |
String |
Value. A tag value can contain a maximum of 255 characters, which can be an empty string. It cannot start or end with a space. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/ |
Parameter |
Type |
Description |
---|---|---|
public_bind_type |
String |
Binding type of an EIP. The value can be one of the following: |
eip_id |
String |
EIP ID |
Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters
Example Response
Status code: 200
The cluster list is queried successfully.
{ "clusters" : [ { "id" : "7d85f602-a948-4a30-afd4-e84f47471c15", "name" : "dws-1", "status" : "AVAILABLE", "version" : "1.2.0", "updated" : "2016-02-10T14:28:14Z", "created" : "2016-02-10T14:26:14Z", "port" : 8000, "endpoints" : [ { "connect_info" : "dws-1.cn-north-4.myhuaweicloud.com", "jdbc_url" : "jdbc:postgresql://dws-1.cn-north-4.myhuaweicloud.com/<YOUR_DATABASE_name>" } ], "nodes" : [ { "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e", "status" : "200" }, { "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b", "status" : "200" }, { "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9", "status" : "200" } ], "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ], "user_name" : "dbadmin", "number_of_node" : 3, "recent_event" : 6, "availability_zone" : "cn-north-4b", "enterprise_project_id" : "0", "node_type" : "dws.d1.xlarge.ultrahigh", "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574", "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720", "public_ip" : { "public_bind_type" : "auto_assign", "eip_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574" }, "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>" } ], "action_progress" : { "SNAPSHOTTING" : "20%" }, "sub_status" : "READONLY", "task_status" : "SNAPSHOTTING", "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b" } ] }
Status Code
Status Code |
Description |
---|---|
200 |
The cluster list is queried successfully. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot