MyBase中的PolarDB列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。 |
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 |
| DescribeType |
string |
否 |
列表查询方式。取值为 Simple，表示简略模式，仅返回集群的基本元数据信息。 |
Simple |
| DBVersion |
string |
否 |
数据库版本。 |
5.6 |
| RecentCreationInterval |
integer |
否 |
筛选最近 N 天创建的集群。取值范围：0~15。 |
7 |
| RecentExpirationInterval |
integer |
否 |
筛选 N 天后过期的集群。取值范围：0~15。 |
6 |
| Expired |
string |
否 |
是否集群已过期。取值范围如下：
|
true |
| PageSize |
integer |
否 |
每页记录数，取值为 30、50 或 100。 默认值为 30。 |
30 |
| PageNumber |
integer |
否 |
页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。 |
10 |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-********** |
| Tag |
array<object> |
否 |
标签列表。 |
|
|
object |
否 |
|||
| Value |
string |
否 |
标签键对应的标签值。 |
5.6 |
| Key |
string |
否 |
标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。 |
MySQL |
| PayType |
string |
否 |
付费类型，取值范围如下：
|
Postpaid |
| DBNodeIds |
string |
否 |
节点 ID。支持传入多个节点 ID，多个 ID 间用英文逗号（,）分隔。 |
pi-*************** |
| CloudProvider |
string |
否 |
云厂商。 |
AlibabaCloud |
| MaxResults |
integer |
否 |
本次读取的最大数据量，默认值为 10。 |
10 |
| NextToken |
string |
否 |
查询凭证（token），取值为上一次 api 调用返回的 nexttoken 参数值。如果没有下一个查询，请不传。 |
212db86sca4384811e0b5e8707e****** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| TotalRecordCount |
integer |
总记录数。 |
16 |
| PageRecordCount |
integer |
本页集群数量。 |
5 |
| RequestId |
string |
请求 ID。 |
9B7BFB11-C077-4FE3-B051-F69CEB****** |
| PageNumber |
integer |
页数。 |
12 |
| Items |
array<object> |
集群列表。 |
|
|
object |
|||
| Category |
string |
集群系列，目前支持如下系列：
|
Normal |
| DBClusterId |
string |
集群 ID。 |
pc-**************** |
| DBType |
string |
数据库类型。 |
MySQL |
| CentralControlRegionId |
string |
中心管控。 |
cn-beijing |
| DBVersion |
string |
数据库版本。 |
5.6 |
| CloudProvider |
string |
云厂商。 |
ENS |
| Tags |
array<object> |
标签列表。 |
|
|
object |
|||
| Value |
string |
标签值。 |
5.6 |
| Key |
string |
标签键。 |
MySQL |
| StorageType |
string |
标准版存储类型取值如下：
|
essdautopl |
| ZoneId |
string |
可用区 ID。 |
cn-hangzhou-i |
| DBClusterStatus |
string |
集群状态。 |
Running |
| CreateTime |
string |
创建时间。 |
2020-08-14T05:58:42Z |
| DBClusterDescription |
string |
集群描述。 |
GDN-1 |
| Expired |
string |
集群是否到期。取值范围：
|
false |
| PayType |
string |
付费类型。取值范围：
|
Prepaid |
| LockMode |
string |
集群的锁定状态，取值范围如下：
|
Unlock |
| VswitchId |
string |
虚拟交换机 ID。 |
vsw-*************** |
| StrictConsistency |
string |
集群是否开启了多可用区数据强一致。取值范围：
|
ON |
| DBNodeClass |
string |
节点规格。 |
polar.mysql.g1.tiny.c |
| StorageUsed |
integer |
集群已经使用的存储用量，单位为 Byte。 |
3009413120 |
| ENSRegionId |
string |
ENS 地域 ID。 |
sg-singapore-9 |
| DBNodeNumber |
integer |
节点数量。 |
2 |
| VpcId |
string |
专有网络 ID。 |
vpc-**************** |
| StorageSpace |
integer |
实例的存储空间名称。 |
10 |
| ServerlessType |
string |
Serverless 类型。返回 AgileServerless 表示当前集群是 Serverless 集群，返回空值表示当前集群是普通集群。 |
AgileServerless |
| AiType |
string |
ai 节点信息状态。取值范围如下：
|
SearchNode |
| CpuCores |
string |
CPU 核数。单位：个。 |
1 |
| SubCategory |
string |
计算节点的规格类型，取值范围如下：
|
Exclusive |
| ExpireTime |
string |
集群到期时间。 说明
仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。 |
2022-09-14T16:00:00Z |
| MaxResults |
integer |
本次读取的最大数据量，默认值为 10。 |
10 |
| NextToken |
string |
查询凭证（token），取值为上一次 api 调用返回的 nexttoken 参数值。如果没有下一个查询，请不传。 |
212db86sca4384811e0b5e8707e****** |
示例
正常返回示例
JSON格式
{
"TotalRecordCount": 16,
"PageRecordCount": 5,
"RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
"PageNumber": 12,
"Items": [
{
"Category": "Normal",
"DBClusterId": "pc-****************",
"DBType": "MySQL",
"CentralControlRegionId": "cn-beijing",
"DBVersion": "5.6",
"CloudProvider": "ENS",
"Tags": [
{
"Value": "5.6",
"Key": "MySQL"
}
],
"StorageType": "essdautopl",
"ZoneId": "cn-hangzhou-i",
"DBClusterStatus": "Running",
"CreateTime": "2020-08-14T05:58:42Z",
"DBClusterDescription": "GDN-1",
"Expired": "false",
"PayType": "Prepaid",
"LockMode": "Unlock",
"VswitchId": "vsw-***************",
"StrictConsistency": "ON",
"DBNodeClass": "polar.mysql.g1.tiny.c",
"StorageUsed": 3009413120,
"ENSRegionId": "sg-singapore-9",
"DBNodeNumber": 2,
"VpcId": "vpc-****************",
"StorageSpace": 10,
"ServerlessType": "AgileServerless",
"AiType": "SearchNode",
"CpuCores": "1",
"SubCategory": "Exclusive",
"ExpireTime": "2022-09-14T16:00:00Z"
}
],
"MaxResults": 10,
"NextToken": "212db86sca4384811e0b5e8707e******"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。