调用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
PageSize Integer 30

每页记录数,取值为3050100

默认值为30

PageNumber Integer 10

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

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

资源组ID。

Tag.N.Key String MySQL

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

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

标签键对应的标签值。

说明 最多支持64个字符,不能以 aliyunacs:http://或者 https://开头。

返回数据

名称 类型 示例值 描述
TotalRecordCount Integer 16

总记录数。

PageRecordCount Integer 5

本页集群数量。

RequestId String 9B7BFB11-C077-4FE3-B051-F69CEB******

请求ID。

PageNumber Integer 12

页数。

Items Array of DBCluster

集群列表。

DBCluster
VpcId String vpc-****************

专有网络ID。

ExpireTime String 2020-11-14T16:00:00Z

集群到期时间。

说明 仅付费方式为 Prepaid(包年包月)的集群会返回具体参数值, Postpaid(按量付费)集群则返回空值。
Expired String false

集群是否到期。

说明 仅付费方式为 Prepaid(包年包月)的集群支持返该参数。
DBNodeNumber Integer 2

节点数量。

CreateTime String 2020-08-14T05:58:42Z

创建时间。

PayType String Prepaid

付费类型,取值范围如下:

  • Postpaid:按量付费。
  • Prepaid:包年包月(预付费)。
DBNodeClass String polar.mysql.x4.large

节点规格。

Tags Array of Tag

标签列表。

Tag
Key String MySQL

标签键。

Value String 5.6

标签值。

DBType String MySQL

数据库类型。

LockMode String Unlock

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

  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:集群过期自动锁定。
DBNodes Array of DBNode

节点列表。

DBNode
DBNodeClass String polar.mysql.x4.large

节点规格。

ZoneId String cn-hangzhou-i

可用区ID。

DBNodeRole String Reader

节点角色,取值范围如下:

  • Writer:主节点。
  • Reader:只读节点。
DBNodeId String pi-****************

节点ID。

RegionId String cn-hangzhou

地域ID。

RegionId String cn-hangzhou

地域ID。

DeletionLock Integer 0

集群删除的保护状态,取值范围如下:

  • 0:未锁定。
  • 1:锁定。
    说明 锁定状态时,不可以删除集群。
DBVersion String 5.6

数据库版本。

DBClusterId String pc-****************

集群ID。

DBClusterStatus String Running

集群状态。

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

资源组ID。

StorageUsed Long 3009413120

存储用量。

DBClusterNetworkType String VPC

集群的网络类型。

DBClusterDescription String GDN-1

集群描述。

ZoneId String cn-hangzhou-i

可用区ID。

Engine String POLARDB

集群引擎。

Category String Normal

集群系列,目前支持如下系列:

  • Normal:集群版
  • Basic:单节点
  • Archive:历史库

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClustersResponse>
    <TotalRecordCount>16</TotalRecordCount>
    <PageRecordCount>5</PageRecordCount>
    <RequestId>9B7BFB11-C077-4FE3-B051-F69CEB******</RequestId>
    <PageNumber>12</PageNumber>
    <Items>
        <VpcId>vpc-****************</VpcId>
        <ExpireTime>2020-11-14T16:00:00Z</ExpireTime>
        <Expired>false</Expired>
        <DBNodeNumber>2</DBNodeNumber>
        <CreateTime>2020-08-14T05:58:42Z</CreateTime>
        <PayType>Prepaid</PayType>
        <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
        <Tags>
            <Key>MySQL</Key>
            <Value>5.6</Value>
        </Tags>
        <DBType>MySQL</DBType>
        <LockMode>Unlock</LockMode>
        <DBNodes>
            <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <DBNodeRole>Reader</DBNodeRole>
            <DBNodeId>pi-****************</DBNodeId>
            <RegionId>cn-hangzhou</RegionId>
        </DBNodes>
        <RegionId>cn-hangzhou</RegionId>
        <DeletionLock>0</DeletionLock>
        <DBVersion>5.6</DBVersion>
        <DBClusterId>pc-****************</DBClusterId>
        <DBClusterStatus>Running</DBClusterStatus>
        <ResourceGroupId>rg-************</ResourceGroupId>
        <StorageUsed>3009413120</StorageUsed>
        <DBClusterNetworkType>VPC</DBClusterNetworkType>
        <DBClusterDescription>GDN-1</DBClusterDescription>
        <ZoneId>cn-hangzhou-i</ZoneId>
        <Engine>POLARDB</Engine>
        <Category>Normal</Category>
    </Items>
</DescribeDBClustersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 16,
  "PageRecordCount" : 5,
  "RequestId" : "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber" : 12,
  "Items" : [ {
    "VpcId" : "vpc-****************",
    "ExpireTime" : "2020-11-14T16:00:00Z",
    "Expired" : "false",
    "DBNodeNumber" : 2,
    "CreateTime" : "2020-08-14T05:58:42Z",
    "PayType" : "Prepaid",
    "DBNodeClass" : "polar.mysql.x4.large",
    "Tags" : [ {
      "Key" : "MySQL",
      "Value" : "5.6"
    } ],
    "DBType" : "MySQL",
    "LockMode" : "Unlock",
    "DBNodes" : [ {
      "DBNodeClass" : "polar.mysql.x4.large",
      "ZoneId" : "cn-hangzhou-i",
      "DBNodeRole" : "Reader",
      "DBNodeId" : "pi-****************",
      "RegionId" : "cn-hangzhou"
    } ],
    "RegionId" : "cn-hangzhou",
    "DeletionLock" : 0,
    "DBVersion" : "5.6",
    "DBClusterId" : "pc-****************",
    "DBClusterStatus" : "Running",
    "ResourceGroupId" : "rg-************",
    "StorageUsed" : 3009413120,
    "DBClusterNetworkType" : "VPC",
    "DBClusterDescription" : "GDN-1",
    "ZoneId" : "cn-hangzhou-i",
    "Engine" : "POLARDB",
    "Category" : "Normal"
  } ]
}

错误码

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