DescribeDBClusters -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBClusters	The operation that you want to perform. Set the value to DescribeDBClusters.
RegionId	String	Yes	cn-hangzhou	The region ID of the cluster. You can call the DescribeRegions operation to query the most recent region list.
DBClusterIds	String	No	cc-bp108z124a8o7****	The ID of the cluster. Note If you do not specify this parameter, all clusters are queried by default.
DBClusterDescription	String	No	cc-bp108z124a8o7****	The description of the cluster.
DBClusterStatus	String	No	Running	The state of the cluster. Valid values: Preparing: The cluster is being prepared. Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being deleted. SCALING_OUT: The cluster is being scaled out.
PageSize	Integer	No	30	The number of entries to return on each page. Default value: 30. Valid values: 30 50 100
PageNumber	Integer	No	1	The number of the page to return.
Tag.N.Key	String	No	department	The name of the tag.
Tag.N.Value	String	No	it	The value of the tag.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	1	The total number of returned entries.
PageSize	Integer	30	The number of entries returned on each page. Default value: 30. Valid values: 30 50 100
RequestId	String	F5178C10-1407-4987-9133-DE4DC9119F75	The ID of the request.
PageNumber	Integer	1	The page number of the returned page.
DBClusters	Array of DBCluster		The details about the returned clusters.
DBCluster
VpcId	String	vpc-bp175iuvg8nxqraf2****	The ID of the virtual private cloud (VPC) to which the cluster is connected.
DBNodeCount	Long	2	The number of nodes. If the cluster is of the Single-replica Edition, the value ranges from 1 to 48. If the cluster is of the Double-replica Edition, the value ranges from 1 to 24.
CreateTime	String	2021-10-28T07:24:45Z	The time when the cluster was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format.
PayType	String	Postpaid	The billing method of the cluster. Valid values: Postpaid: The cluster uses the pay-as-you-go billing method. Prepaid: The cluster uses the subscription billing method.
Tags	Array of Tag		The details about returned tags.
Tag
Key	String	department	The name of the tag.
Value	String	it	The value of the tag.
StorageType	String	CloudESSD	The storage type of the cluster. Valid values: CloudESSD: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1. CloudESSD_PL2: The cluster uses an ESSD of PL2. CloudESSD_PL3: The cluster uses an ESSD of PL3. CloudEfficiency: The cluster uses an ultra disk.
Port	Integer	8123	The HTTP port number.
LockMode	String	Unlock	The lock state of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked because the cluster expired. LockByRestoration: The cluster is automatically locked because the cluster is about to be rolled back. LockByDiskQuota: The cluster is automatically locked because the disk space is exhausted.
Bid	String	26842	The ID of the site. Valid values: 26842: the China site (aliyun.com) 26888: the International site (alibabacloud.com)
IsExpired	String	false	Indicates whether the cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired.
VpcCloudInstanceId	String	vpc-bp175iuvg8nxqraf2****	The ID of the VPC.
ScaleOutStatus	Object		The status of the data migration task.
Progress	String	0	The progress of the data migration task in percentage. Note This parameter is returned only when the cluster is in the SCALING_OUT state.
Ratio	String	0MB/60469MB	The progress of the data migration task. This value is displayed in the following format: Data volume that has been migrated/Total data volume. Note This parameter is returned only when the cluster is in the SCALING_OUT state.
DBClusterId	String	cc-bp108z124a8o7****	The ID of the cluster.
ConnectionString	String	cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com	The endpoint that is used to connect to the cluster over the VPC.
CommodityCode	String	clickhouse_go_public_cn	The commodity code of the cluster.
ExpireTime	String	2011-05-30T12:11:4Z	The time when the cluster expired. The time is in the yyyy-MM-ddTHH:mm:ssZ format. Note Pay-as-you-go clusters never expire. If the cluster is a pay-as-you-go cluster, an empty string is returned for this parameter.
DBNodeStorage	Long	100	The storage capacity of a single node. Valid values: 100 to 32000. Unit: GB. Note This value is a multiple of 100.
DBNodeClass	String	C8	The specification of the cluster. If the cluster is of the Single-replica Edition, the following values are valid: S4: 4 cores, 16 GB. S8: 8 cores, 32 GB. S16: 16 cores, 64 GB. S32: 32 cores, 128 GB. S64: 64 cores, 256 GB. S104: 104 cores, 384 GB. If the cluster is a cluster of the Double-replica Edition, the following values are valid: C4: 4 cores, 16 GB. C8: 8 cores, 32 GB. C16: 16 cores, 64 GB. C32: 32 cores, 128 GB. C64: 64 cores, 256 GB. C104: 104 cores, 384 GB.
AliUid	String	140692647406****	The ID of the Alibaba Cloud account.
LockReason	String	DISK_FULL	The reason why the cluster is locked. Note If the value of the LockMode parameter is Unlock, an empty string is returned for this parameter.
RegionId	String	cn-hangzhou	The region ID of the cluster.
VSwitchId	String	vsw-bp1gzt31twhlo0sa5****	The ID of the vSwitch.
DBClusterStatus	String	Running	The state of the cluster. Valid values: Preparing: The cluster is being prepared. Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being deleted. SCALING_OUT: The cluster is being scaled out.
DBClusterDescription	String	test	The description of the cluster.
DBClusterNetworkType	String	VPC	The network type of the cluster. Only a VPC is supported.
ZoneId	String	cn-hangzhou-h	The ID of the zone.
Category	String	Basic	The edition of the cluster. Valid values: Basic: the Single-replica Edition HighAvailability: the Double-replica Edition
ControlVersion	String	v1	The version number of the ApsaraDB for ClickHouse console that is used to manage the cluster. Valid values: v1 v2

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClustersResponse>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PageNumber>1</PageNumber>
    <DBClusters>
        <VpcId>vpc-bp175iuvg8nxqraf2****</VpcId>
        <DBNodeCount>2</DBNodeCount>
        <CreateTime>2021-10-28T07:24:45Z</CreateTime>
        <PayType>Postpaid</PayType>
        <Tags>
            <Key>department</Key>
            <Value>it</Value>
        </Tags>
        <StorageType>CloudESSD</StorageType>
        <Port>8123</Port>
        <LockMode>Unlock</LockMode>
        <Bid>26842</Bid>
        <IsExpired>false</IsExpired>
        <VpcCloudInstanceId>vpc-bp175iuvg8nxqraf2****</VpcCloudInstanceId>
        <ScaleOutStatus>
            <Progress>0</Progress>
            <Ratio>0MB/60469MB</Ratio>
        </ScaleOutStatus>
        <DBClusterId>cc-bp108z124a8o7****</DBClusterId>
        <ConnectionString>cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com</ConnectionString>
        <CommodityCode>clickhouse_go_public_cn</CommodityCode>
        <ExpireTime>2011-05-30T12:11:4Z</ExpireTime>
        <DBNodeStorage>100</DBNodeStorage>
        <DBNodeClass>C8</DBNodeClass>
        <AliUid>140692647406****</AliUid>
        <LockReason>DISK_FULL</LockReason>
        <RegionId>cn-hangzhou</RegionId>
        <VSwitchId>vsw-bp1gzt31twhlo0sa5****</VSwitchId>
        <DBClusterStatus>Running</DBClusterStatus>
        <DBClusterDescription>test</DBClusterDescription>
        <DBClusterNetworkType>VPC</DBClusterNetworkType>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <Category>Basic</Category>
        <ControlVersion>v1</ControlVersion>
    </DBClusters>
</DescribeDBClustersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 30,
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber" : 1,
  "DBClusters" : [ {
    "VpcId" : "vpc-bp175iuvg8nxqraf2****",
    "DBNodeCount" : 2,
    "CreateTime" : "2021-10-28T07:24:45Z",
    "PayType" : "Postpaid",
    "Tags" : [ {
      "Key" : "department",
      "Value" : "it"
    } ],
    "StorageType" : "CloudESSD",
    "Port" : 8123,
    "LockMode" : "Unlock",
    "Bid" : "26842",
    "IsExpired" : "false",
    "VpcCloudInstanceId" : "vpc-bp175iuvg8nxqraf2****",
    "ScaleOutStatus" : {
      "Progress" : "0",
      "Ratio" : "0MB/60469MB"
    },
    "DBClusterId" : "cc-bp108z124a8o7****",
    "ConnectionString" : "cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com",
    "CommodityCode" : "clickhouse_go_public_cn",
    "ExpireTime" : "2011-05-30T12:11:4Z",
    "DBNodeStorage" : 100,
    "DBNodeClass" : "C8",
    "AliUid" : "140692647406****",
    "LockReason" : "DISK_FULL",
    "RegionId" : "cn-hangzhou",
    "VSwitchId" : "vsw-bp1gzt31twhlo0sa5****",
    "DBClusterStatus" : "Running",
    "DBClusterDescription" : "test",
    "DBClusterNetworkType" : "VPC",
    "ZoneId" : "cn-hangzhou-h",
    "Category" : "Basic",
    "ControlVersion" : "v1"
  } ]
}

Error codes


HttpCode	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	The error message returned because an internal error has occurred. Try again later.
503	ServiceUnavailable	An error occurred while processing your request.	The error message returned because the service is unavailable. Try again later.

For a list of error codes, see Service error codes.