调用DescribeDBInstances接口查询集群列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
clickhouse:DescribeDBInstances |
get |
*EnterpriseDBCluster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
| DBInstanceIds |
string |
否 |
集群 ID 列表，多个集群 ID 之间用英文半角逗号（,）分隔。 |
cc-xxxxx,cx-xxxx |
| DBInstanceStatus |
string |
否 |
集群状态。 |
active |
| Description |
string |
否 |
集群描述。 |
test |
| PageSize |
integer |
否 |
每页记录数。 |
30 |
| PageNumber |
integer |
否 |
页码。 |
1 |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-4690g37929**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数详情。 |
||
| Data |
object |
返回结果。 |
|
| TotalCount |
string |
总记录数 |
1 |
| PageSize |
integer |
每页记录数。 |
30 |
| PageNumber |
integer |
页码。 |
1 |
| DBInstances |
array<object> |
实例详情列表。 |
|
|
object |
实例详情。 |
||
| DBInstanceId |
string |
集群 ID。 |
cc-xxxxxxx |
| Description |
string |
参数描述。 |
test_desc |
| Engine |
string |
引擎类型。 |
clickhouse |
| EngineVersion |
string |
引擎版本。 |
22.8 |
| AliUid |
string |
用户 ID。 |
1294**** |
| Bid |
string |
渠道 ID。 |
186681**** |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| ZoneId |
string |
可用区 ID |
cn-hangzhou-i |
| ChargeType |
string |
付费方式。 取值：
|
PostPaid |
| Status |
string |
实例状态。 |
active |
| VpcId |
string |
VPC ID。 |
vpc-uf6kg**** |
| VSwitchId |
string |
交换机 ID。 |
vsw-8vb5mw**** |
| ScaleMin |
integer |
serverless 弹性伸缩最小值。 |
1 |
| ScaleMax |
integer |
serverless 弹性伸缩最大值。 |
13 |
| ExpireTime |
string |
到期时间。 |
2024-02-16 11:51:06 |
| LockMode |
string |
锁定模式。 |
0 |
| LockReason |
string |
锁定原因。 |
null |
| MaintainStartTime |
string |
可维护时间开始时间。 |
00:00Z |
| MaintainEndTime |
string |
可维护时间结束时间。 |
04:00:00Z |
| DeletionProtection |
string |
是否已开启释放保护功能。 |
False |
| ResourceGroupId |
string |
资源组 ID。 |
rg-acfmzy**** |
| CreateTime |
string |
创建时间。 |
2022-12-04 21:16:15 |
| Tags |
array<object> |
标签组。 |
|
|
object |
标签。 |
||
| Key |
string |
标签键。 |
tag |
| Value |
string |
标签值。 |
test |
| StorageType |
string |
oss |
|
| RequestId |
string |
请求 ID。 |
xxx-xxx-xxx |
示例
正常返回示例
JSON格式
{
"Data": {
"TotalCount": "1",
"PageSize": 30,
"PageNumber": 1,
"DBInstances": [
{
"DBInstanceId": "cc-xxxxxxx",
"Description": "test_desc",
"Engine": "clickhouse",
"EngineVersion": "22.8",
"AliUid": "1294****",
"Bid": "186681****",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-i",
"ChargeType": "PostPaid",
"Status": "active",
"VpcId": "vpc-uf6kg****",
"VSwitchId": "vsw-8vb5mw****",
"ScaleMin": 1,
"ScaleMax": 13,
"ExpireTime": "2024-02-16 11:51:06",
"LockMode": "0",
"LockReason": "null",
"MaintainStartTime": "00:00Z",
"MaintainEndTime": "04:00:00Z",
"DeletionProtection": "False",
"ResourceGroupId": "rg-acfmzy****",
"CreateTime": "2022-12-04 21:16:15",
"Tags": [
{
"Key": "tag",
"Value": "test"
}
],
"StorageType": "oss"
}
]
},
"RequestId": "xxx-xxx-xxx"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。