DescribeDBClusters - 查询集群列表 - 云原生数据库 PolarDB

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeDBClusters	list	DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。说明您可以通过接口 DescribeRegions 查看可用的地域。	cn-hangzhou
DBClusterIds	string	否	集群 ID。多个集群 ID 间用英文逗号（,）隔开。	pc-****************
DBClusterDescription	string	否	集群描述，可模糊查询。	pc-****************
ConnectionString	string	否	数据库连接地址。	********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatus	string	否	集群状态，取值范围请参见集群状态表。	Running
DBType	string	否	数据库类型，取值范围如下： MySQL PostgreSQL Oracle	MySQL
DescribeType	string	否	列表查询方式。取值为 Simple，表示简略模式，仅返回集群的基本元数据信息。说明如果未填写该参数，则默认为详细模式，返回集群的详细信息。	Simple
DBVersion	string	否	数据库版本。	5.6
RecentCreationInterval	integer	否	筛选最近 N 天创建的集群。取值范围：0~15。	7
RecentExpirationInterval	integer	否	筛选 N 天后过期的集群。取值范围：0~15。	6
Expired	boolean	否	是否集群已过期。取值范围如下： true false	true
PageSize	integer	否	每页记录数，取值为 30、50 或 100。默认值为 30。	30
PageNumber	integer	否	页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	10
ResourceGroupId	string	否	资源组 ID。	rg-**********
Tag	array<object>	否	标签列表。
	object	否
Key	string	否	标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。说明最多支持 64 个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。	MySQL
Value	string	否	标签键对应的标签值。说明最多支持 64 个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。	5.6
PayType	string	否	付费类型，取值范围如下： Postpaid：按量付费 Prepaid：预付费（包年包月）	Postpaid
DBNodeIds	string	否	节点 ID。支持传入多个节点 ID，多个 ID 间用英文逗号（,）分隔。	pi-***************

返回参数

名称	类型	描述	示例值
	object
TotalRecordCount	integer	总记录数。	16
PageRecordCount	integer	本页集群数量。	5
RequestId	string	请求 ID。	9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumber	integer	页数。	12
Items	array<object>	集群列表。
DBCluster	object
VpcId	string	专有网络 ID。	vpc-****************
VswitchId	string	虚拟交换机 ID。	vsw-***************
ExpireTime	string	集群到期时间。说明仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。	2020-11-14T16:00:00Z
Expired	string	集群是否到期。取值范围： true false 说明仅付费方式为 Prepaid（包年包月）的集群支持返该参数。	false
DBNodeNumber	integer	节点数量。	2
CreateTime	string	创建时间。	2020-08-14T05:58:42Z
PayType	string	付费类型。取值范围： Postpaid：按量付费。 Prepaid：包年包月（预付费）。	Prepaid
StoragePayType	string	存储计费类型。取值范围： Postpaid：按容量计费（按量计费）。 Prepaid：按空间计费（包年包月）。	Prepaid
ServerlessType	string	Serverless 类型。返回 AgileServerless 表示当前集群是 Serverless 集群，返回空值表示当前集群是普通集群。	AgileServerless
StrictConsistency	string	集群是否开启了多可用区数据强一致。取值范围： ON：表示开启了多可用区数据强一致，适用于标准版 3AZ 场景。 OFF：表示未开启多可用区数据强一致。	ON
DBNodeClass	string	节点规格。	polar.mysql.x4.large
Tags	array<object>	标签列表。
Tag	object
Key	string	标签键。	MySQL
Value	string	标签值。	5.6
DBType	string	数据库类型。	MySQL
LockMode	string	集群的锁定状态，取值范围如下： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。	Unlock
DBNodes	array<object>	节点列表。
DBNode	object
DBNodeClass	string	节点规格。	polar.mysql.x4.large
ZoneId	string	可用区 ID。	cn-hangzhou-i
DBNodeRole	string	节点角色，取值范围如下： Writer：主节点。 Reader：只读节点。 ColumnReader：列存只读节点。 AI：AI 节点。	Reader
DBNodeId	string	节点 ID。	pi-****************
RegionId	string	地域 ID。	cn-hangzhou
Serverless	string	当前节点是否开启了 Serverless 功能。返回 ON 表示开启了 Serverless 功能。返回空值表示没有开启 Serverless 功能。	ON
ImciSwitch	string	是否开启列存索引。取值范围如下： ON：开启 OFF：关闭	OFF
HotReplicaMode	string	是否开启热备。取值范围如下： ON：开启 OFF：关闭	OFF
RegionId	string	地域 ID。	cn-hangzhou
DeletionLock	integer	集群删除的保护状态，取值范围如下： 0：未锁定。 1：锁定。说明锁定状态时，不可以删除集群。	0
DBVersion	string	数据库版本。	5.6
DBClusterId	string	集群 ID。	pc-****************
DBClusterStatus	string	集群状态。	Running
ResourceGroupId	string	资源组 ID。	rg-************
StorageUsed	long	集群已经使用的存储用量，单位为 Byte。	3009413120
StorageSpace	long	按空间计费（包年包月）的存储空间。单位：Byte。	50
DBClusterNetworkType	string	集群的网络类型。	VPC
DBClusterDescription	string	集群描述。	GDN-1
ZoneId	string	可用区 ID。	cn-hangzhou-i
Engine	string	集群引擎。	POLARDB
Category	string	集群系列，目前支持如下系列： Normal：集群版 Basic：单节点 Archive：高压缩引擎（X-Engine） NormalMultimaster：多主集群（库表）	Normal
AiType	string	ai 节点信息状态。取值范围如下： SearchNode：搜索节点 DLNode：ai 节点枚举值： SearchNode\|DLNode：Both。 DLNode：DLNode。 SearchNode：SearchNode。	SearchNode
CpuCores	string	CPU 核数。单位：个。	1
MemorySize	string	节点内存大小，单位：MB。	2048
RemoteMemorySize	string	远端内存大小，单位：MB。	3612
SubCategory	string	计算节点的规格类型，取值范围如下： Exclusive：独享规格 General：通用规格	Exclusive
StorageType	string	企业版存储类型取值如下： HighPerformance：对应 PSL5 Standard：对应 PSL4 标准版存储类型取值如下： essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
HotStandbyCluster	string	存储热备集群。取值范围如下： ON：开启 OFF：关闭	OFF

示例

正常返回示例

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",
        "CpuCores": "1",
        "MemorySize": "2048",
        "RemoteMemorySize": "3612",
        "SubCategory": "Exclusive",
        "StorageType": "essdautopl",
        "HotStandbyCluster": "OFF"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-07-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-06-25	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-12-26	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-09-12	OpenAPI 错误码发生变更	查看变更详情
2023-08-09	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2023-07-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-06-20	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-11	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-31	OpenAPI 错误码发生变更	查看变更详情
2022-09-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-09-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-06-02	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情