Queries the information about AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.
Operation description
For information about the endpoints of AnalyticDB for MySQL, see Endpoints .
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:
- For mandatory resource types, indicate with a prefix of * .
- 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 | list | *DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the cluster. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
| DBClusterIds | string | No | The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. If you do not specify this parameter, the information about all clusters that reside in the region is returned. | amv-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 resource group ID. If you do not specify this parameter, the information about all resource groups in the cluster is returned. | rg-4690g37929**** |
| 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 tag key. | tag1 |
| Value | string | No | The tag value. | test1 |
| ProductVersion | string | No | The edition of the cluster. Valid values:
If you leave this parameter empty, the information about clusters of all editions is returned. | BasicVersion |
| DBClusterVersion | string | No | The database engine version of the cluster. Valid values:
| 5.0 |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 1,
"PageSize": 30,
"RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
"PageNumber": 1,
"Items": {
"DBCluster": [
{
"Expired": "false",
"CreateTime": "2022-04-01T09:50:18Z",
"PayType": "Prepaid",
"Mode": "flexible",
"Port": "3306",
"LockMode": "Unlock",
"StorageResource": "24ACU",
"DBClusterId": "amv-bp163885f8q21****",
"ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
"DBClusterType": "Common",
"CommodityCode": "ads_pre",
"ExpireTime": "2022-07-01T09:50:18Z",
"LockReason": "instance_expire",
"VPCId": "vpc-bp13h7uzhulpuxvnp****",
"RegionId": "cn-hangzhou",
"ComputeResource": "16ACU",
"VSwitchId": "vsw-bp1syh8vvw8yech7n****",
"DBVersion": "5.0",
"DBClusterStatus": "Running",
"ResourceGroupId": "rg-acfmyiu4ekp****",
"DBClusterNetworkType": "VPC",
"DBClusterDescription": "adb_test",
"ZoneId": "cn-hangzhou-h",
"Engine": "AnalyticDB",
"ReservedACU": "32ACU",
"Tags": {
"Tag": [
{
"Key": "tag1",
"Value": "test1"
}
]
},
"Category": "MIXED_STORAGE",
"InnerPort": "3306",
"VPCCloudInstanceId": "am-bp163885f8q21****-controller",
"InnerIp": "10.1.xx.xx",
"DtsJobId": "dtsb1578j90XXXX",
"ElasticIOResource": 2,
"RdsInstanceId": "rm-bp11q28kvl688****",
"ExecutorCount": "1",
"DBNodeClass": "E8",
"DiskType": "cloud_essd",
"DBNodeStorage": 300,
"DBNodeCount": 2,
"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"
}
]
}
},
"ProductForm": "IntegrationForm",
"ProductVersion": "EnterpriseVersion",
"ReservedNodeSize": "8ACU",
"ReservedNodeCount": 1
}
]
}
}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-05-09 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-07-27 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |