首页 >数据库备份 DBS >API参考(2021-01-01) >API目录 >沙箱快照 >DescribeSandboxBackupSets - 查询快照列表

DescribeSandboxBackupSets - 查询快照列表

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

接口说明

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

调试

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

调试

授权信息

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

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

    请求参数

    名称类型必填描述示例值
    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.

    示例

    请求示例

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

    正常返回示例

    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"
    }

    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>

    错误码

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

    阿里云首页 数据库备份 DBS 相关技术圈