文档

DescribeDBClustersWithBackups - 查询包含备份集的集群详情

更新时间:

查询某地域下包含备份集的PolarDB集群详情。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeDBClustersWithBackupsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ResourceGroupIdstring

资源组 ID。

rg-************
RegionIdstring

地域 ID。

说明 可通过接口 DescribeRegions 查看地域信息详情。
cn-hangzhou
DBClusterIdsstring

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

pc-**************
DBClusterDescriptionstring

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

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

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

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
IsDeletedinteger

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

  • 0:未删除
  • 1:已删除
0
PageSizeinteger

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

  • 30
  • 50
  • 100

默认值为 30。

30
PageNumberinteger

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

1
DBVersionstring

数据库引擎版本号。

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F8529AA2-522F-4B30-B80B-8F7D39******
PageNumberinteger

页数。

1
PageRecordCountinteger

本页集群数量。

1
TotalRecordCountinteger

总记录数。

1
Itemsobject []

集群详情。

DeletedTimestring

集群删除时间。

2022-05-12T03:25:37Z
VpcIdstring

专有网络 ID。

vpc-******************
ExpireTimestring

到期时间。

说明 仅付费方式为 Prepaid(包年包月)的集群会返回具体参数值,Postpaid(按量付费)集群则返回空值。
2022-09-14T16:00:00Z
Expiredstring

集群是否过期。

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

集群创建时间。

2022-05-09T09:33:51Z
DBNodeClassstring

节点规格。

polar.mysql.x4.medium
PayTypestring

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

  • Postpaid:按量付费。
  • Prepaid:预付费(包年包月)。
Postpaid
DBTypestring

数据库引擎类型。

MySQL
LockModestring

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

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

地域 ID。

cn-hangzhou
DeletionLockinteger

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

  • 0:未锁定,可删除集群。
  • 1:锁定,不可删除集群。
0
DBVersionstring

数据库引擎版本。

8.0
DBClusterIdstring

集群 ID。

pc-****************
DBClusterStatusstring

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

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

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

  • 1:已释放。
  • 0:未释放。
1
DBClusterNetworkTypestring

集群的网络类型。

VPC
DBClusterDescriptionstring

集群名称。

test
ZoneIdstring

可用区 ID。

cn-hangzhou-h
Enginestring

集群引擎。

POLARDB

示例

正常返回示例

JSON格式

{
  "RequestId": "F8529AA2-522F-4B30-B80B-8F7D39******",
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "Items": {
    "DBCluster": [
      {
        "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"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)