查询某地域下包含备份集的PolarDB集群详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardb:DescribeDBClustersWithBackups |
get |
*DBCluster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-************ |
| RegionId |
string |
是 |
地域 ID。 说明
可通过接口 DescribeRegions 查看地域信息详情。 |
cn-hangzhou |
| DBClusterIds |
string |
否 |
集群 ID，支持传入多个集群 ID，集群 ID 之间用英文逗号（,）分隔。 |
pc-************** |
| DBClusterDescription |
string |
否 |
集群名称，集群名称需满足如下要求：
|
test |
| DBType |
string |
否 |
数据库引擎类型，取值范围如下：
|
MySQL |
| IsDeleted |
integer |
否 |
集群是否已删除，取值范围如下：
|
0 |
| PageSize |
integer |
否 |
每页记录数，取值范围如下：
默认值为 30。 |
30 |
| PageNumber |
integer |
否 |
页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。 |
1 |
| DBVersion |
string |
否 |
数据库引擎版本号。
|
8.0 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
F8529AA2-522F-4B30-B80B-8F7D39****** |
| PageNumber |
integer |
页数。 |
1 |
| PageRecordCount |
integer |
本页集群数量。 |
1 |
| TotalRecordCount |
integer |
总记录数。 |
1 |
| Items |
object |
||
| DBCluster |
array<object> |
集群详情。 |
|
|
object |
|||
| DeletedTime |
string |
集群删除时间。 |
2022-05-12T03:25:37Z |
| VpcId |
string |
专有网络 ID。 |
vpc-****************** |
| ExpireTime |
string |
到期时间。 说明
仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。 |
2022-09-14T16:00:00Z |
| Expired |
string |
集群是否过期。 说明
仅付费方式为 Prepaid（包年包月）的集群支持返该参数。 |
false |
| CreateTime |
string |
集群创建时间。 |
2022-05-09T09:33:51Z |
| DBNodeClass |
string |
节点规格。 |
polar.mysql.x4.medium |
| PayType |
string |
付费类型，取值范围如下：
|
Postpaid |
| DBType |
string |
数据库引擎类型。 |
MySQL |
| LockMode |
string |
集群的锁定状态，取值范围如下：
|
Unlock |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| DeletionLock |
integer |
集群删除的锁定状态，取值范围如下：
|
0 |
| DBVersion |
string |
数据库引擎版本。 |
8.0 |
| DBClusterId |
string |
集群 ID。 |
pc-**************** |
| DBClusterStatus |
string |
集群状态，取值范围如下：
|
Running |
| IsDeleted |
integer |
集群是否已释放，取值范围如下：
|
1 |
| DBClusterNetworkType |
string |
集群的网络类型。 |
VPC |
| DBClusterDescription |
string |
集群名称。 |
test |
| ZoneId |
string |
可用区 ID。 |
cn-hangzhou-h |
| Engine |
string |
集群引擎。 |
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidRegionId.Malformed | The specified parameter RegionId is not valid. | 指定的参数RegionId无效 |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | 指定的参数PageSize无效 |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | 指定的参数PageNumber无效 |
| 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. | 由于服务器临时故障，请求失败。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。