查询云备份快照
更新时间 2026-04-02 15:48:16
最近更新时间: 2026-04-02 15:48:16
接口功能介绍
通过接口查询备份
接口约束
无
URI
GET /v4/backup/query-backup-snapshot
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 41f64827f25f468595ffa3a5deb5d15d | |
| backupPolicyName | 否 | String | 备份计划名字模糊匹配--查询参数权重同级 | backup-6d3f-test | |
| backupPolicyID | 否 | String | 备份计划ID--查询参数权重同级 | 04c77f57-9f2d-4fa2-9858-0c72986eefe0 | |
| backupSrcInstanceID | 否 | String | 主机 ID--查询参数权重同级 | 15743497-eb28-2d7d-b1f2-53851c0ee893 | |
| backupStorageID | 否 | String | 存储库ID--查询参数权重同级 | 10b8a76f-8219-42be-a7f7-bb4e4bb086a6 | |
| backupSnapStatus | 否 | String | 状态查询：Available-可用/NotAvailable-不可用/Restoring-恢复中 | Available | |
| queryContent | 否 | String | 可选查询：名称/ID/主机名称/存储库名称/备份计划名称 | snap_1725957974_policy_1825_x | |
| isCloud | 否 | Boolean | 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。该参数后续即将下线，推荐使用sourceType参数 | true | |
| sourceType | 否 | String | 产品服务类型(默认CT-ECS)，CT-ECS：弹性云主机，CT-DPS：裸金属物理机，CT-LS：本地客户主机 | CT-DPS |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 参考returnObj表 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | backup.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupSnapshotTotal | Integer | 备份的数量 | 10 | |
| backupSnapshotList | Array of Objects | 备份的详情列表 | backupSnapshotList |
表 backupSnapshotList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupPolicyID | String | 备份计划ID | 参考响应示例 | |
| backupSrcInstanceName | String | 主机名称 | 参考响应示例 | |
| backupPolicyName | String | 备份计划名称 | 参考响应示例 | |
| backupSrcInstanceID | String | 主机ID | 参考响应示例 | |
| dirs | String | 备份目录 | 参考响应示例 | |
| createTimeDesc | String | 创建时间描述 | 参考响应示例 | |
| finishTimeDesc | String | 完成时间描述 | 参考响应示例 | |
| backupSnapID | String | 快照ID | 参考响应示例 | |
| snapName | String | 快照名称 | 参考响应示例 | |
| statusCode | String | 状态码 | 参考响应示例 | |
| statusDesc | String | 状态描述 | 参考响应示例 | |
| backupClientVersion | String | 客户端版本 | 参考响应示例 | |
| backupSnapSize | String | 存储库写入量 | 参考响应示例 | |
| backupSnapIsNew | String | 是否是最新的快照（true：是、false：否） | 参考响应示例 | |
| backupMode | String | 备份模式（1：全量备份、0：增量备份） | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupPolicyID":"04c77f57-9f2d-4fa2-9858-0c72986eefe0",
"backupPolicyName":"backup-6d3f-test",
"backupSrcInstanceID":"15743497-eb28-2d7d-b1f2-53851c0ee893",
"backupStorageID":"10b8a76f-8219-42be-a7f7-bb4e4bb086a6"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"backupSnapshotList": [
{
"dirs": "/",
"backupMode": 1,
"backupSnapID": "91b33472-895f-478f-ba9f-c28ca0140522",
"statusDesc": "可用",
"backupSrcInstanceID": "eecba159-2c49-8cf5-1891-9cf7da30f86d",
"backupSrcInstanceName": "ecm-157c",
"backupStorageName": "A-multi",
"snapName": "snap_1725957974_policy_1825_x",
"createTimeDesc": "2024-09-10 16:47:33",
"backupPolicyName": "t",
"backupPolicyID": "6bb3f175-fc5a-4733-8136-317abf92b20a",
"backupSnapSize": "1.65GB",
"backupSnapDataSize": "2.65GB",
"backupClientVersion": "2.2.0",
"finishTimeDesc": "2024-09-10 16:47:33",
"backupStorageID": "0a83c6e7-7d6e-4090-bd87-22e646c67013",
"statusCode": "Available",
"backupSnapIsNew": false
}
],
"backupSnapshotTotal" : 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
