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

调试

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

请求参数

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

系统规定参数。取值:DescribeDBClustersWithBackups

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

资源组ID。

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

返回数据

名称 类型 示例值 描述
RequestId String F8529AA2-522F-4B30-B80B-8F7D39******

请求ID。

PageNumber Integer 1

页数。

PageRecordCount Integer 1

本页集群数量。

TotalRecordCount Integer 1

总记录数。

Items Array of DBCluster

集群详情。

DBCluster
DeletedTime String 2022-05-12T03:25:37Z

集群删除时间。

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

专有网络ID。

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

到期时间。

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

集群是否过期。

说明 仅付费方式为Prepaid(包年包月)的集群支持返该参数。
CreateTime String 2022-05-09T09:33:51Z

集群创建时间。

DBNodeClass String polar.mysql.x4.medium

节点规格。

PayType String Postpaid

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

  • Postpaid:按量付费。
  • Prepaid:预付费(包年包月)。
DBType String MySQL

数据库引擎类型。

LockMode String Unlock

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

  • Unlock:正常
  • ManualLock:手动触发锁定
  • LockByExpiration:集群过期自动锁定
RegionId String cn-hangzhou

地域ID。

DeletionLock Integer 0

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

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

数据库引擎版本。

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

集群ID。

DBClusterStatus String Running

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

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

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

  • 1:已释放。
  • 0:未释放。
DBClusterNetworkType String VPC

集群的网络类型。

DBClusterDescription String test

集群名称。

ZoneId String cn-hangzhou-h

可用区ID。

Engine String POLARDB

集群引擎。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClustersWithBackups
&ResourceGroupId=rg-************
&RegionId=cn-hangzhou
&DBClusterIds=pc-**************
&DBClusterDescription=test
&DBType=MySQL
&IsDeleted=0
&PageSize=30
&PageNumber=1
&DBVersion=8.0
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeDBClustersWithBackupsResponse>
    <RequestId>F8529AA2-522F-4B30-B80B-8F7D39******</RequestId>
    <PageNumber>1</PageNumber>
    <PageRecordCount>1</PageRecordCount>
    <TotalRecordCount>1</TotalRecordCount>
    <Items>
        <DeletedTime>2022-05-12T03:25:37Z</DeletedTime>
        <VpcId>vpc-******************</VpcId>
        <ExpireTime>2022-09-14T16:00:00Z</ExpireTime>
        <Expired>false</Expired>
        <CreateTime>2022-05-09T09:33:51Z</CreateTime>
        <DBNodeClass>polar.mysql.x4.medium</DBNodeClass>
        <PayType>Postpaid</PayType>
        <DBType>MySQL</DBType>
        <LockMode>Unlock</LockMode>
        <RegionId>cn-hangzhou</RegionId>
        <DeletionLock>0</DeletionLock>
        <DBVersion>8.0</DBVersion>
        <DBClusterId>pc-****************</DBClusterId>
        <DBClusterStatus>Running</DBClusterStatus>
        <IsDeleted>1</IsDeleted>
        <DBClusterNetworkType>VPC</DBClusterNetworkType>
        <DBClusterDescription>test</DBClusterDescription>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <Engine>POLARDB</Engine>
    </Items>
</DescribeDBClustersWithBackupsResponse>

JSON格式

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

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

错误码

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. 由于服务器临时故障,请求失败。

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