DescribeDBClusters - 云原生数据库 PolarDB

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDBClusters	系统规定参数。取值：DescribeDBClusters。
RegionId	String	是	cn-hangzhou	地域ID。说明您可以通过接口DescribeRegions查看可用的地域。
DBClusterIds	String	否	pc-****************	集群ID。多个集群ID间用英文逗号（,）隔开。
DBClusterDescription	String	否	pc-****************	集群描述，可模糊查询。
ConnectionString	String	否	********.rwlb.polardb-pg-public.rds.aliyuncs.com	数据库连接地址。
DBClusterStatus	String	否	Running	集群状态，取值范围请参见集群状态表。
DBType	String	否	MySQL	数据库类型，取值范围如下： MySQL PostgreSQL Oracle
DBVersion	String	否	5.6	数据库版本。
RecentCreationInterval	Integer	否	7	筛选最近N天创建的集群。取值范围：0~15。
RecentExpirationInterval	Integer	否	6	筛选N天后过期的集群。取值范围：0~15。
Expired	Boolean	否	true	是否集群已过期。取值范围： true false
PageSize	Integer	否	30	每页记录数，取值为30、50或100。默认值为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个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。
PayType	String	否	Postpaid	付费类型，取值范围如下： Postpaid：按量付费 Prepaid：预付费（包年包月）
DBNodeIds	String	否	pi-***************	节点ID。支持传入多个节点ID，多个ID间用英文逗号（,）分隔。

返回数据


名称	类型	示例值	描述
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	集群是否到期。取值范围： true false 说明仅付费方式为Prepaid（包年包月）的集群支持返该参数。
DBNodeNumber	Integer	2	节点数量。
CreateTime	String	2020-08-14T05:58:42Z	创建时间。
PayType	String	Prepaid	付费类型。取值范围： Postpaid：按量付费。 Prepaid：包年包月（预付费）。
StoragePayType	String	Prepaid	存储计费类型。取值范围： Postpaid：按容量计费（按量计费）。 Prepaid：按空间计费（包年包月）。
ServerlessType	String	AgileServerless	Serverless类型。返回AgileServerless表示当前集群是Serverless集群，返回空值表示当前集群是普通集群。
StrictConsistency	String	ON	集群是否开启了多可用区数据强一致。取值范围： ON：表示开启了多可用区数据强一致，适用于标准版3AZ场景。 OFF：表示未开启多可用区数据强一致。
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。
Serverless	String	ON	当前节点是否开启了Serverless功能。返回ON表示开启了Serverless功能，返回空值表示没有开启Serverless功能。
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	集群已经使用的存储用量，单位为Byte。
StorageSpace	Long	50	按空间计费（包年包月）的存储空间。单位：Byte。
DBClusterNetworkType	String	VPC	集群的网络类型。
DBClusterDescription	String	GDN-1	集群描述。
ZoneId	String	cn-hangzhou-i	可用区ID。
Engine	String	POLARDB	集群引擎。
Category	String	Normal	集群系列，目前支持如下系列： Normal：集群版 Basic：单节点 Archive：高压缩引擎（X-Engine） NormalMultimaster：多主集群（库表）

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&DBClusterIds=pc-****************
&DBClusterDescription=pc-****************
&ConnectionString=********.rwlb.polardb-pg-public.rds.aliyuncs.com
&DBClusterStatus=Running
&DBType=MySQL
&DBVersion=5.6
&RecentCreationInterval=7
&RecentExpirationInterval=6
&Expired=true
&PageSize=30
&PageNumber=10
&ResourceGroupId=rg-**********
&Tag=[{"Key":"MySQL","Value":"5.6"}]
&PayType=Postpaid
&DBNodeIds=pi-***************
&公共请求参数

正常返回示例

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>
        <StoragePayType>Prepaid</StoragePayType>
        <ServerlessType>AgileServerless</ServerlessType>
        <StrictConsistency>ON</StrictConsistency>
        <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>
            <Serverless>ON</Serverless>
        </DBNodes>
        <RegionId>cn-hangzhou</RegionId>
        <DeletionLock>0</DeletionLock>
        <DBVersion>5.6</DBVersion>
        <DBClusterId>pc-****************</DBClusterId>
        <DBClusterStatus>Running</DBClusterStatus>
        <ResourceGroupId>rg-************</ResourceGroupId>
        <StorageUsed>3009413120</StorageUsed>
        <StorageSpace>50</StorageSpace>
        <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",
    "StoragePayType" : "Prepaid",
    "ServerlessType" : "AgileServerless",
    "StrictConsistency" : "ON",
    "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",
      "Serverless" : "ON"
    } ],
    "RegionId" : "cn-hangzhou",
    "DeletionLock" : 0,
    "DBVersion" : "5.6",
    "DBClusterId" : "pc-****************",
    "DBClusterStatus" : "Running",
    "ResourceGroupId" : "rg-************",
    "StorageUsed" : 3009413120,
    "StorageSpace" : 50,
    "DBClusterNetworkType" : "VPC",
    "DBClusterDescription" : "GDN-1",
    "ZoneId" : "cn-hangzhou-i",
    "Engine" : "POLARDB",
    "Category" : "Normal"
  } ]
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	指定的参数RegionId无效。
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定的参数PageSize无效
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定的参数PageNumber无效
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	由于某些未知错误、异常或失败，请求处理失败。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由于服务器临时故障，请求失败。

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