Querying Cluster Details

Updated on 2024-04-18 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to query cluster details.

Call Method

For details, see Calling APIs.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
cluster_id	Yes	String	Cluster ID For details about how to obtain the ID, see Obtaining the Cluster ID.
project_id	Yes	String	Project ID. For details about how to obtain the ID, see Obtaining Project ID.

Request

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
cluster	ClusterDetail object	Cluster object

**Table 3** ClusterDetail
Parameter	Type	Description
id	String	Cluster ID
name	String	Cluster name
status	String	Cluster status. The value can be one of the following: CREATING: The instance is being created. ACTIVE: The instance is available. FAILED: The instance is unavailable. CREATE_FAILED: The instance failed to be created. DELETING: The instance is being deleted. DELETE_FAILED: The instance failed to be deleted. DELETED: The instance is deleted. FROZEN: The instance is being frozen. NOTE: If the query result is AVAILABLE, the service is available.
version	String	Data warehouse version
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
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 username
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. For details, see Data Warehouse Types.
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>	The key indicates an ongoing task. The value can be one of the following: CREATING RESTORING SNAPSHOTTING GROWING REBOOTING SETTING_CONFIGURATION CONFIGURING_EXT_DATASOURCE ADD_CN_ING: A CN is being added. DEL_CN_ING: A CN is being deleted. REDISTRIBUTING ELB_BINDING: ELB is being bound. ELB_UNBINDING: ELB is being unbound. ELB_SWITCHING: ELB nodes are being switched. NETWORK_CONFIGURING: The network is being configured. DISK_EXPANDING: The disk capacity is being expanded. ACTIVE_STANDY_SWITCHOVER: The active-standby switchover is being performed. CLUSTER_SHRINKING: The cluster is being scaled in. SHRINK_CHECKING: Scale-in detection is in progress. FLAVOR_RESIZING: The instance flavor is being changed. MANAGE_IP_BINDING: Login is being enabled. FINE_GRAINED_RESTORING: Fine-grained restoration is in progress. DR_RECOVERING: DR recovery is in progress. REPAIRING The value indicates the task progress.
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: UNFREEZING FREEZING RESTORING SNAPSHOTTING GROWING REBOOTING SETTING_CONFIGURATION CONFIGURING_EXT_DATASOURCE DELETING_EXT_DATASOURCE REBOOT_FAILURE RESIZE_FAILURE ADD_CN_ING: A CN is being added. DEL_CN_ING: A CN is being deleted. CREATING_NODE: Add a node. CREATE_NODE_FAILED: Failed to add the node. DELETING_NODE: Delete a node. DELETE_NODE_FAILED: Failed to delete the node. REDISTRIBUTING REDISTRIBUTE_FAILURE: Redistribution failed. WAITING_REDISTRIBUTION: Waiting to be redistributed REDISTRIBUTION_PAUSED: Redistribution is paused. ELB_BINDING: ELB is being bound. ELB_BIND_FAILED: Failed to associate ELB ELB_UNBINDING: ELB is being unbound. ELB_UNBIND_FAILED: Failed to disassociate ELB. ELB_SWITCHING: ELB nodes are being switched. ELB_SWITCHING_FAILED: Failed to switch ELB nodes. NETWORK_CONFIGURING: The network is being configured. NETWORK_CONFIG_FAILED: Failed to configure the network. DISK_EXPAND_FAILED: Failed to expand the disk capacity. DISK_EXPANDING: The disk capacity is being expanded. ACTIVE_STANDY_SWITCHOVER: The active-standby switchover is being performed. ACTIVE_STANDY_SWITCHOVER_FAILURE: The active-standby switchover failed. CLUSTER_SHRINK_FAILED: Failed to scale-in. CLUSTER_SHRINKING: The cluster is being scaled in. SHRINK_CHECK_FAILED: The scale-in detection failed. SHRINK_CHECKING: Scale-in detection is in progress. FLAVOR_RESIZING_FAILED: Failed to change the flavor. FLAVOR_RESIZING: The instance flavor is being changed. MANAGE_IP_BIND_FAILED: Failed to enable login. MANAGE_IP_BINDING: Login is being enabled. ORDER_PENDING: The order is pending to be paid. FINE_GRAINED_RESTORING: Fine-grained restoration is in progress. DR_RECOVERING: DR recovery is in progress.
parameter_group	ParameterGroup object	Parameter group details
node_type_id	String	Node type ID
security_group_id	String	Security group ID
private_ip	Array of strings	List of private network IP addresses
maintain_window	MaintainWindow object	Cluster maintenance window
resize_info	ResizeInfo object	Cluster scale-out details
failed_reasons	FailedReason object	Cause of failure. If the parameter is left empty, the cluster is in the normal state.
elb	ElbResp object	ELB bound to the cluster

