接口功能介绍
如果您需要修改自动快照的定时创建时间、保留规则等信息，可以通过接口编辑修改自动快照策略。
修改自动快照策略后，之前已应用该策略的云硬盘随即执行更新后的自动快照策略。
接口约束
1、修改快照的“保留时间”时，仅对新增的自动快照生效，历史自动快照沿用历史保留时间。
2、不支持修改“企业项目”、“是否启用”字段。
3、修改自动快照策略名称时不允许与已有的策略名称重复。
接口是否审批
否
URI
POST /v4/ebs_snapshot/modify-policy-ebs-snap
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID。 | 41f64827f25f468595ffa3a5deb5d15d | |
| snapshotPolicyID | 是 | String | 要修改的快照策略ID。 | 3641b283-0345-49a9-9c86-bebd963f1caa | |
| snapshotPolicyName | 否 | String | 修改后的快照策略名称，只能由英文字母、数字、下划线、中划线组成，不能以特殊字符、数字开头，长度2-63字符。 | policy-2 | |
| repeatWeekdays | 否 | String | 修改后的创建快照的重复日期，0-6分别代表周日-周六，多个日期用英文逗号隔开。 | 0,1,2 | |
| repeatTimes | 否 | String | 修改后的创建快照的重复时间，0-23分别代表零点-23点，多个时间用英文逗号隔开。 | 0,1,2 | |
| retentionTime | 否 | Integer | 修改后的创建快照的保留时间，输入范围为[ -1，1-65535], -1代表永久保留。单位为天。 | 2 |
响应参数
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | 任务执行状态。 | 参考响应示例。 |
枚举参数
无
请求头header示例
{
}请求url示例
无
请求体body示例
{
""regionID"":""41f64827f25f468595ffa3a5deb5d15d"",
""snapshotPolicyID"":""3641b283-0345-49a9-9c86-bebd963f1caa"",
""snapshotPolicyName"":""policy-2""
}响应示例
{
""returnObj"":{
""snapshotPolicyJobResult"":""任务执行成功""
},
""details"":"""",
""message"":""SUCCESS"",
""description"":""成功"",
""statusCode"":800
}状态码
请参考状态码
错误码
请参考错误码
