全部产品
Search
文档中心

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

更新时间:Mar 01, 2024

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。

cn-hangzhou
DBClusterIdsstring

集群 ID。

说明 不配置该参数时,默认查询所有集群的信息。
cc-bp108z124a8o7****
DBClusterDescriptionstring

集群描述。

cc-bp108z124a8o7****
DBClusterStatusstring

集群状态,取值说明:

  • Preparing:准备中。
  • Creating:创建中。
  • Running:运行中。
  • Deleting:删除中。
  • SCALING_OUT:扩容中。
Running
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页数。

1
Tagobject []

标签。

Keystring

标签名称。

department
Valuestring

标签的值。

it
ResourceGroupIdstring

集群所属的资源组 ID。

rg-4690g37929****

返回参数

名称类型描述示例值
object
TotalCountinteger

总记录数。

1
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
RequestIdstring

请求 ID。

F5178C10-1407-4987-9133-DE4DC9119F75
PageNumberinteger

页数。

1
DBClustersobject []

集群列表。

VpcIdstring

VPC ID。

vpc-bp175iuvg8nxqraf2****
DBNodeCountlong

节点数量。

  • 单副本版,取值范围:1~48。
  • 双副本版,取值范围:1~24。
2
CreateTimestring

集群的创建时间,格式:yyyy-MM-ddTHH:mm:ssZ。

2021-10-28T07:24:45Z
PayTypestring

付费类型,取值说明:

  • Postpaid:按量付费。
  • Prepaid:预付费(包年包月)。
Postpaid
Tagsobject []

标签列表。

Keystring

标签名称。

department
Valuestring

标签的值。

it
StorageTypestring

存储类型,取值说明:

  • CloudESSD:ESSD PL1 云盘。
  • CloudESSD_PL2:ESSD PL2 云盘。
  • CloudESSD_PL3:ESSD PL3 云盘。
  • CloudEfficiency:高效云盘。
CloudESSD
Portinteger

HTTP 端口号。

8123
LockModestring

集群的锁定模式,取值说明:

  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:集群过期自动锁定。
  • LockByRestoration:集群回滚前的自动锁定。
  • LockByDiskQuota:集群空间满自动锁定。
Unlock
Bidstring

站点 ID,取值说明:

  • 26842:中国站。
  • 26888:国际站。
26842
IsExpiredstring

集群是否过期,取值说明:

  • true:集群已过期。
  • false:集群未过期。
false
VpcCloudInstanceIdstring

VPC 资源 ID。

vpc-bp175iuvg8nxqraf2****
ScaleOutStatusobject

数据搬迁状态。

Progressstring

数据搬迁百分比。

说明 仅集群状态为 SCALING_OUT 时,返回该参数。
0
Ratiostring

数据搬迁的进度,格式:已搬迁数据量/数据总量。

说明 仅集群状态为 SCALING_OUT 时,返回该参数。
0MB/60469MB
DBClusterIdstring

集群 ID。

cc-bp108z124a8o7****
ConnectionStringstring

VPC 连接地址。

cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com
CommodityCodestring

售卖商品 Code。

clickhouse_go_public_cn
ExpireTimestring

集群的到期时间,格式:yyyy-MM-ddTHH:mm:ssZ。

说明 按量付费集群无到期时间,返回值为空。
2011-05-30T12:11:4Z
DBNodeStoragelong

单节点存储空间,取值范围:100 GB~32000 GB。

说明 步长为 100 GB。
100
DBNodeClassstring

集群规格。

  • 单副本版,取值: - 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
AliUidstring

阿里云账号 ID。

140692647406****
LockReasonstring

锁定原因。

说明 锁定模式为 Unlock 时,返回值为空。
DISK_FULL
RegionIdstring

地域 ID。

cn-hangzhou
VSwitchIdstring

交换机 ID。

vsw-bp1gzt31twhlo0sa5****
DBClusterStatusstring

集群状态,取值说明:

  • Preparing:准备中。
  • Creating:创建中。
  • Running:运行中。
  • Deleting:删除中。
  • SCALING_OUT:扩容中。
Running
DBClusterDescriptionstring

集群描述。

test
DBClusterNetworkTypestring

网络类型,目前只支持 VPC。

VPC
ZoneIdstring

可用区 ID。

cn-hangzhou-h
Categorystring

副本配置,取值说明:

  • Basic:单副本版。
  • HighAvailability:双副本版。
Basic
ControlVersionstring

后台管控系统版本号,取值说明:

  • v1

  • v2

v1
ExtStorageTypestring

扩展存储类型,取值说明:

  • CloudSSD:SSD 云盘。
  • CloudESSD:ESSD PL1 云盘。
  • CloudESSD_PL2:ESSD PL2 云盘。
  • CloudESSD_PL3:ESSD PL3 云盘。
  • CloudEfficiency:高效云盘。
CloudESSD
ExtStorageSizeinteger

扩展存储空间。

100GB
ResourceGroupIdstring

集群所属的资源组 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"
        },
        "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****"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-11-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
    删除错误码:503
    新增错误码:403
2023-03-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
2021-09-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:ControlVersion