接口介绍
通过接口创建查询备份计划
接口约束
无
URI
GET /v4/backup/query-backup-policy
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 |
|---|---|---|---|
| regionID | 是 | String | 资源池ID, 例：100054c0416811e9a6690242ac110002 |
| backupPolicyName | 否 | String | 备份计划名字模糊匹配--不填返回全部 |
| backupPolicyID | 否 | String | 备份计划ID--不填返回全部 --id跟名称查询都填则只选id |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考returnObj表 | 参考returnObj表 | |
| detail | 是 | String | 详细的错误信息。 | 参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupPolicyTotal | 是 | Integer | 备份计划的数量 | 参考响应示例 | |
| backupPolicyList | 是 | Array of Objects | 备份计划的详情列表 | 参考响应示例 |
表 backupPolicyList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupPolicyID | 是 | String | 备份计划ID | 参考响应示例 | |
| startTimeDesc | 是 | String | 开始时间 | 参考响应示例 | |
| backupPolicyName | 是 | String | 备份计划名称 | 参考响应示例 | |
| backupSrcInstanceID | 是 | String | ECS ID | 参考响应示例 | |
| backupStorageID | 是 | String | 存储库ID | 参考响应示例 | |
| backupStorageName | 是 | String | 存储库名称 | 参考响应示例 | |
| periodDesc | 是 | String | 备份周期描述 | 参考响应示例 | |
| retentionDesc | 是 | String | 保留描述 | 参考响应示例 | |
| statusDesc | 是 | string | 备份计划状态描述 | 参考响应示例 | |
| statusCode | 是 | int | 参考状态枚举表 |
请求示例
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupPolicyID": "31f777-827f25f-595ffa3-deb5d15d",
}
响应示例
{
"returnObj": {
"backupPolicyList": [
{
"dirs": "/root/backup1",
"backupStorageName": "zt-store-09",
"statusDesc": "暂停",
"retentionDesc": "永久保留",
"periodDesc": "每小时备份一次",
"backupPolicyID": "5ff58a61-a3d4-4732-a5bf-4d53d31bf690",
"backupPolicyName": "backup-6d3f",
"startTimeDesc": "2023-02-28 15:32:42",
"statusCode": "Stop",
"backupSrcInstanceName": "ecm-az2-dca3",
"backupStorageID": "10b8a76f-8219-42be-a7f7-bb4e4bb086a6",
"backupSrcInstanceID": "15743497-eb28-2d7d-b1f2-53851c0ee893"
}
],
"backupPolicyTotal": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
请参考状态码
