全部产品
Search
文档中心

数据库备份 DBS:DescribeSandboxBackupSets - 查询快照列表

更新时间:May 23, 2024

查询当前实例的快照列表。

接口说明

执行该操作前,您需要先开启数据库实例的沙箱功能,详情请参见RDS MySQL 应急恢复自建 MySQL 应急恢复(沙箱实例)。 当前接口仅支持 DBS API 服务 2021-01-01 版本。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
BackupPlanIdstring

备份计划 ID,您可以通过 DescribeBackupPlanList 接口获取该参数。

说明 若您的实例为 RDS MySQL,请通过自动添加数据源功能,将 RDS 自动添加至 DBS 中,即可获取备份计划 ID。
1hxxxx8xxxxxa
BackupSetIdstring

备份集 ID。若您传入该参数,仅返回该备份集的快照信息;若不传入该参数,将返回该备份计划的所有快照信息。

1xxxx2xxxxx1e
PageSizestring

每页的记录数。取值如下:

  • 30(默认)
  • 50
  • 100
30
PageNumberstring

页码,大于 0 且不超过 Integer 的最大值,默认值为 1。

1

返回参数

名称类型描述示例值
object
Datastring

参数说明:

  • backupSetTime:快照时间点,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
  • backupSetId:备份集 ID。
  • backupSetType:快照类型,Full 表示全量备份集快照、Inc 表示增量备份快照。
  • backupPlanId:备份计划 ID。
"Data": { "number": 2, "size": 2, "content": [ { "backupSetTime": "2021-08-28T23:12:31Z", "backupSetId": "Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134", "backupSetType": "Inc", "backupPlanId": "1hxxxx8xxxxxa" }, { "backupSetTime": "2021-08-28T22:42:28Z", "backupSetId": "1hxxxx8xxxxxa_20210829064228", "backupSetType": "FULL", "backupPlanId": "1hxxxx8xxxxxa" } ], "totalElements": 2 },
RequestIdstring

请求 ID。

4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCodestring

错误码。

Param.NotFound
Successstring

是否请求成功。

true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
Codestring

错误码。

Param.NotFound
Messagestring

错误信息。

The specified parameter %s value is not valid.

示例

正常返回示例

JSON格式

{
  "Data": "  \"Data\": {     \"number\": 2,     \"size\": 2,     \"content\": [       {         \"backupSetTime\": \"2021-08-28T23:12:31Z\",         \"backupSetId\": \"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\",         \"backupSetType\": \"Inc\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       },       {         \"backupSetTime\": \"2021-08-28T22:42:28Z\",         \"backupSetId\": \"1hxxxx8xxxxxa_20210829064228\",         \"backupSetType\": \"FULL\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       }     ],     \"totalElements\": 2   },",
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Param.NotFound",
  "Message": "The specified parameter %s value is not valid."
}

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史