You can call this operation to query AnalyticDB for MySQL clusters.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDBClusters |
The operation that you want to perform. Set the value to DescribeDBClusters. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the cluster. You can call the DescribeRegions operation to query the most recent region list. |
DBClusterIds | String | No | am-bp1xxxxxxxx47 |
The ID of the cluster. Specify multiple cluster IDs with commas (,). |
DBClusterDescription | String | No | Test the database |
The description of the cluster. Fuzzy match is supported. |
DBClusterStatus | String | No | Running |
The status of the cluster. Example: Creating and Locking. For more information, see Cluster status. |
PageSize | Integer | No | 30 |
The number of records to return on each page. Valid values:
Default value: 30. |
PageNumber | Integer | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
Tag.N.Key | String | No | test |
The key of tag N that you can use 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. The value of the Tag.N.Key parameter is the value of the Tag.n.Vlaue parameter. Note The key can be up to 64 characters in length, and cannot start with
aliyun , acs: , http:// , or https:// .
|
Tag.N.Value | String | No | api |
The value of tag N that you can use 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. The value of the Tag.N.Value parameter is the value of the Tag.N.Key parameter. Note If you specify the Tag.N.Key parameter, you must also specify the Tag.N.Value parameter.
The value can be up to 64 characters in length, and cannot start with |
ResourceGroupId | String | No | rg-rexxxxxxxxxx |
The ID of the resource group. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Items | Array of DBCluster |
The list of clusters. |
|
DBCluster | |||
Category | String | Basic |
The ApsaraDB RDS edition of the cluster. Valid values:
|
CommodityCode | String | AnalyticDB for MySQL |
N/A |
ComputeResource | String | 24Core192GB | The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. |
ConnectionString | String | am-bpxxxxxxxx.ads.aliyuncs.com |
The endpoint of the cluster. |
CreateTime | String | 2019-03-20T02:18:02Z |
The time when the cluster was created. |
DBClusterDescription | String | testdatabase |
The description of the cluster. |
DBClusterId | String | am-bpxxxxxxxx47 |
The ID of the cluster. |
DBClusterNetworkType | String | VPC |
The network type of the endpoint. Valid values: VPC |
DBClusterStatus | String | Running |
The status of the instances. For more information, see Instance state table. |
DBClusterType | String | Common |
The type of the PolarDB-X instance. Valid values:
|
DBNodeClass | String | C8 |
The specification of the node. |
DBNodeCount | Long | 128 |
The number of node groups. |
DBNodeStorage | Long | 100 |
The storage space of each node in the cluster. |
DBVersion | String | 3.0 |
The version of the cluster. Valid value: 3.0. |
DiskType | String | cloud |
The type of the disk. Valid values:
|
DtsJobId | String | dtsb1xxxxxxxxxx |
The ID of the data synchronization task in Data Transmission Service (DTS). This parameter is valid only for analytic instances. |
ElasticIOResource | Integer | 0 |
An elastic I/O resource. This parameter only in elastic mode has a value. |
Engine | String | AnalyticDB |
The engine of the database. Valid value: AnalyticDB. |
ExecutorCount | String | 3 |
N/A |
ExpireTime | String | 2020-03-20T02:18:02Z |
The time when the cluster expires. Note Pay-as-you-go clusters do not expire.
|
Expired | String | false |
Indicates whether the cluster has expired. Valid values:
|
LockMode | String | unlock |
The lock mode of the cluster. Valid values:
|
LockReason | String | instance_expired |
The reason why the cluster is locked. |
Mode | String | flexible |
The mode of the cluster. Valid values:
|
PayType | String | Postpaid |
The billing method of the cluster. Valid values:
|
Port | String | 3306 |
The port that is used to access the cluster. |
RdsInstanceId | String | rm-bp1oxxxxxxxxxx |
The ID of the ApsaraDB RDS instance from which data is synchronized to the cluster. This parameter is valid only for analytic instances. |
RegionId | String | cn-hangzhou |
The region ID of the cluster. |
ResourceGroupId | String | rg-rexxxxxxxxxx |
The ID of the resource group. |
StorageResource | String | 24Core192GB |
The specifications of storage resources in elastic mode. The resources are used for data read and write operations. The increase of resources can improve the read and write performance of your cluster. |
Tags | Array of Tag |
The list of tags. |
|
Tag | |||
Key | String | test |
The tag key. |
Value | String | api |
The tag value. |
VPCCloudInstanceId | String | vpc-23rsxdfxxxxxxx |
The ID that is assigned by the VPC to the cluster. |
VPCId | String | vpc-xxxxxxxxx |
The ID of the VPC to which created instances belong. |
VSwitchId | String | vsw-xxxxxx |
The ID of the vSwitch to which the instance is connected. |
ZoneId | String | cn-hangzhou-a |
The ID of the zone to which the read-only instance belongs. |
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 2 |
The number of entries returned per page. |
TotalCount | Integer | 100 |
The total number of returned entries. |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
<TotalCount>100</TotalCount>
<PageSize>2</PageSize>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageNumber>1</PageNumber>
<Items>
<DBCluster>
<StorageResource>24Core192GB</StorageResource>
<Category>Basic</Category>
<ResourceGroupId>rg-rexxxxxxxxxx</ResourceGroupId>
<Port>3306</Port>
<DBClusterId>am-bpxxxxxxxx47</DBClusterId>
<DBClusterNetworkType>VPC</DBClusterNetworkType>
<DBClusterType>Common</DBClusterType>
<ElasticIOResource>0</ElasticIOResource>
<DiskType>cloud</DiskType>
<DBVersion>3.0</DBVersion>
<DtsJobId>dtsb1xxxxxxxxxx</DtsJobId>
<CommodityCode>AnalyticDB for MySQL</CommodityCode>
<DBNodeCount>128</DBNodeCount>
<ExecutorCount>3</ExecutorCount>
<LockReason>instance_expired</LockReason>
<Engine>AnalyticDB</Engine>
<DBNodeStorage>100</DBNodeStorage>
<ZoneId>cn-hangzhou-a</ZoneId>
<VPCId>vpc-xxxxxxxxx</VPCId>
<DBClusterStatus>Running</DBClusterStatus>
<Mode>flexible</Mode>
<VSwitchId>vsw-xxxxxx</VSwitchId>
<CreateTime>2019-03-20T02:18:02Z</CreateTime>
<DBClusterDescription>testdatabase</DBClusterDescription>
<ComputeResource>24Core192GB</ComputeResource>
<Expired>false</Expired>
<LockMode>unlock</LockMode>
<PayType>Postpaid</PayType>
<DBNodeClass>C8</DBNodeClass>
<VPCCloudInstanceId>vpc-23rsxdfxxxxxxx</VPCCloudInstanceId>
<RegionId>cn-hangzhou</RegionId>
<ConnectionString>am-bpxxxxxxxx.ads.aliyuncs.com</ConnectionString>
<ExpireTime>2020-03-20T02:18:02Z</ExpireTime>
<RdsInstanceId>rm-bp1oxxxxxxxxxx</RdsInstanceId>
</DBCluster>
<DBCluster>
<Tags>
<Tag>
<Value>api</Value>
<Key>test</Key>
</Tag>
</Tags>
</DBCluster>
</Items>
JSON
format
{
"TotalCount": 100,
"PageSize": 2,
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": 1,
"Items": {
"DBCluster": [
{
"StorageResource": "24Core192GB",
"Category": "Basic",
"ResourceGroupId": "rg-rexxxxxxxxxx",
"Port": 3306,
"DBClusterId": "am-bpxxxxxxxx47",
"DBClusterNetworkType": "VPC",
"DBClusterType": "Common",
"ElasticIOResource": 0,
"DiskType": "cloud",
"DBVersion": 3,
"DtsJobId": "dtsb1xxxxxxxxxx",
"CommodityCode": "AnalyticDB for MySQL",
"DBNodeCount": 128,
"ExecutorCount": 3,
"LockReason": "instance_expired",
"Engine": "AnalyticDB",
"DBNodeStorage": 100,
"ZoneId": "cn-hangzhou-a",
"VPCId": "vpc-xxxxxxxxx",
"DBClusterStatus": "Running",
"Mode": "flexible",
"VSwitchId": "vsw-xxxxxx",
"CreateTime": "2019-03-20T02:18:02Z",
"DBClusterDescription": "testdatabase",
"ComputeResource": "24Core192GB",
"Expired": false,
"LockMode": "unlock",
"PayType": "Postpaid",
"DBNodeClass": "C8",
"VPCCloudInstanceId": "vpc-23rsxdfxxxxxxx",
"RegionId": "cn-hangzhou",
"ConnectionString": "am-bpxxxxxxxx.ads.aliyuncs.com",
"ExpireTime": "2020-03-20T02:18:02Z",
"RdsInstanceId": "rm-bp1oxxxxxxxxxx"
},
{
"Tags": {
"Tag": {
"Value": "api",
"Key": "test"
}
}
}
]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
500 | InternalError | An error occurred while processing your request. | The error message returned because an internal error has occurred. Try again later. |
503 | ServiceUnavailable | An error occurred while processing your request. | The error message returned because the service is unavailable. Try again later. |
For a list of error codes, visit the API Error Center.