接口介绍
通过接口查询备份
接口约束
无
URI
GET /v4/backup/query-backup-snapshot
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 |
|---|---|---|---|
| regionID | 是 | String | 资源池ID, 例：100054c0416811e9a6690242ac110002 |
| backupPolicyName | 否 | String | 备份计划名字模糊匹配--查询参数权重同级 |
| backupPolicyID | 否 | String | 备份计划ID--查询参数权重同级 |
| backupSrcInstanceID | 否 | String | ECS ID--查询参数权重同级 |
| backupStorageID | 否 | string | 存储库ID--查询参数权重同级 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考returnObj表 | 参考returnObj表 | |
| detail | 是 | String | 详细的错误信息。 | 参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupSnapshotTotal | 是 | Integer | 备份的数量 | 参考响应示例 | |
| backupSnapshotList | 是 | Array of Objects | 备份的详情列表 | 参考backupSnapshotList表 |
表 backupSnapshotList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupPolicyID | 是 | String | 备份计划ID | 参考响应示例 | |
| backupSrcInstanceName | 是 | String | ECS 名称 | 参考响应示例 | |
| backupPolicyName | 是 | String | 备份计划名称 | 参考响应示例 | |
| backupSrcInstanceID | 是 | String | ECS ID | 参考响应示例 | |
| dirs | 是 | String | 备份目录 | 参考响应示例 | |
| dataSizeDesc | 是 | String | 数据量 | 参考响应示例 | |
| createTimeDesc | 是 | String | 创建时间描述 | 参考响应示例 | |
| ebsSnapID | 是 | String | 快照ID | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
}
响应示例
{
"description" : "\u6210\u529f",
"message" : "SUCCESS",
"returnObj": {
"backupSnapshotList":[
{
"dataSizeDesc": "3",
"dirs": "/root/backup1",
"backupSrcInstanceName": "ecm-az2-dca3",
"backupPolicyID": "04c77f57-9f2d-4fa2-9858-0c72986eefe0",
"backupStorageName": "zt-store-09",
"createTimeDesc": "2023-03-20 11:06:02",
"backupPolicyName": "backup-6d3f-test",
"backupSnapID": "e476121a-d5ac-45b4-96dc-c252af345375",
"backupStorageID": "10b8a76f-8219-42be-a7f7-bb4e4bb086a6",
"backupSrcInstanceID": "15743497-eb28-2d7d-b1f2-53851c0ee893"
}
],
"backupSnapshotTotal" : 1
}
"statusCode" : 800
}
错误码
请参考状态码
