操作云备份计划
更新时间 2026-04-02 15:47:39
最近更新时间: 2026-04-02 15:47:39
接口功能介绍
通过接口操作备份计划
接口约束
1、触发备份计划时，计划需要是运行中状态 2、停止备份计划时，计划需要是运行中状态 3、启用备份计划时，计划需要是停止状态
URI
POST /v4/backup/action-backup-policy
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 41f64827f25f468595ffa3a5deb5d15d | |
| backupPolicyID | 是 | String | 备份计划ID | 31f777-827f25f-595ffa3-deb5d15d | |
| backupPolicyOp | 是 | Integer | 1 启用 ，2 停止，3 立即执行 | 1 | |
| backupMode | 否 | Integer | 执行计划时是否启动全量备份，0:不启动 1:启动(默认不启动) | 0 | |
| isCloud | 否 | Boolean | 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。推荐使用sourceType参数，该参数后续即将下线 | true | |
| sourceType | 否 | String | 产品服务类型(默认CT-ECS)，CT-ECS：弹性云主机，CT-DPS：裸金属物理机，CT-LS：本地客户主机 | CT-DPS |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| status | String | 操作备份计划任务是否下发成功 | 参考响应示例 | |
| msg | String | 操作备份计划任务下发描述 | 参考响应示例 | |
| backupTaskID | String | 备份计划任务ID | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"41f64827f25f468595ffa3a5deb5d15d",
"backupPolicyID":"31f777-827f25f-595ffa3-deb5d15d",
"backupPolicyOp":2
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"backupTaskID": "821b7c46-d224-4fcd-9c4f-d5f8a270cde3",
"msg": "backupPolicy action succeeded You can learn more through the query backup task",
"status": "success"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
