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

DescribeBackups

最近更新时间：2024.01.29 21:27:47

首次发布时间：2023.02.02 17:41:21

我的收藏

调用 DescribeBackups 接口查询数据备份列表。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是mysql-603e30e6****实例 ID。
BackupIdString否06797d5eff774e339d6cbbefa2aa****备份 ID。
BackupStartTimeString否2022-01-01T10:10:10.000Z备份创建最早时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
BackupEndTimeString否2022-01-01T20:10:10.000Z备份创建最晚时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。

BackupStatus

String

否

Success

备份状态，取值：

  • Success：成功。
  • Failed：失败。
  • Running：执行中。

BackupType

String

否

Full

备份类型，取值：

  • Full：全量备份。
  • Increment：增量备份。
BackupMethodString否Physical备份方式，取值为 Physical，物理备份。
PageNumberInteger否1当前页页码。取值最小为 1。默认值为 1。
PageSizeInteger否10每页记录数。最小值为 1，最大值不超过 100。默认值为 10。

返回参数

名称类型示例值描述
TotalInteger1备份总数。
BackupsArray of BackupObject无备份列表。 更多关于 Backups 的详细信息，请参见数据结构。

请求示例

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

{
    "InstanceId": "mysql-ce48081d****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231226142201826E4152B1FF93D81901",
        "Action": "DescribeBackups",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Backups": [
            {
                "BackupEndTime": "2023-12-26T06:24:45.000Z",
                "BackupFileName": "full-1703571882639001332.xbstream",
                "BackupFileSize": 221218861,
                "BackupId": "fd04a8e0e6cd41da8f23730e6ff3****",
                "BackupMethod": "Physical",
                "BackupRegion": "cn-beijing",
                "BackupStartTime": "2023-12-26T06:24:43.000Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "ConsistentTime": "",
                "CreateType": "User",
                "DownloadStatus": "NotDownload",
                "ExpiredTime": "2024-01-02T06:24:45.000Z",
                "IsExpired": false
            },
            {
                "BackupEndTime": "2023-12-26T00:41:03.000Z",
                "BackupFileName": "full-1703551260270171199.xbstream",
                "BackupFileSize": 198489484,
                "BackupId": "887ac194eec5430b9b4b07f44966****",
                "BackupMethod": "Physical",
                "BackupRegion": "cn-beijing",
                "BackupStartTime": "2023-12-26T00:41:00.000Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "ConsistentTime": "",
                "CreateType": "System",
                "DownloadStatus": "NotDownload",
                "ExpiredTime": "2024-01-02T00:41:03.000Z",
                "IsExpired": false
            },
            {
                "BackupEndTime": "2023-12-24T00:41:03.000Z",
                "BackupFileName": "full-1703378460098773115.xbstream",
                "BackupFileSize": 372418162,
                "BackupId": "36d87e38c74246c8be36ea20a66c****",
                "BackupMethod": "Physical",
                "BackupRegion": "cn-beijing",
                "BackupStartTime": "2023-12-24T00:41:00.000Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "ConsistentTime": "",
                "CreateType": "System",
                "DownloadStatus": "NotDownload",
                "ExpiredTime": "2023-12-31T00:41:03.000Z",
                "IsExpired": false
            },
            {
                "BackupEndTime": "2023-12-22T00:41:02.000Z",
                "BackupFileName": "full-1703205660114810201.xbstream",
                "BackupFileSize": 182090528,
                "BackupId": "7d44cd3202744b3aa00a481e0b0a****",
                "BackupMethod": "Physical",
                "BackupRegion": "cn-beijing",
                "BackupStartTime": "2023-12-22T00:41:00.000Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "ConsistentTime": "",
                "CreateType": "System",
                "DownloadStatus": "NotDownload",
                "ExpiredTime": "2023-12-29T00:41:02.000Z",
                "IsExpired": false
            },
            {
                "BackupEndTime": "2023-12-21T03:13:56.000Z",
                "BackupFileName": "full-1703128433895532284.xbstream",
                "BackupFileSize": 97207528,
                "BackupId": "e1efe0ff9aba4231910f710055e1****",
                "BackupMethod": "Physical",
                "BackupRegion": "cn-beijing",
                "BackupStartTime": "2023-12-21T03:13:54.000Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "ConsistentTime": "",
                "CreateType": "System",
                "DownloadStatus": "NotDownload",
                "ExpiredTime": "2023-12-28T03:13:56.000Z",
                "IsExpired": false
            }
        ],
        "Total": 5
    }
}

错误码

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