DescribeDBClusters_云数据库 PolarDB_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求参数

字段名称字段详情
RegionIdstring

地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
DBClusterIdsstring

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

示例值:pc-****************参考取值来源:
    ModifyDBCluster
    CreateDBCluster
    DescribeDBClusterTDE
    TransformDBClusterPayType
    EnableDBClusterServerless
    DisableDBClusterServerless
    RestartDBLink
DBClusterDescriptionstring

集群描述,可模糊查询。

示例值:pc-****************
ConnectionStringstring

数据库连接地址。

示例值:********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatusstring

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

示例值:Running
DBTypestring

数据库类型,取值范围如下:展开详情

示例值:MySQL
DescribeTypestring

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

示例值:Simple
DBVersionstring

数据库版本。

示例值:5.6参考取值来源:
    DescribeDBClusterVersion
    CreateDBCluster
RecentCreationIntervalinteger<int32>

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

示例值:7
RecentExpirationIntervalinteger<int32>

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

示例值:6
Expiredboolean

是否集群已过期。取值范围如下:展开详情

示例值:true
PageSizeinteger<int32>

每页记录数,取值为 3050100展开详情

示例值:30
PageNumberinteger<int32>

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

示例值:10
ResourceGroupIdstring

资源组 ID。

示例值:rg-**********
Tagarray<object>

标签列表。

子级条数 <= 21
PayTypestring

付费类型,取值范围如下: 展开详情

示例值:Postpaid
DBNodeIdsstring

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

示例值:pi-***************参考取值来源:
    CreateDBNodes
    TempModifyDBNode
    DescribeDBNodePerformance

返回参数

字段名称字段详情
TotalRecordCountinteger<int32>

总记录数。

示例值:16
PageRecordCountinteger<int32>

本页集群数量。

示例值:5
RequestIdstring

请求 ID。

示例值:9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumberinteger<int32>

页数。

示例值:12
Itemsobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidRegionId.Malformed
The specified parameter RegionId is not valid.诊断
400
NumberExceed.Tags
The Tags parameter's number is exceed.诊断
400
InvalidPageSize.Malformed
The specified parameter PageSize is not valid.诊断
400
InvalidPageNumber.Malformed
The specified parameter PageNumber is not valid.诊断
400
InvalidRecentCreationInterval.Malformed
The specified parameter RecentCreationInterval is not valid.诊断
400
InvalidRecentExpirationInterval.Malformed
The specified parameter RecentExpirationInterval is not valid.诊断
404
DBTypeOrDBVersion.Malformed
The specified DBType does not match 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
变更返回参数
2024-06-25
变更返回参数