DescribeSandboxBackupSets - 查询快照列表_数据管理 DMS-阿里云帮助中心

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeSandboxBackupSets

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID。说明若您的实例为 RDS MySQL，请通过自动添加数据源功能，将 RDS 自动添加至 DBS 中，即可获取备份计划 ID。	1hxxxx8xxxxxa
BackupSetId	string	否	备份集 ID。若您传入该参数，仅返回该备份集的快照信息；若不传入该参数，将返回该备份计划的所有快照信息。	1xxxx2xxxxx1e
PageSize	string	否	每页的记录数。取值如下： 30（默认） 50 100	30
PageNumber	string	否	页码，大于 0 且不超过 Integer 的最大值，默认值为 1。	1

返回参数

名称	类型	描述	示例值
	object
Data	string	参数说明： 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 },
RequestId	string	请求 ID。	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	错误码。	Param.NotFound
Success	string	是否请求成功。	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
Code	string	错误码。	Param.NotFound
Message	string	错误信息。	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	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

更多信息，参考变更详情。