DescribeDBClusters - 查询集群列表 - 云数据库 ClickHouse

查询云数据库ClickHouse指定地域的集群信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:DescribeDBClusters	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。	cn-hangzhou
DBClusterIds	string	否	集群 ID。说明不配置该参数时，默认查询所有集群的信息。	cc-bp108z124a8o7****
DBClusterDescription	string	否	集群描述。	cc-bp108z124a8o7****
DBClusterStatus	string	否	集群状态，取值说明： Preparing：准备中。 Creating：创建中。 Running：运行中。 Deleting：删除中。 SCALING_OUT：扩容中。	Running
PageSize	integer	否	每页记录数，取值： 30（默认值） 50 100	30
PageNumber	integer	否	页数。	1
Tag	array<object>	否	标签。
	object	否	标签。
Key	string	否	标签名称。	department
Value	string	否	标签的值。	it
ResourceGroupId	string	否	集群所属的资源组 ID。	rg-4690g37929****

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	总记录数。	1
PageSize	integer	每页记录数，取值： 30（默认值） 50 100	30
RequestId	string	请求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	integer	页数。	1
DBClusters	array<object>	集群列表。
DBCluster	object	集群列表
VpcId	string	VPC ID。	vpc-bp175iuvg8nxqraf2****
DBNodeCount	long	节点数量。单副本版，取值范围：1~48。双副本版，取值范围：1~24。	2
CreateTime	string	集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。	2021-10-28T07:24:45Z
PayType	string	付费类型，取值说明： Postpaid：按量付费。 Prepaid：预付费（包年包月）。	Postpaid
Tags	array<object>	标签列表。
Tag	object	标签。
Key	string	标签名称。	department
Value	string	标签的值。	it
StorageType	string	存储类型，取值说明： CloudESSD：ESSD PL1 云盘。 CloudESSD_PL2：ESSD PL2 云盘。 CloudESSD_PL3：ESSD PL3 云盘。 CloudEfficiency：高效云盘。	CloudESSD
Port	integer	HTTP 端口号。	8123
LockMode	string	集群的锁定模式，取值说明： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。 LockByRestoration：集群回滚前的自动锁定。 LockByDiskQuota：集群空间满自动锁定。	Unlock
Bid	string	站点 ID，取值说明： 26842：中国站。 26888：国际站。	26842
IsExpired	string	集群是否过期，取值说明： true：集群已过期。 false：集群未过期。	false
VpcCloudInstanceId	string	VPC 资源 ID。	vpc-bp175iuvg8nxqraf2****
ScaleOutStatus	object	数据搬迁状态。
Progress	string	数据搬迁百分比。说明仅集群状态为 SCALING_OUT 时，返回该参数。	0
Ratio	string	数据搬迁的进度，格式：已搬迁数据量/数据总量。说明仅集群状态为 SCALING_OUT 时，返回该参数。	0MB/60469MB
DBClusterId	string	集群 ID。	cc-bp108z124a8o7****
ConnectionString	string	VPC 连接地址。	cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com
CommodityCode	string	售卖商品 Code。	clickhouse_go_public_cn
ExpireTime	string	集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。说明按量付费集群无到期时间，返回值为空。	2011-05-30T12:11:4Z
DBNodeStorage	long	单节点存储空间，取值范围：100 GB~32000 GB。说明步长为 100 GB。	100
DBNodeClass	string	集群规格。单副本版，取值： - S4：4 核 16 GB。 - S8：8 核 32 GB。 S16：16 核 64 GB。 S32：32 核 128 GB。 S64 ：64 核 256 GB。 S104：104 核 384 GB。双副本版，取值： - C4：4 核 16 GB。 - C8：8 核 32 GB。 - C16：16 核 64 GB。 - C32：32 核 128 GB。 - C64 ：64 核 256 GB。 - C104：104 核 384 GB。	C8
AliUid	string	阿里云账号 ID。	140692647406****
LockReason	string	锁定原因。说明锁定模式为 Unlock 时，返回值为空。	DISK_FULL
RegionId	string	地域 ID。	cn-hangzhou
VSwitchId	string	交换机 ID。	vsw-bp1gzt31twhlo0sa5****
DBClusterStatus	string	集群状态，取值说明： Preparing：准备中。 Creating：创建中。 Running：运行中。 Deleting：删除中。 SCALING_OUT：扩容中。	Running
DBClusterDescription	string	集群描述。	test
DBClusterNetworkType	string	网络类型，目前只支持 VPC。	VPC
ZoneId	string	可用区 ID。	cn-hangzhou-h
Category	string	副本配置，取值说明： Basic：单副本版。 HighAvailability：双副本版。	Basic
ControlVersion	string	后台管控系统版本号，取值说明： v1 v2	v1
ExtStorageType	string	扩展存储类型，取值说明： CloudSSD：SSD 云盘。 CloudESSD：ESSD PL1 云盘。 CloudESSD_PL2：ESSD PL2 云盘。 CloudESSD_PL3：ESSD PL3 云盘。 CloudEfficiency：高效云盘。	CloudESSD
ExtStorageSize	integer	扩展存储空间。	100GB
ResourceGroupId	string	集群所属的资源组 ID。	rg-4690g37929****

示例

正常返回示例

JSON格式

{
  "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": "",
        "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": ""
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden	User not authorized to operate on the specified resource.	账户未被授予操作资源的权限
500	InternalError	An error occurred while processing your request.	系统内部错误，请稍后重试
503	ServiceUnavailable	An error occurred while processing your request.	系统暂时不可用，请稍后重试

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-03	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-06-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-06	OpenAPI 错误码发生变更	查看变更详情
2023-03-20	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-09-07	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情