调用DescribeDBClusters接口查询云数据库ClickHouse指定地域的集群信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBClusters | 系统规定参数。取值:DescribeDBClusters。 |
RegionId | String | 是 | cn-hangzhou | 地域ID。您可以通过调用DescribeRegions接口查询地域ID。 |
DBClusterIds | String | 否 | cc-bp108z124a8o7**** | 集群ID。 说明 不配置该参数时,默认查询所有集群的信息。 |
DBClusterDescription | String | 否 | cc-bp108z124a8o7**** | 集群描述。 |
DBClusterStatus | String | 否 | Running | 集群状态,取值说明:
|
PageSize | Integer | 否 | 30 | 每页记录数,取值:
|
PageNumber | Integer | 否 | 1 | 页数。 |
Tag.N.Key | String | 否 | department | 标签名称。 |
Tag.N.Value | String | 否 | it | 标签的值。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 1 | 总记录数。 |
PageSize | Integer | 30 | 每页记录数,取值:
|
RequestId | String | F5178C10-1407-4987-9133-DE4DC9119F75 | 请求ID。 |
PageNumber | Integer | 1 | 页数。 |
DBClusters | Array of DBCluster | 集群列表。 |
|
DBCluster | |||
VpcId | String | vpc-bp175iuvg8nxqraf2**** | VPC ID。 |
DBNodeCount | Long | 2 | 节点数量。
|
CreateTime | String | 2021-10-28T07:24:45Z | 集群的创建时间,格式:yyyy-MM-ddTHH:mm:ssZ。 |
PayType | String | Postpaid | 付费类型,取值说明:
|
Tags | Array of Tag | 标签列表。 |
|
Tag | |||
Key | String | department | 标签名称。 |
Value | String | it | 标签的值。 |
StorageType | String | CloudESSD | 存储类型,取值说明:
|
Port | Integer | 8123 | HTTP端口号。 |
LockMode | String | Unlock | 集群的锁定模式,取值说明:
|
Bid | String | 26842 | 站点ID,取值说明:
|
IsExpired | String | false | 集群是否过期,取值说明:
|
VpcCloudInstanceId | String | vpc-bp175iuvg8nxqraf2**** | VPC资源ID。 |
ScaleOutStatus | Object | 数据搬迁状态。 |
|
Progress | String | 0 | 数据搬迁百分比。 说明 仅集群状态为SCALING_OUT时,返回该参数。 |
Ratio | String | 0MB/60469MB | 数据搬迁的进度,格式:已搬迁数据量/数据总量。 说明 仅集群状态为SCALING_OUT时,返回该参数。 |
DBClusterId | String | cc-bp108z124a8o7**** | 集群ID。 |
ConnectionString | String | cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com | VPC连接地址。 |
CommodityCode | String | clickhouse_go_public_cn | 售卖商品Code。 |
ExpireTime | String | 2011-05-30T12:11:4Z | 集群的到期时间,格式:yyyy-MM-ddTHH:mm:ssZ。 说明 按量付费集群无到期时间,返回值为空。 |
DBNodeStorage | Long | 100 | 单节点存储空间,取值范围:100 GB~32000 GB。 说明 步长为100 GB。 |
DBNodeClass | String | C8 | 集群规格。
|
AliUid | String | 140692647406**** | 阿里云账号ID。 |
LockReason | String | DISK_FULL | 锁定原因。 说明 锁定模式为Unlock时,返回值为空。 |
RegionId | String | cn-hangzhou | 地域ID。 |
VSwitchId | String | vsw-bp1gzt31twhlo0sa5**** | 交换机ID。 |
DBClusterStatus | String | Running | 集群状态,取值说明:
|
DBClusterDescription | String | test | 集群描述。 |
DBClusterNetworkType | String | VPC | 网络类型,目前只支持VPC。 |
ZoneId | String | cn-hangzhou-h | 可用区ID。 |
Category | String | Basic | 副本配置,取值说明:
|
ControlVersion | String | v1 | 后台管控系统版本号,取值说明:
|
示例
请求示例
http(s)://clickhouse.aliyuncs.com/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&公共请求参数
正常返回示例
XML
格式
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
格式
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"
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An error occurred while processing your request. | 系统内部错误,请稍后重试 |
503 | ServiceUnavailable | An error occurred while processing your request. | 系统暂时不可用,请稍后重试 |
访问错误中心查看更多错误码。