DescribeDBClusters - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Describes ApsaraDB for ClickHouse clusters in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:DescribeDBClusters

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
DBClusterIds	string	No	The cluster ID. Note If you do not specify this parameter, information about all clusters is queried by default.	cc-bp108z124a8o7****
DBClusterDescription	string	No	The cluster description.	cc-bp108z124a8o7****
DBClusterStatus	string	No	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.	Running
PageSize	integer	No	The number of entries per page. Valid values: 30 (Default) 50 100	30
PageNumber	integer	No	The page number.	1
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The key of the tag.	department
Value	string	No	The value of the tag.	it
ResourceGroupId	string	No	The ID of the resource group to which the cluster belongs.	rg-4690g37929****

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	1
PageSize	integer	The number of entries returned per page. Valid values: 30 (Default) 50 100	30
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	integer	The page number.	1
DBClusters	object
DBCluster	array<object>	The list of clusters.
	array<object>	The list of clusters.
VpcId	string	The VPC ID.	vpc-bp175iuvg8nxqraf2****
DBNodeCount	integer	The number of nodes. For a single-replica edition cluster, the value is from 1 to 48. For a dual-replica edition cluster, the value is from 1 to 24.	2
CreateTime	string	The time when the cluster was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2021-10-28T07:24:45Z
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
Tags	object
Tag	array<object>	The list of tags.
	object	The tag.
Key	string	The key of the tag.	department
Value	string	The value of the tag.	it
StorageType	string	The storage class. Valid values: CloudESSD: ESSD PL1. CloudESSD_PL2: ESSD PL2. CloudESSD_PL3: ESSD PL3. CloudEfficiency: ultra disk.	CloudESSD
Port	integer	The HTTP port.	8123
LockMode	string	The lock mode of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked upon expiration. LockByRestoration: The cluster is automatically locked before a rollback. LockByDiskQuota: The cluster is automatically locked because the disk is full.	Unlock
Bid	string	The site ID. Valid values: 26842: Alibaba Cloud China Website (www.aliyun.com). 26888: Alibaba Cloud International Website (www.alibabacloud.com).	26842
IsExpired	string	Indicates whether the cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired.	false
VpcCloudInstanceId	string	The ID of the VPC instance.	vpc-bp175iuvg8nxqraf2****
ScaleOutStatus	object	The data migration status.
Progress	string	The data migration progress in percentage. Note This parameter is returned only when the cluster is in the SCALING_OUT state.	0
Ratio	string	The data migration progress. The format is `Data migrated/Total data`. Note This parameter is returned only when the cluster is in the SCALING_OUT state.	0MB/60469MB
ScaleOutDisableWriteWindows	string	The write-blocking window for the upgrade or downgrade.	2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
DBClusterId	string	The cluster ID.	cc-bp108z124a8o7****
ConnectionString	string	The VPC endpoint.	cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com
CommodityCode	string	The commodity code.	clickhouse_go_public_cn
ExpireTime	string	The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format. Note Pay-as-you-go clusters do not expire. This parameter is empty for pay-as-you-go clusters.	2011-05-30T12:11:4Z
DBNodeStorage	integer	The storage space of a single node. The value ranges from 100 GB to 32,000 GB. Note The step size is 100 GB.	100
DBNodeClass	string	The instance type of the cluster. For single-replica edition clusters, valid values are: LS20: Large storage, 20 cores, 88 GB memory. LS40: Large storage, 40 cores, 176 GB memory. LS80: Large storage, 80 cores, 352 GB memory. S8: Standard, 8 cores, 32 GB memory. S16: Standard, 16 cores, 64 GB memory. S32: Standard, 32 cores, 128 GB memory. S64: Standard, 64 cores, 256 GB memory. S80: Standard, 80 cores, 384 GB memory. S104: Standard, 104 cores, 384 GB memory. For dual-replica edition clusters, valid values are: LC20: Large storage, 20 cores, 88 GB memory. LC40: Large storage, 40 cores, 176 GB memory. LC80: Large storage, 80 cores, 352 GB memory. C8: Standard, 8 cores, 32 GB memory. C16: Standard, 16 cores, 64 GB memory. C32: Standard, 32 cores, 128 GB memory. C64: Standard, 64 cores, 256 GB memory. C80: Standard, 80 cores, 384 GB memory. C104: Standard, 104 cores, 384 GB memory. For single-replica edition clusters, valid values are: - S4: 4 cores, 16 GB memory. - S8: 8 cores, 32 GB memory. S16: 16 cores, 64 GB memory. S32: 32 cores, 128 GB memory. S64 : 64 cores, 256 GB memory. S104: 104 cores, 384 GB memory. For dual-replica edition clusters, valid values are: - C4: 4 cores, 16 GB memory. - C8: 8 cores, 32 GB memory. - C16: 16 cores, 64 GB memory. - C32: 32 cores, 128 GB memory. - C64 : 64 cores, 256 GB memory. - C104: 104 cores, 384 GB memory.	C8
AliUid	string	The Alibaba Cloud account ID.	140692647406****
LockReason	string	The reason why the cluster was locked. Note This parameter is empty if the cluster is not locked.	DISK_FULL
RegionId	string	The region ID.	cn-hangzhou
VSwitchId	string	The vSwitch ID.	vsw-bp1gzt31twhlo0sa5****
DBClusterStatus	string	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.	Running
DBClusterDescription	string	The cluster description.	test
DBClusterNetworkType	string	The network type. Only VPC is supported.	VPC
ZoneId	string	The zone ID.	cn-hangzhou-h
Category	string	The edition of the cluster. Valid values: Basic: Single-replica Edition. HighAvailability: Dual-replica Edition.	Basic
ControlVersion	string	The version of the backend management system. Valid values: v1 v2	v1
ExtStorageType	string	The extended storage class. Valid values: CloudSSD: standard SSD. CloudESSD: ESSD PL1. CloudESSD_PL2: ESSD PL2. CloudESSD_PL3: ESSD PL3. CloudEfficiency: ultra disk.	CloudESSD
ExtStorageSize	integer	The extended storage space.	100GB
ResourceGroupId	string	The ID of the resource group to which the cluster belongs.	rg-4690g37929****
DbVersion	string	The kernel version of the cluster.	23.8

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": 1,
  "DBClusters": {
    "DBCluster": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "DBNodeCount": 2,
        "CreateTime": "2021-10-28T07:24:45Z",
        "PayType": "Postpaid",
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "it"
            }
          ]
        },
        "StorageType": "CloudESSD",
        "Port": 8123,
        "LockMode": "Unlock",
        "Bid": "26842",
        "IsExpired": "false",
        "VpcCloudInstanceId": "vpc-bp175iuvg8nxqraf2****",
        "ScaleOutStatus": {
          "Progress": "0",
          "Ratio": "0MB/60469MB"
        },
        "ScaleOutDisableWriteWindows": "2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00",
        "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",
        "ExtStorageType": "CloudESSD",
        "ExtStorageSize": 0,
        "ResourceGroupId": "rg-4690g37929****",
        "DbVersion": "23.8"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
403	Forbidden	User not authorized to operate on the specified resource.	The account is not granted permission to manipulate the resource
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.