文档

DescribeDBClusters - 查询集群列表

更新时间:

查询PolarDB集群列表或被RAM授权的集群列表详情。

调试

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

调试

授权信息

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

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

请求参数

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

地域 ID。

说明 您可以通过接口 DescribeRegions 查看可用的地域。
cn-hangzhou
DBClusterIdsstring

集群 ID。多个集群 ID 间用英文逗号(,)隔开。

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

集群描述,可模糊查询。

pc-****************
ConnectionStringstring

数据库连接地址。

********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatusstring

集群状态,取值范围请参见集群状态表

Running
DBTypestring

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

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
DescribeTypestring

列表查询方式。取值为 Simple,表示简略模式,仅返回集群的基本元数据信息。

说明 如果未填写该参数,则默认为详细模式,返回集群的详细信息。
Simple
DBVersionstring

数据库版本。

5.6
RecentCreationIntervalinteger

筛选最近 N 天创建的集群。取值范围:0~15。

7
RecentExpirationIntervalinteger

筛选 N 天后过期的集群。取值范围:0~15。

6
Expiredboolean

是否集群已过期。取值范围如下:

  • true

  • false

true
PageSizeinteger

每页记录数,取值为 3050100

默认值为 30

30
PageNumberinteger

页码,取值为大于 0 且不超过 Integer 数据类型的最大值,默认值为 1

10
ResourceGroupIdstring

资源组 ID。

rg-**********
Tagobject []

标签列表。

Keystring

标签键,可以根据标签过滤集群列表。最多 20 对标签,各个标签对的数字 n 必须不同,且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。

说明 最多支持 64 个字符,不能以aliyunacs:http://或者https://开头。
MySQL
Valuestring

标签键对应的标签值。

说明 最多支持 64 个字符,不能以aliyunacs:http://或者https://开头。
5.6
PayTypestring

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

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

节点 ID。支持传入多个节点 ID,多个 ID 间用英文逗号(,)分隔。

pi-***************

返回参数

名称类型描述示例值
object
TotalRecordCountinteger

总记录数。

16
PageRecordCountinteger

本页集群数量。

5
RequestIdstring

请求 ID。

9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumberinteger

页数。

12
Itemsobject []

集群列表。

VpcIdstring

专有网络 ID。

vpc-****************
VswitchIdstring

虚拟交换机 ID。

vsw-***************
ExpireTimestring

集群到期时间。

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

集群是否到期。取值范围:

  • true

  • false

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

节点数量。

2
CreateTimestring

创建时间。

2020-08-14T05:58:42Z
PayTypestring

付费类型。取值范围:

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

存储计费类型。取值范围:

  • Postpaid:按容量计费(按量计费)。
  • Prepaid:按空间计费(包年包月)。
Prepaid
ServerlessTypestring

Serverless 类型。返回 AgileServerless 表示当前集群是 Serverless 集群,返回空值表示当前集群是普通集群。

AgileServerless
StrictConsistencystring

集群是否开启了多可用区数据强一致。取值范围:

  • ON:表示开启了多可用区数据强一致,适用于标准版 3AZ 场景。

  • OFF:表示未开启多可用区数据强一致。

ON
DBNodeClassstring

节点规格。

polar.mysql.x4.large
Tagsobject []

标签列表。

Keystring

标签键。

MySQL
Valuestring

标签值。

5.6
DBTypestring

数据库类型。

MySQL
LockModestring

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

  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:集群过期自动锁定。
Unlock
DBNodesobject []

节点列表。

DBNodeClassstring

节点规格。

polar.mysql.x4.large
ZoneIdstring

可用区 ID。

cn-hangzhou-i
DBNodeRolestring

节点角色,取值范围如下:

  • Writer:主节点。
  • Reader:只读节点。
Reader
DBNodeIdstring

节点 ID。

pi-****************
RegionIdstring

地域 ID。

cn-hangzhou
Serverlessstring

当前节点是否开启了 Serverless 功能。

  • 返回 ON 表示开启了 Serverless 功能。
  • 返回空值表示没有开启 Serverless 功能。
