All Products
Search
Document Center

DescribeDBClusters

Last Updated: Aug 04, 2020

Queries AnalyticDB for MySQL clusters under an Alibaba Cloud account or a Resource Access Management (RAM) user.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeDBClustersThe operation that you want to perform. Set the value to DescribeDBClusters.
RegionIdStringYescn-hangzhouThe ID of the region where the target clusters reside.
DBClusterIdsStringNoam-bp1xxxxxxxx47The ID of the cluster to be queried.

Separate multiple cluster IDs with commas (,).

DBClusterDescriptionStringNoTest databaseThe description of the cluster. Fuzzy match is supported.
DBClusterStatusStringNoRunningThe status of the cluster, such as creating or locking. For more information, see Cluster status.
PageSizeIntegerNo30The number of entries to return on each page. Valid values:
  • 30
  • 50
  • 100
Default value: 30
PageNumberIntegerNo1The number of the page to return. Valid values: any positive integer Default value: 1

Response parameters

ParameterTypeExampleDescription
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEFThe ID of the request.
PageNumberInteger1The page number of the page returned.
TotalCountInteger100The total number of entries returned.
PageSizeInteger2The total number of pages returned.
ItemsList<DBCluster>The information about clusters.

DBCluster

ParameterTypeExampleDescription
DBClusterIdStringam-bpxxxxxxxx47The ID of a cluster.
DBClusterDescriptionStringTest databaseThe description of the cluster.
PayTypeStringPostpaidThe billing method of the cluster. Valid values:
  • Postpaid: pay-as-you-go
  • Prepaid: subscription
RegionIdStringcn-hangzhouThe ID of the region where the cluster resides.
ZoneIdStringcn-hangzhou-aThe ID of the zone where the cluster is available.
CreateTimeString2019-03-20T02:18:02ZThe time when the cluster was created.
ExpireTimeString2020-03-20T02:18:02ZThe time when the cluster expires.

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

DBClusterStatusStringRunningThe status of the cluster. For more information, see Cluster status.
DBNodeClassStringC8The node type of the cluster.
DBNodeCountInteger128The number of nodes in the cluster.
DBVersionString3.0The database version of the cluster. Currently, only version 3.0 is available.
DBClusterTypeStringCommonThe type of the cluster. The value Primary indicates a primary cluster.
CommodityCodeStringThe product code of the cluster.

Examples

Sample requests

  1. http(s)://[Endpoint]/?Action=DescribeDBClusters
  2. &RegionId=cn-hangzhou
  3. &<Common request parameters>

Sample success responses

XML format

  1. <Items>
  2. <DBCluster>
  3. <DBVersion>3.0</DBVersion>
  4. <LockMode>Unlock</LockMode>
  5. <DBClusterDescription>am-bp*********</DBClusterDescription>
  6. <DBNodeCount>2</DBNodeCount>
  7. <DBClusterId>am-bp*********/DBClusterId>
  8. <DBClusterStatus>Running</DBClusterStatus>
  9. <Tags></Tags>
  10. <ExpireTime>2019-11-11T16:00:00Z</ExpireTime>
  11. <RegionId>cn-hangzhou</RegionId>
  12. <Expired>false</Expired>
  13. <CreateTime>2019-09-11T11:33:11Z</CreateTime>
  14. <DBNodeClass>C8</DBNodeClass>
  15. <DBClusterType>Common</DBClusterType>
  16. <LockReason></LockReason>
  17. <PayType>Prepaid</PayType>
  18. <DBNodeStorage>100</DBNodeStorage>
  19. </DBCluster>
  20. </Items>
  21. <PageNumber>1</PageNumber>
  22. <TotalCount>1</TotalCount>
  23. <PageSize>30</PageSize>
  24. <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>

JSON format

  1. {
  2. "Items": {
  3. "DBCluster": [
  4. {
  5. "DBVersion": "3.0",
  6. "LockMode": "Unlock",
  7. "DBClusterDescription": "am-bp*********",
  8. "DBNodeCount": 2,
  9. "DBClusterId": "am-bp*********",
  10. "DBClusterStatus": "Running",
  11. "Tags": {
  12. "Tag": []
  13. },
  14. "ExpireTime": "2019-11-11T16:00:00Z",
  15. "RegionId": "cn-hangzhou",
  16. "Expired": false,
  17. "CreateTime": "2019-09-11T11:33:11Z",
  18. "DBNodeClass": "C8",
  19. "DBClusterType": "Common",
  20. "LockReason": "",
  21. "PayType": "Prepaid",
  22. "DBNodeStorage": 100
  23. }
  24. ]
  25. },
  26. "PageNumber": 1,
  27. "TotalCount": 1,
  28. "PageSize": 30,
  29. "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75"
  30. }