You need to enable JavaScript to run this app.
导航
DescribeBackups
最近更新时间:2024.06.13 14:27:24首次发布时间:2022.04.12 19:05:15

调用 DescribeBackups 接口查询指定 veDB MySQL 实例的备份文件列表信息。

请求类型

同步请求。

请求参数

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

InstanceId

String

vedbm-gzwdsf9b****

实例 ID。

说明

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

BackupIdStringsnap-a3a9****-8b96备份 ID。
BackupStartTimeString2023-07-14T18:43:00Z备份创建的最早时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间),以备份任务开始执行的时间为准。
BackupEndTimeString2023-07-16T18:52:31Z备份创建的最晚时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间),以备份任务开始执行的时间为准。

BackupStatus

String

Success

备份状态,取值:

  • Success:成功。
  • Failed:失败。
  • Running:执行中。
BackupMethodStringPhysical备份方式,目前仅支持物理备份,取值为 Physical
PageNumberInteger1备份文件列表的页码,取值为不超过 Integer 数据类型的最大值,默认值为 1。
PageSizeInteger10每页记录数。取值为 1~1000 间的整数,默认值为 10。

返回参数

名称类型示例值描述
TotalInteger2备份文件总数。
BackupsArray of BackupObject请参见返回示例备份列表。关于 Backups 的详细信息,请参见 BackupObject

请求示例

POST /?Action=DescribeBackups&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220614/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
        "InstanceId": "vedbm-gzwdsf9b****",
        "PageSize": 10,
        "PageNumber": 1
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230719142514583A11C78B08A3A0AEB6",
        "Action": "DescribeBackups",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupsInfo": [
            {
                "BackupEndTime": "2023-07-18T19:21:28Z",
                "BackupFileSize": 437,
                "BackupId": "snap-64b6****-7837",
                "BackupMethod": "Physical",
                "BackupStartTime": "2023-07-18T19:14:00Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "ConsistentTime": "2023-07-18T19:14:00Z",
                "CreateType": "System"
            },
            {
                "BackupEndTime": "",
                "BackupFileSize": 0,
                "BackupId": "snap-64b7****-6144",
                "BackupMethod": "Physical",
                "BackupStartTime": "2023-07-19T06:20:22Z",
                "BackupStatus": "Running",
                "BackupType": "Full",
                "ConsistentTime": "2023-07-19T06:20:22Z",
                "CreateType": "User"
            }
        ],
        "Total": 2
    }
}

错误码

更多详情,请参见错误码