Queries a list of AnalyticDB for MySQL clusters within 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 |
|---|---|---|---|---|
| adb:DescribeDBClusters | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the clusters. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
| DBClusterIds | string | No | The cluster IDs. Note
You can specify the ID of one cluster or IDs of more clusters within the preceding region.
| am-bp1r053byu48p**** |
| DBClusterDescription | string | No | The description of the cluster.
| test |
| DBClusterStatus | string | No | The state of the cluster. Valid values:
| Running |
| PageSize | integer | No | The number of entries per page. Valid values:
| 30 |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| ResourceGroupId | string | No | The ID of the resource group. | rg-4690g37929XXXX |
| Tag | array<object> | No | The tags that are added to the cluster. | |
| object | No | The tag that is added to the cluster. | ||
| Key | string | No | The key of tag N that is added to the cluster. You can use tags to filter clusters. A tag is a key-value pair. You can specify up to 20 tags in one request. The letter N specifies the sequence number of each key-value pair and must be unique. The values of N must be consecutive integers that start from 1. Each value of Note
The tag key can be up to 64 characters in length and cannot start with aliyun, acs:, http://, or https://.
| tag1 |
| Value | string | No | The value of tag N that is added to the cluster. You can use tags to filter clusters. A tag is a key-value pair. You can specify up to 20 tags in one request. The letter N specifies the sequence number of each key-value pair and must be unique. The values of N must be consecutive integers that start from 1. Each value of Note
The tag key can be up to 64 characters in length and cannot start with aliyun, acs:, http://, or https://.
| test1 |
| DBVersion | string | No | The version of the cluster. Set the value to 3.0. | 3.0 |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 1,
"PageSize": 30,
"RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
"PageNumber": 1,
"Items": {
"DBCluster": [
{
"DtsJobId": "dtsb1578j90XXXX",
"DBNodeCount": 1,
"Expired": "false",
"CreateTime": "2021-04-01T09:50:18Z",
"PayType": "Postpaid",
"DiskType": "cloud_essd",
"Tags": {
"Tag": [
{
"Key": "tag1",
"Value": "test1"
}
]
},
"Mode": "flexible",
"Port": "3306",
"LockMode": "Unlock",
"StorageResource": "8Core32GB",
"ExecutorCount": "1",
"DBClusterId": "am-bp163885f8q21****",
"ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
"RdsInstanceId": "rm-bp11q28kvl688****",
"DBClusterType": "Common",
"CommodityCode": "ads",
"ExpireTime": "2999-09-08T16:00:00Z",
"DBNodeStorage": 300,
"DBNodeClass": "E8",
"LockReason": "instance_expired",
"VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
"RegionId": "cn-hangzhou",
"ComputeResource": "8Core32GB",
"ElasticIOResource": 0,
"VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
"DBVersion": "3.0",
"VPCCloudInstanceId": "am-bp163885f8q21****-controller",
"DBClusterStatus": "Running",
"ResourceGroupId": "rg-acfmyiu4ekp****",
"DBClusterNetworkType": "vpc",
"DBClusterDescription": "adb_test",
"ZoneId": "cn-hangzhou-h",
"Category": "MIXED_STORAGE",
"Engine": "AnalyticDB",
"InnerIp": "10.1.xx.xx",
"InnerPort": "3306",
"TaskInfo": {
"Name": "analyticDBFlexibleScaleOut",
"Status": "RUNNING",
"Progress": "10",
"StepList": {
"StepList": [
{
"StepName": "ApplyResource",
"StepDesc": "Apply resource",
"StepStatus": "SUCCEED",
"StepProgress": "50",
"StartTime": "2024-03-10T09:28:34Z",
"EndTime": "2024-03-10T10:28:34Z"
}
]
}
},
"ProductVersion": "EnterpriseVersion"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. | An internal error occurred. Please try again later. |
| 503 | ServiceUnavailable | An error occurred while processing your request. | The system is unavailable. Please try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-28 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-04-01 | The Error code has changed. The response structure of the API has changed | View Change Details |