调用DescribeDBClusters接口查询PolarDB集群列表或被RAM授权的集群列表详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 否 DescribeDBClusters

系统规定参数，取值为DescribeDBClusters。

RegionId String 是 cn-hangzhou

地域ID。

说明 您可以通过接口DescribeRegions查看可用的地域。
DBClusterIds String 否 pc-****************

集群ID。多个集群ID间用英文逗号（,）隔开。
DBClusterDescription String 否 pc-****************

集群描述，可模糊查询。
DBClusterStatus String 否 Running

集群状态，取值范围请参见集群状态表。

DBType String 否 MySQL

数据库类型，取值范围如下：

  • MySQL。
  • PostgreSQL。
  • Oracle。
Tag.N.Key String 否 test1

标签键，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Vlaue。

说明 最多支持64个字符，不能以aliyun、acs:、http://或者https://开头。
Tag.N.Value String 否 1111

标签值，可以根据标签过滤集群列表。最多20对标签，各个标签对的数字n必须不同，且必须是从1开始的连续整数。Tag.n.Vlaue是Tag.n.Key的值。

说明 最多支持64个字符，不能以aliyun、acs:、http://或者https://开头。
PageSize Integer 否 30

每页记录数，取值为30、50或100。

默认值为30。

PageNumber Integer 否 1

页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。

ResourceGroupId String 否 rg-**********

资源组ID。

返回数据

名称 类型 示例值 描述
Items Array of DBCluster

集群列表。
DBCluster
CreateTime String 2019-01-10T09:33:58Z

创建时间。
DBClusterDescription String pc-****************

集群描述。
DBClusterId String pc-****************

集群ID。
DBClusterNetworkType String VPC

集群的网络类型。
DBClusterStatus String Running

集群状态。
DBNodeClass String polar.mysql.x4.large

节点规格。
DBNodeNumber Integer 2

节点数量。
DBNodes Array of DBNode

节点列表。
DBNode
DBNodeClass String polar.mysql.x4.large

节点规格。
DBNodeId String pi-****************

节点ID。
DBNodeRole String Writer

节点角色，取值范围如下：

  • Writer：主节点。
  • Reader：只读节点。
RegionId String cn-hangzhou

地域ID。
ZoneId String cn-hangzhou-g

可用区ID。
DBType String MySQL

数据库类型。
DBVersion String 5.6

数据库版本。
DeletionLock Integer 0

集群删除的保护状态，取值范围如下：

  • 0：未锁定。
  • 1：锁定。
    说明 锁定状态时，不可以删除集群。
Engine String POLARDB

集群引擎。
ExpireTime String 2020-01-10T09:33:58Z

到期时间。
Expired String false

是否过期。
LockMode String Unlock

集群的锁定状态,取值范围如下：

  • Unlock：正常。
  • ManualLock：手动触发锁定。
  • LockByExpiration：集群过期自动锁定。
PayType String Postpaid

付费类型，取值范围如下：

  • Postpaid：按量付费。
  • Prepaid：预付费（包年包月）。
RegionId String cn-hangzhou

地域ID。
ResourceGroupId String rg-rexxxxxxxxxx

资源组ID。
StorageUsed Long 3150970880

存储用量。
Tags Array of Tag

标签列表。
Tag
Key String test1

标签键。
Value String 1111

标签值。
VpcId String vpc-****************

专有网络ID。
ZoneId String cn-hangzhou-g

可用区ID。
PageNumber Integer 1

页数。
PageRecordCount Integer 1

本页集群数量。
RequestId String F7036AE7-20B7-43F8-9E58-558CCD******

请求ID。
TotalRecordCount Integer 1

总记录数。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<Items>
    <DBCluster>
        <DBVersion>5.6</DBVersion>
        <LockMode>Unlock</LockMode>
        <DBClusterDescription>pc-****************</DBClusterDescription>
        <DBClusterNetworkType>VPC</DBClusterNetworkType>
        <StorageUsed>3150970880</StorageUsed>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <DBClusterId>pc-****************</DBClusterId>
        <VpcId>vpc-****************</VpcId>
        <Engine>POLARDB</Engine>
        <DBClusterStatus>Running</DBClusterStatus>
        <Tags>
            <Tag>
                <Value>1111</Value>
                <Key>test1</Key>
            </Tag>
            <Tag>
                <Value>2222</Value>
                <Key>test2</Key>
            </Tag>
        </Tags>
        <ExpireTime/>
        <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
        <RegionId>cn-hangzhou</RegionId>
        <Expired>false</Expired>
        <CreateTime>2019-01-10T09:33:58Z</CreateTime>
        <DBType>MySQL</DBType>
        <DBNodes>
            <DBNode>
                <DBNodeRole>Writer</DBNodeRole>
                <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
                <DBNodeId>pi-****************</DBNodeId>
            </DBNode>
            <DBNode>
                <DBNodeRole>Reader</DBNodeRole>
                <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
                <DBNodeId>pi-****************</DBNodeId>
            </DBNode>
        </DBNodes>
        <DBNodeNumber>2</DBNodeNumber>
        <PayType>Postpaid</PayType>
    </DBCluster>
</Items>
<TotalRecordCount>1</TotalRecordCount>
<PageNumber>1</PageNumber>
<RequestId>F7036AE7-20B7-43F8-9E58-558CCD******</RequestId>
<PageRecordCount>1</PageRecordCount>

JSON 格式 

{
    "Items": {
        "DBCluster": [
            {
                "DBVersion": "5.6",
                "LockMode": "Unlock",
                "DBClusterDescription": "pc-****************",
                "DBClusterNetworkType": "VPC",
                "StorageUsed": 3150970880,
                "ZoneId": "cn-hangzhou-g",
                "DBClusterId": "pc-****************",
                "VpcId": "vpc-****************",
                "Engine": "POLARDB",
                "DBClusterStatus": "Running",
                "Tags": {
                    "Tag": [
                        {
                            "Value": "1111",
                            "Key": "test1"
                        },
                        {
                            "Value": "2222",
                            "Key": "test2"
                        }
                    ]
                },
                "ExpireTime": "",
                "DBNodeClass": "polar.mysql.x4.large",
                "RegionId": "cn-hangzhou",
                "Expired": false,
                "CreateTime": "2019-01-10T09:33:58Z",
                "DBType": "MySQL",
                "DBNodes": {
                    "DBNode": [
                        {
                            "DBNodeRole": "Writer",
                            "DBNodeClass": "polar.mysql.x4.large",
                            "DBNodeId": "pi-****************"
                        },
                        {
                            "DBNodeRole": "Reader",
                            "DBNodeClass": "polar.mysql.x4.large",
                            "DBNodeId": "pi-****************"
                        }
                    ]
                },
                "DBNodeNumber": "2",
                "PayType": "Postpaid"
            }
        ]
    },
    "TotalRecordCount": 1,
    "PageNumber": 1,
    "RequestId": "F7036AE7-20B7-43F8-9E58-558CCD******",
    "PageRecordCount": 1
}

错误码

访问错误中心查看更多错误码。