Queries the information about ApsaraDB for ClickHouse clusters in a region.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| clickhouse:DescribeDBClusters | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| DBClusterIds | string | No | The cluster ID. Note
If you do not specify this parameter, the information about all clusters is queried.
| cc-bp108z124a8o7**** |
| DBClusterDescription | string | No | The description of the cluster. | cc-bp108z124a8o7**** |
| DBClusterStatus | string | No | The state of the cluster. Valid values:
| Running |
| PageSize | integer | No | The number of entries returned per page. Valid values:
| 30 |
| PageNumber | integer | No | The page number. | 1 |
| Tag | array<object> | No | The tags. | |
| object | No | |||
| Key | string | No | The tag name. | department |
| Value | string | No | The tag value. | it |
| ResourceGroupId | string | No | The ID of the resource group to which the cluster belongs. | rg-4690g37929**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": ""
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | Forbidden | User not authorized to operate on the specified resource. | The account is not granted permission to manipulate the resource |
| 500 | InternalError | An error occurred while processing your request. | An error occurred while processing your request. |
| 503 | ServiceUnavailable | An error occurred while processing your request. | An error occurred while processing your request. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-03 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-06-24 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-11-06 | The Error code has changed | View Change Details |
| 2023-03-20 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2021-09-07 | The Error code has changed. The request parameters of the API has changed | View Change Details |