调用ListClusters接口查看指定地域的云数据库ClickHouse云原生版集群信息

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListClusters	系统规定参数。取值：ListClusters。
DBClusterId	String	否	cc-bp108z124a8o7****	集群ID。
DBClusterStatus	String	否	Running	集群的状态，取值说明： OrderPreparing：订单确认中。 Creating：创建中。 Running：运行中。 ResourceChanging：资源变配中。 ResourceChangingInReadonly：资源变配中（实例写入锁定）。 Deleting：删除中。
DBClusterDescription	String	否	test	集群描述。
PageNumber	Integer	否	1	页数。
PageSize	Integer	否	30	每页记录数，取值： 30（默认值） 50 100
RegionId	String	是	cn-hangzhou	地域ID。您可以通过调用DescribeRegions接口查询地域ID。

返回数据


名称	类型	示例值	描述
TotalCount	Integer	1	总记录数。
PageNumber	Integer	1	页数。
PageSize	Integer	30	每页记录数，取值： 30（默认值） 50 100
Data	Array of Data		集群列表。
DBClusterId	String	cc-bp108z124a8o7****	集群ID。
DBClusterDescription	String	test	集群描述。
EngineVersion	String	21.8	集群的内核版本号，固定为21.8。
AliUid	Long	140692647406****	阿里云账号ID。
RegionId	String	cn-hangzhou	地域ID。
VpcId	String	vpc-2zedznmtm8j7fksbc****	VPC ID。
ZoneId	String	cn-hangzhou-h	可用区ID。
VswitchId	String	vsw-bp1tg609m5j85jejq****	交换机ID。
PayType	String	Postpaid	付费类型，取值说明： Postpaid：按量付费。 Prepaid：预付费（包年包月）。
CommodityCode	String	clickhouse_go_public_cn	售卖商品Code。
CreateTime	String	2022-03-18T08:14:48Z	集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。
ExpireTime	String	2022-04-17T08:14:48Z	集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。说明按量付费集群无到期时间，返回值为空。
LockMode	String	Unlock	集群的锁定模式，取值说明： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。 LockByRestoration：集群回滚前的自动锁定。 LockByDiskQuota：集群空间满自动锁定。
LockReason	String	DISK_FULL	锁定原因。说明锁定模式为Unlock时，返回值为空。
DBClusterStatus	String	Running	集群的状态，取值说明： OrderPreparing：订单确认中。 Creating：创建中。 Running：运行中。 ResourceChanging：资源变配中。 ResourceChangingInReadonly：资源变配中（实例写入锁定）。 Deleting：删除中。
ResourceCpuCores	Integer	8	集群的CPU规格，单位：核。
ResourceMemoryGiB	Integer	32	集群的内存规格，单位：GB。
CacheStorageType	String	CloudESSD	集群的缓存类型。
CacheStorageSizeGiB	Integer	200	集群的缓存空间，单位：GB。
ObjectStoreSizeGiB	Long	0	集群的存储用量，单位：GB。
VirtualWareHouses	Array of VirtualWareHouse		计算组列表。
VirtualWareHouseId	String	vw-uf6a499c0m3w5****	计算组ID。
VirtualWareHouseDescription	String	test	计算组描述。
VirtualWareHouseStatus	String	Running	计算组的状态，取值说明： Creating：创建中。 Running：运行中。 CreatingPublicSLB：创建公网链接中。 DeletingPublicSLB：释放公网链接中。 ResourceChanging：资源变配中。 ResourceChangingInReadonly：资源变配中（计算组写入锁定）。 Deleting：删除中。
ZoneId	String	cn-hangzhou-h	可用区ID。
VswitchId	String	vsw-bp1tg609m5j85jejq****	交换机ID。
VirtualWareHouseClass	String	n1.xlarge	计算组的规格码。
VirtualWareHouseCacheStorage	Integer	200	计算组的缓存空间，单位：GB。
Ports	String	tcp:9000,http:8123,mysql:9004	计算组的端口号。
RequestId	String	DDB109DC-E37D-5475-8D49-47542C57BD38	请求ID。

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=ListClusters
&DBClusterId=cc-bp108z124a8o7****
&DBClusterStatus=Running
&DBClusterDescription=test
&PageNumber=1
&PageSize=30
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

<ListClustersResponse>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>30</PageSize>
    <Data>
        <DBClusterId>cc-bp108z124a8o7****</DBClusterId>
        <DBClusterDescription>test</DBClusterDescription>
        <EngineVersion>21.8</EngineVersion>
        <RegionId>cn-hangzhou</RegionId>
        <VpcId>vpc-2zedznmtm8j7fksbc****</VpcId>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <VswitchId>vsw-bp1tg609m5j85jejq****</VswitchId>
        <PayType>Postpaid</PayType>
        <CommodityCode>clickhouse_go_public_cn</CommodityCode>
        <CreateTime>2022-03-18T08:14:48Z</CreateTime>
        <ExpireTime>2022-04-17T08:14:48Z</ExpireTime>
        <LockMode>Unlock</LockMode>
        <LockReason>DISK_FULL</LockReason>
        <DBClusterStatus>Running</DBClusterStatus>
        <ResourceCpuCores>8</ResourceCpuCores>
        <ResourceMemoryGiB>32</ResourceMemoryGiB>
        <CacheStorageType>CloudESSD</CacheStorageType>
        <CacheStorageSizeGiB>200</CacheStorageSizeGiB>
        <ObjectStoreSizeGiB>0</ObjectStoreSizeGiB>
        <VirtualWareHouses>
            <VirtualWareHouseId>vw-uf6a499c0m3w5****</VirtualWareHouseId>
            <VirtualWareHouseDescription>test</VirtualWareHouseDescription>
            <VirtualWareHouseStatus>Running</VirtualWareHouseStatus>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <VswitchId>vsw-bp1tg609m5j85jejq****</VswitchId>
            <VirtualWareHouseClass>n1.xlarge</VirtualWareHouseClass>
            <VirtualWareHouseCacheStorage>200</VirtualWareHouseCacheStorage>
            <Ports>tcp:9000,http:8123,mysql:9004</Ports>
        </VirtualWareHouses>
    </Data>
    <RequestId>DDB109DC-E37D-5475-8D49-47542C57BD38</RequestId>
</ListClustersResponse>

JSON格式

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

{
  "TotalCount" : 1,
  "PageNumber" : 1,
  "PageSize" : 30,
  "Data" : {
    "DBClusterId" : "cc-bp108z124a8o7****",
    "DBClusterDescription" : "test",
    "EngineVersion" : 21.8,
    "RegionId" : "cn-hangzhou",
    "VpcId" : "vpc-2zedznmtm8j7fksbc****",
    "ZoneId" : "cn-hangzhou-h",
    "VswitchId" : "vsw-bp1tg609m5j85jejq****",
    "PayType" : "Postpaid",
    "CommodityCode" : "clickhouse_go_public_cn",
    "CreateTime" : "2022-03-18T08:14:48Z",
    "ExpireTime" : "2022-04-17T08:14:48Z",
    "LockMode" : "Unlock",
    "LockReason" : "DISK_FULL",
    "DBClusterStatus" : "Running",
    "ResourceCpuCores" : 8,
    "ResourceMemoryGiB" : 32,
    "CacheStorageType" : "CloudESSD",
    "CacheStorageSizeGiB" : 200,
    "ObjectStoreSizeGiB" : 0,
    "VirtualWareHouses" : {
      "VirtualWareHouseId" : "vw-uf6a499c0m3w5****",
      "VirtualWareHouseDescription" : "test",
      "VirtualWareHouseStatus" : "Running",
      "ZoneId" : "cn-hangzhou-h",
      "VswitchId" : "vsw-bp1tg609m5j85jejq****",
      "VirtualWareHouseClass" : "n1.xlarge",
      "VirtualWareHouseCacheStorage" : 200,
      "Ports" : "tcp:9000,http:8123,mysql:9004"
    }
  },
  "RequestId" : "DDB109DC-E37D-5475-8D49-47542C57BD38"
}

错误码

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