该接口用于查询集群列表或被RAM授权的集群列表。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数,取值:DescribeDBClusters。
RegionId String 地域ID。
DBClusterIds String 如果有多个实例ID,以","分隔。
DBClusterDescription String 实例描述,可模糊查询(前缀匹配)。
DBClusterStatus String 实例状态,比如创建中,锁定中等。见集群状态表
PageSize Integer 每页记录数,取值:
  • 30;
  • 50;
  • 100;
  • 默认值:30。
PageNumber Integer 页码,取值为:大于0且不超过Integer数据类型的最大值,默认值为1。

返回参数

名称 类型 描述
<公共返回参数> - 详见公共参数
RequestId String RequestId。
PageNumber Integer 页数。
TotalCount Integer 总记录数。
PageSize Integer 总页数。
DBClusters List<DBCluster> 实例列表。

DBCluster

参数 类型 描述
DBClusterId String 数据库实例ID。
DBClusterDescription String 实例描述。
Category String

系列

  • Basic:基础版;
  • HighAvailability:高可用版
PayType String 付费类型:
  • Postpaid:按量付费;
  • Prepaid:预付费(包年包月)。
RegionId String 地域ID。
ZoneId String 可用区ID
CreateTime String

创建时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z'

,如2011-05-30T12:11:4Z。

ExpireTime String

到期时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z'

,如2011-05-30T12:11:4Z。

说明 按量付费实例无到期时间。
DBClusterStatus String 实例状态。见集群状态表
DBNodeClass String 节点类型。 C8
DBNodeCount Integer 节点组个数
CommodityCode String 售卖商品CODE

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<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 格式

{
  "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"
}