All Products
Search
Document Center

DescribeDBClusterAttribute

Last Updated: Aug 05, 2020

Queries details about an AnalyticDB for MySQL cluster.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBClusterAttribute The operation that you want to perform. Set the value to

DescribeDBClusterAttribute.

DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx The ID of the cluster whose details are to be queried.

Response parameters

Parameter Type Description
<Common response parameters> String
Items List<DBCluster> The details about the cluster.

DBCluster

Parameter Type Example Description
RegionId String cn-hangzhou The ID of the region where the cluster resides.
ZoneId String cn-hangzhou-a The ID of the zone where the cluster is available.
DBClusterId String rm-uf6wjk5xxxxxxxxxx The ID of the cluster.
DBClusterType String Primary The type of the cluster. The value Primary indicates a primary cluster.
DBClusterDescription String Test database The description of the cluster.
Category String Basic The edition of the cluster. The value Basic indicates the basic edition.
LockMode String Unlock The lock mode of the cluster. Valid values:
  • Unlock: The cluster was unlocked.
  • ManualLock: The cluster was manually locked.
  • LockByExpiration: The cluster was automatically locked after it expired.
  • LockByRestoration: The cluster was automatically locked before a rollback.
  • LockByDiskQuota: The cluster was automatically locked when the disk space was full.
LockReason String instance_expired The reason why the cluster was locked.
PayType String Postpaid The billing method of the cluster. Valid values:
  • Postpaid: pay-as-you-go
  • Prepaid: subscription
DBVersion String 3.0 The database version of the cluster. Currently, only version 3.0 is available.
DBClusterStatus String Running The status of the cluster. For more information, see Cluster status.
DBNodeStorage Long 100 The storage capacity of the cluster. Unit: GB
DBNodeClass String C8 The node type of the cluster, for example, C8.
DBNodeCount Long 8 The number of nodes in the cluster.
CreationTime String 2011-05-30T12:11:04Z The time when the cluster was created. The format is yyyy-MM-dd’T’HH:mm:ss’Z’. Example: 2011-05-30T12:11:4Z
ExpireTime String 2019-03-27T16:00:00Z The time when the cluster expires. The format is yyyy-MM-dd’T’HH:mm:ss’Z’. Example: 2011-05-30T12:11:4Z

Note: Pay-as-you-go clusters never expire.

MaintainTime String 00:00Z-02:00Z The maintenance window of the cluster. The format is HH:mmZ-HH:mmZ. For example, 00:00Z-01:00Z indicates that routine maintenance can be performed from 00:00 to 01:00.
VPCId String vpc-xxxxxxxxx The VPC ID of the cluster.
VSwitchId String vsw-xxxxxx The VSwitch ID of the cluster.
VPCCloudInstanceId String vpc-23rsxdfxxxxxxx The ID of the VPC resource used by the cluster.
CommodityCode String The product code of the cluster.

Examples

Sample requests

  1. http(s)://[Endpoint]/?Action=DescribeDBClusterAttribute
  2. &DBClusterId=am-xxxxxxxxxxxxxxx
  3. &<Common request parameters>

Sample success responses

XML format

  1. <Items>
  2. <DBCluster>
  3. <Category>Basic</Category>
  4. <CreationTime>2019-09-11T11:33:11Z</CreationTime>
  5. <DBClusterDescription>am-bp*******</DBClusterDescription>
  6. <DBClusterId>am-bp*********</DBClusterId>
  7. <DBClusterNetworkType>vpc</DBClusterNetworkType>
  8. <DBClusterStatus>Running</DBClusterStatus>
  9. <DBClusterType>Common</DBClusterType>
  10. <DBNodeClass>C8</DBNodeClass>
  11. <DBNodeCount>2</DBNodeCount>
  12. <DBNodeStorage>100</DBNodeStorage>
  13. <DBVersion>3.0</DBVersion>
  14. <Engine>AnalyticDB</Engine>
  15. <ExpireTime>2019-11-11T16:00:00Z</ExpireTime>
  16. <Expired>false</Expired>
  17. <LockMode>Unlock</LockMode>
  18. <LockReason></LockReason>
  19. <MaintainTime>18:00Z-19:00Z</MaintainTime>
  20. <PayType>Prepaid</PayType>
  21. <RegionId>cn-hangzhou</RegionId>
  22. <Tags>
  23. <Tag></Tag>
  24. </Tags>
  25. <VPCCloudInstanceId>am-bp*********-controller</VPCCloudInstanceId>
  26. <VPCId>vpc-bp************</VPCId>
  27. <VSwitchId>vsw-bp*******</VSwitchId>
  28. <ZoneId>cn-hangzhou-h</ZoneId>
  29. </DBCluster>
  30. </Items>
  31. <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>

JSON format

  1. {
  2. "Items": {
  3. "DBCluster": [
  4. {
  5. "DBNodeCount": 2,
  6. "ZoneId": "cn-hangzhou-h",
  7. "DBClusterId": "am-bp*******",
  8. "VSwitchId": "vsw-bp***********",
  9. "Engine": "AnalyticDB",
  10. "DBClusterStatus": "Running",
  11. "MaintainTime": "18:00Z-19:00Z",
  12. "VPCId": "vpc-bp************",
  13. "DBClusterType": "Common",
  14. "PayType": "Prepaid",
  15. "DBVersion": "3.0",
  16. "LockMode": "Unlock",
  17. "DBClusterDescription": "am-bp***********",
  18. "DBClusterNetworkType": "vpc",
  19. "VPCCloudInstanceId": "am-bp*********-controller",
  20. "CreationTime": "2019-09-11T11:33:11Z",
  21. "Tags": {
  22. "Tag": []
  23. },
  24. "Category": "Basic",
  25. "ExpireTime": "2019-11-11T16:00:00Z",
  26. "DBNodeClass": "C8",
  27. "RegionId": "cn-hangzhou",
  28. "Expired": false,
  29. "LockReason": "",
  30. "DBNodeStorage": 100
  31. }
  32. ]
  33. },
  34. "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
  35. }