查詢云數據庫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": "",
"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": ""
}
]
}
}錯誤碼
| 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. | 系統暫時不可用，請稍后重試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-03 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-06-24 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-11-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-03-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-09-07 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |