You can call this operation to query clusters within an Alibaba Cloud account or clusters that are accessible to an authorized Resource Access Management (RAM) user.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeDBClusters.
RegionId String Yes The region ID of the cluster.
DBClusterIds String No The ID of the cluster. Separate multiple cluster IDs with commas (,).
DBClusterDescription String No The description of the cluster. Prefix-based fuzzy match is supported.
DBClusterStatus String No The status of the cluster, such as Creating or Locking. For more information, see Cluster status table.
PageSize Integer No The number of entries to return on each page. Valid values:
  • 30
  • 50
  • 100
  • Default value: 30.
PageNumber Integer No The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

Response parameters

Parameter Type Description
<Common response parameters> - For more information, see Common parameters.
RequestId String The ID of the request.
PageNumber Integer The page number of the returned page.
TotalCount Integer The total number of entries.
PageSize Integer The total number of returned pages.
DBClusters List<DBCluster> The list of clusters.

DBCluster

Parameter Type Description
DBClusterId String The ID of the cluster.
DBClusterDescription String The description of the cluster.
Category String

The edition of the cluster.

  • Basic
  • HighAvailability
PayType String The billing method of the cluster. Valid values:
  • Postpaid: pay-as-you-go
  • Prepaid: subscription
RegionId String The region ID of the cluster.
ZoneId String The zone ID of the cluster.
CreateTime String

The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

Example: 2011-05-30T12:11:4Z.

ExpireTime String

The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

Example: 2011-05-30T12:11:4Z.

Note Pay-as-you-go clusters never expire.
DBClusterStatus String The status of the cluster. For more information, see Cluster status table.
DBNodeClass String The node type. Example: C8.
DBNodeCount Integer The number of nodes.
CommodityCode String The commodity code.

Examples

Sample requests

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

Sample success responses

XML format

<DBClusters>
        <DBCluster>
      <Category>HighAvailability</Category>
            <LockMode>Unlock</LockMode>
            <DBClusterDescription>cc-bp108z124a8o74208</DBClusterDescription>
            <DBNodeCount>2</DBNodeCount>
            <DBClusterId>cc-bp108z124a8o74208</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>
            <LockReason></LockReason>
            <PayType>Prepaid</PayType>
            <DBNodeStorage>100</DBNodeStorage>
        </DBCluster>
    </DBClusters>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>

JSON format

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