查询云备份计划
更新时间 2026-04-02 15:47:58
最近更新时间: 2026-04-02 15:47:58
接口功能介绍
通过接口查询备份计划
接口约束
无
URI
GET /v4/backup/query-backup-policy
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| backupSrcInstanceID | 否 | String | 备份云主机ID | 31f777-827f25f-595ffa3-deb5d15d | |
| backupPolicyName | 否 | String | 备份计划名字(模糊匹配) | test-20240222 | |
| backupPolicyID | 否 | String | 备份计划ID | 31f777-827f25f-595ffa3-deb5d15d | |
| backupPolicyStatus | 否 | String | 状态查询：CreateSuccess-正常/Stop-暂停 | ||
| queryContent | 否 | String | 可选查询：备份计划名称/主机名称 | test-policy | |
| 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 表 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | backup.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupPolicyTotal | Integer | 备份计划的数量 | 1 | |
| backupPolicyList | Array of Objects | 备份计划的详情列表 | backupPolicyList 表 |
表 backupPolicyList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupPolicyID | String | 备份计划ID | 31f777-827f25f-595ffa3-deb5d15d | |
| backupDirs | String | 备份目录 | D:\ | |
| backupRaw | Object | 备份计划详情 | backupRaw表 | |
| startTimeDesc | String | 开始时间 | 2024-02-22 14:44:52 | |
| backupPolicyName | String | 备份计划名称 | test-20240222 | |
| backupSrcInstanceID | String | 主机 ID | 3687ff75-0954-9426-b461-53f28f6b895f | |
| backupSrcInstanceName | String | 主机 名称 | ecm-a419 | |
| backupStorageID | String | 存储库ID | 90be5bb9-ec6f-4512-a832-862e93381c4d | |
| backupStorageName | String | 存储库名称 | test-20240124-01 | |
| periodDesc | String | 备份周期描述 | 每周一,0点备份一次 | |
| retentionDesc | String | 保留描述 | 1天 | |
| statusDesc | String | 备份计划状态描述 | 正常运行 | |
| statusCode | String | 备份计划状态 | CreateSuccess | |
| policyType | Integer | 是否是云上资源：0：云上 1：本地 | 0 |
表 backupRaw
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| periodInfo | Object | 备份时间信息 | 参考创建备份计划接口参数 | |
| fileInfo | Object | 备份文件信息 | 参考创建备份计划接口参数 | |
| retentionInfo | Object | 备份保留信息 | 参考创建备份计划接口参数 | |
| fullInfo | Object | 周期全备信息 | 参考创建备份计划接口参数 | |
| limitQosInfo | Object | 限制QOS信息 | 参考创建备份计划接口参数 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupPolicyID": "31f777-827f25f-595ffa3-deb5d15d",
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"backupPolicyList": [
{
"backupStorageName": "backupStorageName-azNEu",
"statusCode": "CreateSuccess",
"backupSrcInstanceID": "e290c1db-be8f-a6c5-2836-bf8c790def21",
"backupSrcInstanceName": "openapi-20250212",
"retentionDesc": "1月",
"backupPolicyName": "backupPolicyName-YxWYW",
"backupPolicyID": "8045ae11-b354-4dd0-9d4f-b91f94c41813",
"backupRaw": {
"limitQosInfo": {
"rateLimits": null,
"isLimitQos": null
},
"periodInfo": {
"day": 0,
"rule": 2,
"hour": "00:00"
},
"fileInfo": {
"dirs": [
"/"
],
"files": [
"/root"
],
"rule": 1
},
"retentionInfo": {
"conf": {
"week": 0,
"year": 0,
"day": 0,
"month": 0
},
"type": 3,
"hasConf": false,
"value": 1
},
"fullInfo": {
"backupMode": 0,
"incrementNum": 10
}
},
"policyType": 0,
"periodDesc": "每周日,0点备份一次",
"statusDesc": "正常运行",
"backupDirs": "/",
"backupStorageID": "e1bc4a9b-8589-4dce-9917-9a9e4ff46e96",
"startTimeDesc": "2025-02-13 14:04:43"
}
],
"backupPolicyTotal": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
