DescribeDBClusters_集群管理_API参考_PolarDB MySQL 云原生数据库

调试

您可以在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	2020-08-14T05:58:42Z	创建时间。
DBClusterDescription	String	test	集群描述。
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	Reader	节点角色，取值范围如下： Writer：主节点。 Reader：只读节点。
RegionId	String	cn-hangzhou	地域ID。
ZoneId	String	cn-hangzhou-i	可用区ID。
DBType	String	MySQL	数据库类型。
DBVersion	String	5.6	数据库版本。
DeletionLock	Integer	0	集群删除的保护状态，取值范围如下： 0：未锁定。 1：锁定。说明锁定状态时，不可以删除集群。
Engine	String	POLARDB	集群引擎。
ExpireTime	String	2020-11-14T16:00:00Z	集群到期时间。说明仅付费方式为Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。
Expired	String	false	集群是否到期。说明仅付费方式为Prepaid（包年包月）的集群支持返该参数。
LockMode	String	Unlock	集群的锁定状态，取值范围如下： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。
PayType	String	Prepaid	付费类型，取值范围如下： Postpaid：按量付费。 Prepaid：包年包月（预付费）。
RegionId	String	cn-hangzhou	地域ID。
ResourceGroupId	String	rg-************	资源组ID。
StorageUsed	Long	3009413120	存储用量。
Tags	Array of Tag		标签列表。
Tag
Key	String	MySQL	标签键。
Value	String	5.6	标签值。
VpcId	String	vpc-****************	专有网络ID。
ZoneId	String	cn-hangzhou-i	可用区ID。
PageNumber	Integer	1	页数。
PageRecordCount	Integer	1	本页集群数量。
RequestId	String	9B7BFB11-C077-4FE3-B051-F69CEB******	请求ID。
TotalRecordCount	Integer	1	总记录数。

示例

请求示例

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

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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