查询共享备份集列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 说明
您可以调用 DescribeRegions 接口查看目标账号下的可用地域信息，包括地域 ID。 |
cn-hangzhou |
| DBClusterId |
string |
否 |
集群 ID。 |
pc-************** |
| BackupId |
string |
否 |
备份集 ID。 |
111111111 |
| ShareType |
string |
是 |
共享类型：
|
ShareIncoming |
| PageSize |
integer |
否 |
每页记录数，取值范围：30 ~ 100，默认值为 30。 |
30 |
| PageNumber |
integer |
否 |
取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。 |
1 |
| DBType |
string |
否 |
数据库类型，取值范围如下：
多个类型间用英文逗号隔开。 |
MySQL,PostgreSQL,Oracle |
| DBVersion |
string |
否 |
数据库版本。 |
8.0 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| TotalRecordCount |
string |
总记录数 |
16 |
| PageRecordCount |
string |
本页记录数。 |
1 |
| RequestId |
string |
请求 ID。 |
3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF |
| PageNumber |
string |
页码。 |
1 |
| Items |
array<object> |
共享备份集列表。 |
|
|
object |
共享备份集基本信息。 |
||
| BackupSetSize |
string |
备份文件大小，单位为 Byte。 |
4639948800 |
| ConsistentTime |
string |
一致性快照的时间点，格式为 Unix 时间戳，单位为秒。 |
1589253947 |
| BackupStatus |
string |
备份状态，取值范围如下：
|
Success |
| BackupType |
string |
备份类型，仅支持全量备份，取值固定为 FullBackup。 |
FullBackup |
| BackupStartTime |
string |
本次备份开始时间（UTC 时间）。 |
2020-11-15T07:30:05Z |
| BackupEndTime |
string |
本次备份结束时间（UTC 时间）。 |
2020-05-12T03:25:55Z |
| BackupId |
string |
备份集 ID。 |
111111111 |
| DBClusterId |
string |
集群 ID。 |
pc-**************** |
| BackupsLevel |
string |
备份集级别，取值范围如下：
|
Level-2 |
| BackupMode |
string |
备份模式，取值范围如下：
|
Manual |
| BackupMethod |
string |
数据备份方法，仅支持快照备份，取值固定为 Snapshot 。 |
Snapshot |
| DBType |
string |
数据库引擎类型。 |
MySQL |
| DBVersion |
string |
数据库引擎版本。 |
5.6 |
| ShareType |
string |
共享类型。 |
ShareIncoming |
| PayType |
string |
付费类型，取值范围如下：
|
Postpaid |
| ServerlessType |
string |
Serverless 类型。返回 AgileServerless 表示当前集群是 Serverless 集群，返回空值表示当前集群是普通集群。 |
AgileServerless |
| RegionId |
string |
地域 ID。 |
cn-hongzhou |
| SharerUID |
string |
共享方 UID。 |
170************* |
示例
正常返回示例
JSON格式
{
"TotalRecordCount": "16",
"PageRecordCount": "1",
"RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
"PageNumber": "1",
"Items": [
{
"BackupSetSize": "4639948800",
"ConsistentTime": "1589253947",
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2020-11-15T07:30:05Z",
"BackupEndTime": "2020-05-12T03:25:55Z",
"BackupId": "111111111",
"DBClusterId": "pc-****************",
"BackupsLevel": "Level-2",
"BackupMode": "Manual",
"BackupMethod": "Snapshot",
"DBType": "MySQL",
"DBVersion": "5.6",
"ShareType": "ShareIncoming",
"PayType": "Postpaid",
"ServerlessType": "AgileServerless",
"RegionId": "cn-hongzhou",
"SharerUID": "170*************"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。