调用DescribeSandboxBackupSets接口,查询当前实例的快照列表。

执行该操作前,您需要先开启数据库实例的沙箱功能,详情请参见RDS MySQL应急恢复自建MySQL应急恢复(沙箱实例)

当前接口仅支持DBS API服务2021-01-01版本。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSandboxBackupSets

系统规定参数。取值:DescribeSandboxBackupSets

BackupPlanId String 1hxxxx8xxxxxa

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

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

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

PageSize String 30

每页的记录数。取值:

  • 30(默认)
  • 50
  • 100
PageNumber String 1

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

返回数据

名称 类型 示例值 描述
Code String Param.NotFound

错误码。

Data String "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 },

参数说明:

  • backupSetTime:快照时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
  • backupSetId:备份集ID。
  • backupSetType:快照类型,Full表示全量备份集快照、Inc表示增量备份快照。
  • backupPlanId:备份计划ID。
ErrCode String Param.NotFound

错误码。

ErrMessage String The specified parameter %s value is not valid.

错误信息。

Message String The specified parameter %s value is not valid.

错误信息。

RequestId String 4F1888AC-1138-4995-B9FE-D2734F61C058

请求ID。

Success String true

是否请求成功。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeSandboxBackupSets
&<公共请求参数>

正常返回示例

XML格式

<RequestId>3A6295D0-93C3-1FA4-8D5C-97B05379F519</RequestId>
<Data>
    <number>2</number>
    <size>2</size>
    <content>
        <backupSetTime>2021-08-28T23:12:31Z</backupSetTime>
        <backupSetId>Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134</backupSetId>
        <backupSetType>Inc</backupSetType>
        <backupPlanId>1hxxxx8xxxxxa</backupPlanId>
    </content>
    <content>
        <backupSetTime>2021-08-28T22:42:28Z</backupSetTime>
        <backupSetId>1hxxxx8xxxxxa_20210829064228</backupSetId>
        <backupSetType>FULL</backupSetType>
        <backupPlanId>1hxxxx8xxxxxa</backupPlanId>
    </content>
    <totalElements>2</totalElements>
</Data>
<Code>Success</Code>
<Success>true</Success>
<ErrCode>Success</ErrCode>

JSON格式

{
    "RequestId": "3A6295D0-93C3-1FA4-8D5C-97B05379F519",
    "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
    },
    "Code": "Success",
    "Success": true,
    "ErrCode": "Success"
}

错误码

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