DescribeDBClusters_集群管理_API参考_云数据库 PolarDB-阿里云

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	否	DescribeDBClusters	系统规定参数，取值：DescribeDBClusters。
RegionId	String	是	cn-hangzhou	地域ID。说明可通过接口DescribeRegions查看可用的地域。
DBClusterIds	String	否	pc-xxxxxxxxxxxxxxxxx	集群ID。如果有多个集群ID，以（,）分隔。
DBClusterDescription	String	否	pc-xxxxxxxxxxxxxxxxx	集群描述，可模糊查询。
DBClusterStatus	String	否	Running	集群状态： Creating：创建中。 Running：运行中。 Deleting：释放中。 Rebooting：重启中。 DBNodeCreating：正在增加节点。 DBNodeDeleting：正在删除节点。 ClassChanging：正在变更节点规格。 NetAddressCreating：正在创建网络连接。 NetAddressDeleting：正在删除网络连接。 NetAddressModifying：正在修改网络连接。
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的值。说明若传入Tag.n.Key，则Tag.n.Vlaue不能为空。最多支持64个字符，不能以`aliyun、acs:、http://或者https:/`/开头。
PageSize	Integer	否	30	每页记录数，取值： 30、50、100。默认值：30。
PageNumber	Integer	否	1	页码，取值为：大于0且不超过Integer数据类型的最大值，默认值为1。
ResourceGroupId	String	否	rg-rexxxxxxxxxx	资源组ID。

返回数据


名称	类型	示例值	描述
RequestId	String	F7036AE7-20B7-43F8-9E58-558CCDED8CCB	请求ID。
PageNumber	Integer	1	页数。
TotalRecordCount	Integer	1	总记录数。
PageRecordCount	Integer	1	本页集群数量。
Items	Array		集群列表。
DBClusterId	String	pc-xxxxxxxxxxxxxxxxx	集群ID。
DBClusterDescription	String	pc-xxxxxxxxxxxxxxxxx	集群描述。
PayType	String	Postpaid	付费类型： Postpaid：按量付费。 Prepaid：预付费（包年包月）。
DBClusterNetworkType	String	VPC	集群的网络类型。
RegionId	String	cn-hangzhou	地域ID。
ZoneId	String	cn-hangzhou-g	可用区ID。
ExpireTime	String	2020-01-10T09:33:58Z	到期时间。
Expired	String	false	是否过期。
DBClusterStatus	String	Running	集群状态。
Engine	String	POLARDB	集群引擎。
DBType	String	MySQL	数据库类型。
DBVersion	String	5.6	数据库版本。
LockMode	String	Unlock	集群的锁定状态： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。
DeletionLock	Integer	0	集群删除的保护状态： 0：未锁定。 1：锁定。锁定状态时，不可以删除集群。
CreateTime	String	2019-01-10T09:33:58Z	创建时间。
VpcId	String	vpc-xxxxxxxxxxxxxxxxx	专有网络ID。
DBNodeNumber	Integer	2	节点数量。
DBNodeClass	String	polar.mysql.x4.large	节点规格。
StorageUsed	Long	3150970880	存储用量。
ResourceGroupId	String	rg-rexxxxxxxxxx	资源组ID。
DBNodes	Array		节点列表。
DBNodeId	String	pi-xxxxxxxxxxxxxxxxx	节点ID。
DBNodeClass	String	polar.mysql.x4.large	节点规格。
DBNodeRole	String	Writer	节点角色： Writer； Reader。
RegionId	String	cn-hangzhou	地域ID。
ZoneId	String	cn-hangzhou-g	可用区ID。
Tags	Array		标签列表。
Key	String	test1	标签键。
Value	String	1111	标签值。

示例

请求示例

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

正常返回示例

XML 格式

<DescribeDBClustersResponse>  
	  <Items>
		    <DBCluster>
			      <DBVersion>5.6</DBVersion>
			      <LockMode>Unlock</LockMode>
			      <DBClusterDescription>pc-xxxxxxxxxxxxxxxxx</DBClusterDescription>
			      <DBClusterNetworkType>VPC</DBClusterNetworkType>
			      <StorageUsed>3150970880</StorageUsed>
                  <ZoneId>cn-hangzhou-g</ZoneId>
			      <DBClusterId>pc-xxxxxxxxxxxxxxxxx</DBClusterId>
			      <VpcId>vpc-xxxxxxxxxxxxxxxxx</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></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-xxxxxxxxxxxxxxxxx</DBNodeId>
				        </DBNode>
				        <DBNode>
					          <DBNodeRole>Reader</DBNodeRole>
					          <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
					          <DBNodeId>pi-xxxxxxxxxxxxxxxxx</DBNodeId>
				        </DBNode>
			      </DBNodes>
			      <DBNodeNumber>2</DBNodeNumber>
			      <PayType>Postpaid</PayType>
		    </DBCluster>
	  </Items>
	  <TotalRecordCount>1</TotalRecordCount>
	  <PageNumber>1</PageNumber>
	  <RequestId>F7036AE7-20B7-43F8-9E58-558CCDED8CCB</RequestId>
	  <PageRecordCount>1</PageRecordCount>
  </DescribeDBClustersResponse>

JSON 格式

{
    "Items": {
        "DBCluster": [
            {
                "DBVersion": "5.6",
                "LockMode": "Unlock",
                "DBClusterDescription": "pc-xxxxxxxxxxxxxxxxx",
                "DBClusterNetworkType": "VPC",
                "StorageUsed": 3150970880,
                "ZoneId": "cn-hangzhou-g",
                "DBClusterId": "pc-xxxxxxxxxxxxxxxxx",
                "VpcId": "vpc-xxxxxxxxxxxxxxxxx",
                "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-xxxxxxxxxxxxxxxxx"
                        },
                        {
                            "DBNodeRole": "Reader",
                            "DBNodeClass": "polar.mysql.x4.large",
                            "DBNodeId": "pi-xxxxxxxxxxxxxxxxx"
                        }
                    ]
                },
                "DBNodeNumber": "2",
                "PayType": "Postpaid"
            }
        ]
    },
    "TotalRecordCount": 1,
    "PageNumber": 1,
    "RequestId": "F7036AE7-20B7-43F8-9E58-558CCDED8CCB",
    "PageRecordCount": 1
}

错误码

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