ON
ImciSwitchstring

是否开启列存索引。取值范围如下:

  • ON:开启
  • OFF:关闭
OFF
HotReplicaModestring

是否开启热备。取值范围如下:

  • ON:开启
  • OFF:关闭
OFF
RegionIdstring

地域 ID。

cn-hangzhou
DeletionLockinteger

集群删除的保护状态,取值范围如下:

  • 0:未锁定。
  • 1:锁定。
说明 锁定状态时,不可以删除集群。
0
DBVersionstring

数据库版本。

5.6
DBClusterIdstring

集群 ID。

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

集群状态。

Running
ResourceGroupIdstring

资源组 ID。

rg-************
StorageUsedlong

集群已经使用的存储用量,单位为 Byte。

3009413120
StorageSpacelong

按空间计费(包年包月)的存储空间。单位:Byte。

50
DBClusterNetworkTypestring

集群的网络类型。

VPC
DBClusterDescriptionstring

集群描述。

GDN-1
ZoneIdstring

可用区 ID。

cn-hangzhou-i
Enginestring

集群引擎。

POLARDB
Categorystring

集群系列,目前支持如下系列:

  • Normal:集群版

  • Basic:单节点

  • Archive:高压缩引擎(X-Engine)

  • NormalMultimaster:多主集群(库表)

Normal
AiTypestring

ai 节点信息状态。取值范围如下:

  • SearchNode:搜索节点
  • DLNode:ai 节点
枚举值:
  • SearchNode|DLNodeBoth
  • DLNodeDLNode
  • SearchNodeSearchNode
SearchNode

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": {
    "DBCluster": [
      {
        "VpcId": "vpc-****************",
        "VswitchId": "vsw-***************",
        "ExpireTime": "2020-11-14T16:00:00Z",
        "Expired": "false",
        "DBNodeNumber": 2,
        "CreateTime": "2020-08-14T05:58:42Z",
        "PayType": "Prepaid",
        "StoragePayType": "Prepaid",
        "ServerlessType": "AgileServerless",
        "StrictConsistency": "ON",
        "DBNodeClass": "polar.mysql.x4.large",
        "Tags": {
          "Tag": [
            {
              "Key": "MySQL",
              "Value": "5.6"
            }
          ]
        },
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "DBNodes": {
          "DBNode": [
            {
              "DBNodeClass": "polar.mysql.x4.large",
              "ZoneId": "cn-hangzhou-i",
              "DBNodeRole": "Reader",
              "DBNodeId": "pi-****************",
              "RegionId": "cn-hangzhou",
              "Serverless": "ON",
              "ImciSwitch": "OFF",
              "HotReplicaMode": "OFF"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "5.6",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-************",
        "StorageUsed": 3009413120,
        "StorageSpace": 50,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "GDN-1",
        "ZoneId": "cn-hangzhou-i",
        "Engine": "POLARDB",
        "Category": "Normal",
        "AiType": "SearchNode"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegionId.MalformedThe specified parameter RegionId is not valid.指定的参数RegionId无效
400NumberExceed.TagsThe Tags parameter's number is exceed.tags参数的数目超过。
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.指定的参数PageSize无效
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.指定的参数PageNumber无效
400InvalidRecentCreationInterval.MalformedThe specified parameter RecentCreationInterval is not valid.指定的参数RecentCreationInterval无效。
400InvalidRecentExpirationInterval.MalformedThe specified parameter RecentExpirationInterval is not valid.指定的参数RecentExpirationInterval无效。
404DBTypeOrDBVersion.MalformedThe specified DBType does not match DBVersion.指定的DBType与DBVersion不匹配。
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.由于服务器临时故障,请求失败。

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

变更历史

变更时间变更内容概要操作
2023-12-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:DescribeType
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:500
    删除错误码:503
    新增错误码:404
2023-08-09OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
2023-07-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
2023-06-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
2023-04-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
2023-04-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
2023-03-31OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
2022-09-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
2022-09-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
2022-06-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