查询云数据库ClickHouse指定地域的集群信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| clickhouse:DescribeDBClusters | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。 | cn-hangzhou |
| DBClusterIds | string | 否 | 集群 ID。
不配置该参数时，默认查询所有集群的信息。
| cc-bp108z124a8o7**** |
| DBClusterDescription | string | 否 | 集群描述。 | cc-bp108z124a8o7**** |
| DBClusterStatus | string | 否 | 集群状态，取值说明：
| Running |
| PageSize | integer | 否 | 每页记录数，取值：
| 30 |
| PageNumber | integer | 否 | 页数。 | 1 |
| Tag | array<object> | 否 | 标签。 | |
| object | 否 | 标签。 | ||
| Key | string | 否 | 标签名称。 | department |
| Value | string | 否 | 标签的值。 | it |
| ResourceGroupId | string | 否 | 集群所属的资源组 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"
},
"ScaleOutDisableWriteWindows": "2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00",
"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****",
"DbVersion": "23.8"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Forbidden | User not authorized to operate on the specified resource. | 账户未被授予操作资源的权限 |
| 500 | InternalError | An error occurred while processing your request. | 系统内部错误，请稍后重试 |
| 503 | ServiceUnavailable | An error occurred while processing your request. | 系统暂时不可用，请稍后重试 |
访问错误中心查看更多错误码。
