接口功能介绍
您可设置自动快照策略状态为启用/停用，启用状态的自动快照策略才可以执行创建自动快照任务。
接口约束
1、若您要设置的目标状态和当前策略的状态一致，调用此接口后不会报错，即此情景下自动快照策略状态不会发生改变。若您要设置的目标状态和当前策略的状态不一致，调用此接口将完成状态变更，即此情景下自动快照策略状态会发生改变。
2、一次操作只能设置一种状态，即只能启用或者停用自动快照策略。
3、支持为多个策略同时批量设置状态，但只能批量设置成同一个状态。若多个自动快照策略设置过程中，有部分执行失败，则报错“部分执行失败，返回失败id”。
4、批量设置自动快照策略启用/停用时，需要这些策略在同一个资源池下。
5、启用和停用范围为该策略关联的全部云硬盘。
接口是否审批
否
URI
POST /v4/ebs_snapshot/modify-policy-status-ebs-snap
POST /v4/ebs_snapshot/modify-policy-status-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID。 | 41f64827f25f468595ffa3a5deb5d15d | |
| snapshotPolicyID | 是 | String | 快照策略ID，多个策略用英文逗号隔开。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 | |
| targetStatus | 是 | String | 目标状态，取值范围： ●activated：启用。 ●nonactivated：停用。 | activated |
响应参数
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
}状态码
请参考状态码
错误码
请参考错误码
