调用DescribeDBInstances接口查询集群列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| clickhouse:DescribeDBInstances | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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**** |
返回参数
示例
正常返回示例
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"
}
]
}
]
},
"RequestId": "xxx-xxx-xxx"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-02-06 | API 内部配置变更，不影响调用 | 查看变更详情 |