**Table 4** Endpoints
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>

**Table 5** Nodes
Parameter	Type	Description
id	String	Cluster instance ID
status	String	Cluster instance status 100: Creating 199: Idle 200: Available 300: Unavailable 303: Creation failed. 304: Deleting 305: Deletion failed. 400: Deleted

**Table 6** Tags
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: =*<>\,\|/

**Table 7** PublicIp
Parameter	Type	Description
public_bind_type	String	Binding type of an EIP. The value can be one of the following: auto_assign not_use bind_existing
eip_id	String	EIP ID

**Table 8** PublicEndpoints
Parameter	Type	Description
public_connect_info	String	Public network connection information
jdbc_url	String	Public network JDBC URL. The default format is jdbc:postgresql://<public_connect_info>/<YOUR_DATABASE_name>.

**Table 9** ParameterGroup
Parameter	Type	Description
id	String	Parameter group ID
name	String	Parameter group name
status	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 failed

**Table 10** MaintainWindow
Parameter	Type	Description
day	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	String	Maintenance start time in HH:mm format. The time zone is GMT+0.
end_time	String	Maintenance end time in HH:mm format. The time zone is GMT+0.

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

**Table 12** FailedReason
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

**Table 13** ElbResp
Parameter	Type	Description
public_ip	String	Public IP address
private_ip	String	Private IP address
private_endpoint	String	ELB endpoint address
name	String	ELB name
id	String	ELB ID
vpc_id	String	ID of the VPC to which the ELB belongs

Example Request

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7

Example Response

Status code: 200

Cluster details have been queried successfully.

{
  "cluster" : {
    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15",
    "name" : "dws-1",
    "status" : "AVAILABLE",
    "version" : "1.2.0",
    "updated" : "2018-02-10T14:28:14Z",
    "created" : "2018-02-10T14:28: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.m1.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-9etypeb2a-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",
    "parameter_group" : {
      "id" : "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
      "name" : "Default-Parameter-Group-dws ",
      "status" : "In-Sync"
    },
    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
    "private_ip" : [ "192.168.0.12", "192.168.0.66" ],
    "maintain_window" : {
      "day" : "Wed",
      "start_time" : "18:00",
      "end_time" : "22:00"
    },
    "resize_info" : {
      "target_node_num" : "6",
      "origin_node_num" : "3",
      "resize_status" : "GROWING",
      "start_time" : "2018-02-14T14:28:14Z"
    }
  }
}

SDK Sample Code

The sample code is as follows:

Java
Python
Go
More SDK Sample Code

      
       
         
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListClusterDetailsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        ListClusterDetailsRequest request = new ListClusterDetailsRequest();
        try {
            ListClusterDetailsResponse response = client.listClusterDetails(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      
     

      
       
         
         # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListClusterDetailsRequest()
        response = client.list_cluster_details(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      
     

      
       
         
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListClusterDetailsRequest{}
	response, err := client.ListClusterDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

      
       
         
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListClusterDetailsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        ListClusterDetailsRequest request = new ListClusterDetailsRequest();
        try {
            ListClusterDetailsResponse response = client.listClusterDetails(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      
     

      
       
         
         # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListClusterDetailsRequest()
        response = client.list_cluster_details(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      
     

      
       
         
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListClusterDetailsRequest{}
	response, err := client.ListClusterDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code	Description
200	Cluster details have been 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.