You need to enable JavaScript to run this app.
导航
云数据库 SQL Server 版
  • 文档首页
    • /
  • 云数据库 SQL Server 版

DescribeBackups

最近更新时间：2023.10.13 11:25:46

首次发布时间：2023.04.24 11:01:04

我的收藏

调用 DescribeBackups 接口查看云数据库 SQL Server 版实例的备份集列表。

前提条件

调用 DownloadBackup 接口获取全量物理备份文件。

请求类型

同步请求。

请求参数

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

InstanceId

String

是

mssql-d59138f3****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

PageNumberInteger是1页码。取值需大于等于 1 。
PageSizeInteger是10每页记录数。取值范围 1~100。
BackupStartTimeString否2023-08-23T04:07:02.000Z查询开始时间。格式：yyyy-MM-ddTHH:mm:ss.sZ（UTC 时间）。

BackupEndTime

String

否

2023-08-23T04:06:49.000Z

查询结束时间。格式：yyyy-MM-ddTHH:mm:ss.sZ（UTC 时间）。

说明

查询结束时间需晚于查询开始时间。

BackupType

String

否

Full

备份类型。默认返回所有备份信息，取值如下：

  • Full：表示全量备份。

  • Diff：表示增量备份。

BackupId

String

否

ca155ac99fcb4eed86617041bfe0****

备份 ID。

说明

您可以调用 DescribeBackups 接口查询备份 ID。

返回参数

名称类型示例值描述
TotalInteger1备份总数。
BackupsInfoArray of BackupInfoObjectBackupInfoObject备份列表。

请求示例

POST /?Action=DescribeBackups&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****

{
    "InstanceId":"mssql-bbe31c86****",
    "PageNumber":2,
    "PageSize":2,
    "BackupStartTime":"2023-07-22T08:17:14.000Z",
    "BackupEndTime":"2023-08-28T08:17:14.000Z",
    "BackupType":"Full"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"202308251632083CF07BEFDEE44595C73B",
        "Action":"DescribeBackups",
        "Version":"2022-01-01",
        "Service":"rds_mssql",
        "Region":"cn-chongqing-sdv"
    },
    "Result":{
        "BackupsInfo":[
            {
                "BackupDatabaseDetail":[
                    {
                        "BackupEndTime":"2023-08-23T15:50:46.000Z",
                        "BackupFileName":"backup/mssql-1be522b55907/D/1692805800-tets9-D-f5a088501fab445d9debde68dc90****.bak",
                        "BackupFileSize":477868,
                        "BackupStartTime":"2023-08-23T15:50:46.000Z",
                        "BackupType":"Full",
                        "DatabaseName":"tets9",
                        "DownloadProgress":0,
                        "DownloadStatus":"Success",
                        "LinkExpiredTime":""
                    }
                ],
                "BackupEndTime":"2023-08-23T15:50:47.000Z",
                "BackupFileSize":13442833,
                "BackupId":"f5a088501fab445d9debde68dc90****",
                "BackupMethod":"Physical",
                "BackupStartTime":"2023-08-23T15:50:00.000Z",
                "BackupStatus":"Success",
                "BackupType":"Full",
                "CreateType":"System"
            }
        ],
        "Total":1
    }
}

错误码

更多详情，请参见错误码。