DescribeDBClusters - API Reference| Alibaba Cloud Documentation Center

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

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 ID of the region where the target clusters reside.
DBClusterIds	String	No	am-bp1xxxxxxxx47	The ID of the cluster to be queried. Separate multiple cluster IDs with commas (,).
DBClusterDescription	String	No	Test database	The description of the cluster. Fuzzy match is supported.
DBClusterStatus	String	No	Running	The status of the cluster, such as creating or locking. For more information, see Cluster status.
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30
PageNumber	Integer	No	1	The number of the page to return. Valid values: any positive integer Default value: 1

Response parameters

Parameter	Type	Example	Description
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	The ID of the request.
PageNumber	Integer	1	The page number of the page returned.
TotalCount	Integer	100	The total number of entries returned.
PageSize	Integer	2	The total number of pages returned.
Items	List<DBCluster>		The information about clusters.

DBCluster

Parameter	Type	Example	Description
DBClusterId	String	am-bpxxxxxxxx47	The ID of a cluster.
DBClusterDescription	String	Test database	The description of the cluster.
PayType	String	Postpaid	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription
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.
CreateTime	String	2019-03-20T02:18:02Z	The time when the cluster was created.
ExpireTime	String	2020-03-20T02:18:02Z	The time when the cluster expires. Note: Pay-as-you-go clusters never expire.
DBClusterStatus	String	Running	The status of the cluster. For more information, see Cluster status.
DBNodeClass	String	C8	The node type of the cluster.
DBNodeCount	Integer	128	The number of nodes in the cluster.
DBVersion	String	3.0	The database version of the cluster. Currently, only version 3.0 is available.
DBClusterType	String	Common	The type of the cluster. The value Primary indicates a primary cluster.
CommodityCode	String		The product code of the cluster.

Examples

Sample requests

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

Sample success responses

XML format

<Items>
        <DBCluster>
            <DBVersion>3.0</DBVersion>
            <LockMode>Unlock</LockMode>
            <DBClusterDescription>am-bp*********</DBClusterDescription>
            <DBNodeCount>2</DBNodeCount>
            <DBClusterId>am-bp*********/DBClusterId>
            <DBClusterStatus>Running</DBClusterStatus>
            <Tags></Tags>
            <ExpireTime>2019-11-11T16:00:00Z</ExpireTime>
            <RegionId>cn-hangzhou</RegionId>
            <Expired>false</Expired>
            <CreateTime>2019-09-11T11:33:11Z</CreateTime>
            <DBNodeClass>C8</DBNodeClass>
            <DBClusterType>Common</DBClusterType>
            <LockReason></LockReason>
            <PayType>Prepaid</PayType>
            <DBNodeStorage>100</DBNodeStorage>
        </DBCluster>
    </Items>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>

JSON format

{
  "Items": {
    "DBCluster": [
      {
        "DBVersion": "3.0",
        "LockMode": "Unlock",
        "DBClusterDescription": "am-bp*********",
        "DBNodeCount": 2,
        "DBClusterId": "am-bp*********",
        "DBClusterStatus": "Running",
        "Tags": {
          "Tag": []
        },
        "ExpireTime": "2019-11-11T16:00:00Z",
        "RegionId": "cn-hangzhou",
        "Expired": false,
        "CreateTime": "2019-09-11T11:33:11Z",
        "DBNodeClass": "C8",
        "DBClusterType": "Common",
        "LockReason": "",
        "PayType": "Prepaid",
        "DBNodeStorage": 100
      }
    ]
  },
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75"
}