调用DescribeDBClustersWithBackups接口查询某地域下包含备份集的PolarDB集群详情。

调试

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

请求参数

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

系统规定参数,取值为DescribeDBClustersWithBackups

RegionId String cn-hangzhou

地域ID。

说明 可通过接口 DescribeRegions查看地域信息详情。
DBClusterIds String pc-**************

集群ID,支持传入多个集群ID,集群ID之间用英文逗号(,)分隔。

DBClusterDescription String test

集群名称,集群名称需满足如下要求:

  • 不能以http://https://开头。
  • 长度为2~256个字符。
DBType String MySQL

数据库引擎类型,取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
IsDeleted Integer 0

集群是否已删除,取值范围如下:

  • 0:未删除
  • 1:已删除
PageSize Integer 30

每页记录数,取值范围如下:

  • 30
  • 50
  • 100

默认值为30。

PageNumber Integer 1

页码,取值范围为大于0但不超过Integer最大值的整数,默认值为1

DBVersion String 8.0

数据库引擎版本号。

  • MySQL版本号取值范围如下:
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL版本号取值为11
  • Oracle版本号取值为11

返回数据

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

集群详情。

DBCluster
CreateTime String 2020-05-09T09:33:51Z

集群创建时间。

DBClusterDescription String test

集群名称。

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

集群ID。

DBClusterNetworkType String VPC

集群的网络类型。

DBClusterStatus String Running

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

  • Creating:创建中
  • Running:运行中
  • Deleting:释放中
  • Rebooting:重启中
  • DBNodeCreating:正在增加节点
  • DBNodeDeleting:正在删除节点
  • ClassChanging:正在变更节点规格
  • NetAddressCreating:正在创建网络连接
  • NetAddressDeleting:正在删除网络连接
  • NetAddressModifying:正在修改网络连接
  • Deleted:已释放
DBNodeClass String polar.mysql.x4.medium

节点规格。

DBType String MySQL

数据库引擎类型。

DBVersion String 8.0

数据库引擎版本。

DeletedTime String 2020-05-12T03:25:37Z

集群删除时间。

DeletionLock Integer 0

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

  • 0:未锁定,可删除集群。
  • 1:锁定,不可删除集群。
Engine String POLARDB

集群引擎。

ExpireTime String 2019-09-14T16:00:00Z

到期时间。

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

集群是否过期。

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

集群是否已释放,取值范围如下:

  • 1:已释放。
  • 0:未释放。
LockMode String Unlock

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

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

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

  • Postpaid:按量付费。
  • Prepaid:预付费(包年包月)。
RegionId String cn-hangzhou

地域ID。

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

专有网络ID。

ZoneId String cn-hangzhou-h

可用区ID。

PageNumber Integer 1

页数。

PageRecordCount Integer 1

本页集群数量。

RequestId String F8529AA2-522F-4B30-B80B-8F7D39******

请求ID。

TotalRecordCount Integer 1

总记录数。

示例

请求示例

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

正常返回示例

XML 格式

<DescribeDBClustersWithBackupsResponse>
  <TotalRecordCount>1</TotalRecordCount>
  <PageRecordCount>1</PageRecordCount>
  <RequestId>F8529AA2-522F-4B30-B80B-8F7D39******</RequestId>
  <PageNumber>1</PageNumber>
  <Items>
        <DBCluster>
              <IsDeleted>1</IsDeleted>
              <ZoneId>cn-hangzhou-h</ZoneId>
              <DeletedTime>2020-05-12T03:25:37Z</DeletedTime>
              <DBClusterStatus>Deleted</DBClusterStatus>
              <CreateTime>2020-05-09T09:33:51Z</CreateTime>
              <DBClusterId>pc-****************</DBClusterId>
              <DBClusterDescription>pc-****************</DBClusterDescription>
              <PayType>Postpaid</PayType>
              <DBClusterNetworkType>VPC</DBClusterNetworkType>
              <DBType>MySQL</DBType>
              <LockMode>Unlock</LockMode>
              <DBNodeClass>polar.mysql.x4.medium</DBNodeClass>
              <DBVersion>5.6</DBVersion>
              <VpcId>vpc-*****************</VpcId>
              <RegionId>cn-hangzhou</RegionId>
              <Engine>POLARDB</Engine>
        </DBCluster>
  </Items>
</DescribeDBClustersWithBackupsResponse>

JSON 格式

{
	"TotalRecordCount": 1,
	"PageRecordCount": 1,
	"RequestId": "F8529AA2-522F-4B30-B80B-8F7D39******",
	"PageNumber": 1,
	"Items": {
		"DBCluster": [
			{
				"IsDeleted": 1,
				"ZoneId": "cn-hangzhou-h",
				"DeletedTime": "2020-05-12T03:25:37Z",
				"DBClusterStatus": "Deleted",
				"CreateTime": "2020-05-09T09:33:51Z",
				"DBClusterId": "pc-****************",
				"DBClusterDescription": "pc-****************",
				"PayType": "Postpaid",
				"DBClusterNetworkType": "VPC",
				"DBType": "MySQL",
				"LockMode": "Unlock",
				"DBNodeClass": "polar.mysql.x4.medium",
				"DBVersion": "5.6",
				"VpcId": "vpc-*****************",
				"RegionId": "cn-hangzhou",
				"Engine": "POLARDB"
			}
		]
	}
}

错误码

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