Queries the details of an AnalyticDB for MySQL cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeDBClusterAttribute |
The operation that you want to perform. Set the value to DescribeDBClusterAttribute. |
DBClusterId | String | Yes | rm-uf6wjk5xxxxxxxxxx |
The ID of the cluster. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Items | Array of DBCluster |
A list of clusters. |
|
DBCluster | |||
Category | String | Basic |
The edition of the cluster. |
CommodityCode | String | AnalyticDB for MySQL |
The name of the service. |
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. For more information, see Specifications. |
ConnectionString | String | am-xxxxxxxxxx.ads.aliyuncs.com |
The endpoint of the cluster. |
CreationTime | String | 2011-05-30T12:11:04Z |
The time when the cluster was created. The time follows the ISO 8601 standard in the
|
DBClusterDescription | String | Test database |
The description of the cluster. |
DBClusterId | String | rm-uf6wjk5xxxxxxxxxx |
The ID of the cluster. |
DBClusterNetworkType | String | vpc |
The type of the network. Default value: vpc. |
DBClusterStatus | String | Running |
The status of the cluster. For more information, see Cluster status. |
DBClusterType | String | Primary |
The type of the cluster. The value Common indicates a primary cluster. |
DBNodeClass | String | C8 |
The type of the node. For example, C8. |
DBNodeCount | Long | 8 |
The number of node groups. |
DBNodeStorage | Long | 100 |
The storage space of the node. Unit: GiB. |
DBVersion | String | 3.0 |
The version of the cluster. Only version 3.0 is available. |
DiskType | String | cloud |
The type of disks. Valid values:
|
DtsJobId | String | dtsb1xxxxxxxxxx |
The ID of the data synchronization task in DTS. This parameter is valid for analytic instances only. |
Engine | String | AnalyticDB |
The engine of the database. The value AnalyticDB is returned. |
ExecutorCount | String | 3 |
The number of nodes. The node resources are used for data computing in elastic mode. |
ExpireTime | String | 2019-03-27T16:00:00Z |
The time when the cluster expires. The time follows the ISO 8601 standard in the Note If the billing method of a cluster is pay-as-you-go, the cluster never expires.
|
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 |
Indicates the reason why the cluster is locked. |
MaintainTime | String | 00:00Z-02:00Z |
The time when the cluster can be maintained. The time follows the ISO 8601 standard
in the |
Mode | String | flexible |
The mode of the cluster. Valid values:
|
PayType | String | Postpaid |
The billing method of the cluster. Valid values:
|
Port | Integer | 3306 |
The port that is used to access the cluster. |
RdsInstanceId | String | rm-bp1oxxxxxxxxxx |
The ID of the RDS instance from which data is synchronized to the cluster. This parameter is valid for analytic instances only. |
RegionId | String | cn-hangzhou |
The ID of the region. |
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. For more information, see Specifications. |
Tags | Array of Tag |
A list of tags. |
|
Tag | |||
Key | String | test |
The key of a tag. |
Value | String | api |
The value of a tag. |
VPCCloudInstanceId | String | vpc-23rsxdfxxxxxxx |
The ID that is assigned by the virtual private cloud (VPC) to the cluster. |
VPCId | String | vpc-xxxxxxxxx |
The ID of the VPC. |
VSwitchId | String | vsw-xxxxxx |
The ID of the VSwitch. |
ZoneId | String | cn-hangzhou-a |
The ID of the zone. |
RequestId | String | 05321590-BB65-4720-8CB6-8218E041CDD0 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeDBClusterAttribute
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&<Common request parameters>
Sample success responses
XML
format
<RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>
<Items>
<DBCluster>
<StorageResource>24Core192GB</StorageResource>
<Category>Basic</Category>
<ResourceGroupId>rg-rexxxxxxxxxx</ResourceGroupId>
<Port>3306</Port>
<DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>
<DBClusterNetworkType>vpc</DBClusterNetworkType>
<DBClusterType>Primary</DBClusterType>
<DiskType>cloud</DiskType>
<DBVersion>3.0</DBVersion>
<DtsJobId>dtsb1xxxxxxxxxx</DtsJobId>
<DBNodeCount>8</DBNodeCount>
<CommodityCode>AnalyticDB for MySQL</CommodityCode>
<ExecutorCount>3</ExecutorCount>
<LockReason>instance_expired</LockReason>
<MaintainTime>00:00Z-02:00Z</MaintainTime>
<Engine>AnalyticDB</Engine>
<DBNodeStorage>100</DBNodeStorage>
<ZoneId>cn-hangzhou-a</ZoneId>
<VPCId>vpc-xxxxxxxxx</VPCId>
<DBClusterStatus>Running</DBClusterStatus>
<VSwitchId>vsw-xxxxxx</VSwitchId>
<Mode>flexible</Mode>
<DBClusterDescription>Test database</DBClusterDescription>
<ComputeResource>24Core192GB</ComputeResource>
<Expired>false</Expired>
<LockMode>Unlock</LockMode>
<PayType>Postpaid</PayType>
<DBNodeClass>C8</DBNodeClass>
<VPCCloudInstanceId>vpc-23rsxdfxxxxxxx</VPCCloudInstanceId>
<CreationTime>2011-05-30T12:11:04Z</CreationTime>
<RegionId>cn-hangzhou</RegionId>
<ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
<ConnectionString>am-xxxxxxxxxx.ads.aliyuncs.com</ConnectionString>
<RdsInstanceId>rm-bp1oxxxxxxxxxx</RdsInstanceId>
</DBCluster>
<DBCluster>
<Tags>
<Tag>
<Value>api</Value>
<Key>test</Key>
</Tag>
</Tags>
</DBCluster>
</Items>
JSON
format
{
"RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0",
"Items": {
"DBCluster": [
{
"StorageResource": "24Core192GB",
"Category": "Basic",
"ResourceGroupId": "rg-rexxxxxxxxxx",
"Port": 3306,
"DBClusterId": "rm-uf6wjk5xxxxxxxxxx",
"DBClusterNetworkType": "vpc",
"DBClusterType": "Primary",
"DiskType": "cloud",
"DBVersion": 3,
"DtsJobId": "dtsb1xxxxxxxxxx",
"DBNodeCount": 8,
"CommodityCode": "AnalyticDB for MySQL",
"ExecutorCount": 3,
"LockReason": "instance_expired",
"MaintainTime": "00:00Z-02:00Z",
"Engine": "AnalyticDB",
"DBNodeStorage": 100,
"ZoneId": "cn-hangzhou-a",
"VPCId": "vpc-xxxxxxxxx",
"DBClusterStatus": "Running",
"VSwitchId": "vsw-xxxxxx",
"Mode": "flexible",
"DBClusterDescription": "Test database",
"ComputeResource": "24Core192GB",
"Expired": false,
"LockMode": "Unlock",
"PayType": "Postpaid",
"DBNodeClass": "C8",
"VPCCloudInstanceId": "vpc-23rsxdfxxxxxxx",
"CreationTime": "2011-05-30T12:11:04Z",
"RegionId": "cn-hangzhou",
"ExpireTime": "2019-03-27T16:00:00Z",
"ConnectionString": "am-xxxxxxxxxx.ads.aliyuncs.com",
"RdsInstanceId": "rm-bp1oxxxxxxxxxx"
},
{
"Tags": {
"Tag": {
"Value": "api",
"Key": "test"
}
}
}
]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly. |
For a list of error codes, visit the API Error Center.