云数据库 veDB MySQL 版
云数据库 veDB MySQL 版
云数据库 veDB MySQL 版
文档指南
请输入
产品动态
用户指南
实例管理
备份与恢复
参数配置
任务中心
最佳实践
API 参考
v2（2024-01-01）
v1（2022-01-01）
实例管理
连接管理
数据库管理
账号管理
安全
备份恢复
参数管理
开发者工具
附录
相关协议
- 文档首页
云数据库 veDB MySQL 版API 参考v1（2022-01-01）备份恢复DescribeBackups - 获取备份列表
复制全文
下载 pdfDescribeBackups - 获取备份列表
文档反馈
问问助手调用 DescribeBackups 接口查询实例的备份文件列表。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 是 | vedbm-gzwdsf9b**** | 实例 ID。 说明 |
BackupType | String | 否 | Full | 备份类型，目前仅支持全量备份，取值为 Full。 |
BackupStartTime | String | 否 | 2023-07-14T18:43:00Z | 备份创建的最早时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间），以备份任务开始执行的时间为准。 |
BackupEndTime | String | 否 | 2023-07-16T18:52:31Z | 备份创建的最晚时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间），以备份任务开始执行的时间为准。 |
BackupStatus | String | 否 | Success | 备份状态，取值：
|
BackupMethod | String | 否 | Physical | 备份方式，目前仅支持物理备份，取值为 Physical。 |
PageNumber | Integer | 否 | 1 | 备份文件列表的页码，取值为不超过 Integer 数据类型的最大值，默认值为 1。 |
PageSize | Integer | 否 | 10 | 每页记录数。取值为 1~1000 间的整数，默认值为 10。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Integer | 2 | 备份文件总数。 |
BackupsInfo | 请参见返回示例。 | 备份列表。 |
BackupInfo
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
BackupId | String | snap-64b6****-7837 | 备份 ID。 |
BackupStatus | String | Success | 备份状态，取值：
|
CreateType | String | Physical | 创建类型，取值：
|
BackupMethod | String | Physical | 备份方式，目前仅支持物理备份，取值为 Physical。 |
BackupType | String | Full | 备份类型，目前仅支持全量备份，取值为 Full。 |
BackupFileSize | Long | 437 | 备份文件大小，单位为 KiB。 |
BackupStartTime | String | 2023-07-19T06:20:22Z | 备份的开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
BackupEndTime | String | 2023-07-19T06:31:28Z | 备份的结束时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
ConsistentTime | String | 2023-07-19T06:20:22Z | 一致性备份的时间点，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
示例
请求示例
POST /?Action=DescribeBackups&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host:vedbm.cn-beijing.volcengineapi.com
X-Date: 20220101T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/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
}
}
错误码
最近更新时间：2026.02.25 13:20:54
这个页面对您有帮助吗？
有用
有用
无用
无用