接口功能介绍
调用接口启用/关闭自动快照策略。
接口约束
1、若目标状态和策略原始状态一致,调用此接口后不会报错。此情景下策略状态不变。若目标状态和策略原始状态不一致,调用此接口完成变更状态。此情景下策略状态改变;
2、一次操作只能设置一种状态,启用或者停用;
3、支持为多个策略同时批量设置状态,只能批量设置成同一个状态,若多个策略中,有部分执行失败,报错(部分执行失败,返回失败id);
4、 批量的话要是同一个资源池下;
接口是否审批
否
URI
POST /v4/ebs_snapshot/modify-policy-status-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
snapshotPolicyID | 是 | String | 快照策略ID,多个用英文逗号隔开。 | 参考请求示例 | |
targetStatus | 是 | String | 目标状态(activated/nonactivated) | 参考请求示例 |
响应参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中/失败,详见errorCode)。 | 800 | |
message | String | 失败时的错误描述,一般为英文描述。 | 参考响应示例 | |
description | String | 失败时的错误描述,一般为中文描述。 | 参考响应示例 | |
returnObj | Object | 返回数据结构体 | returnObj | |
details | String | 可忽略 | 参考响应示例 | |
errorCode | String | 业务细分码,为product.module.code三段式码。请参考错误码。 | 参考响应示例 | |
error | String | 业务细分码,为product.module.code三段式大驼峰码。请参考错误码。 | 参考响应示例 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotPolicyJobResult | String | 任务执行状态 | 参考响应示例 | |
failedList | Array of Strings | 失败云硬盘列表 | 参考响应示例 |
枚举参数
无
请求头header示例
{
}
请求url示例
无
请求体body示例
{
""regionID"":""41f64827f25f468595ffa3a5deb5d15d"",
""snapshotPolicyIDs"":""0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"",
""targetStatus"":""activated""
}
响应示例
{
""returnObj"":{
""snapshotPolicyJobResult"":""任务执行成功""
},
""details"":"""",
""message"":""SUCCESS"",
""description"":""成功"",
""statusCode"":800
}
状态码
请参考状态码
错误码
请参考错误码