接口功能介绍
云硬盘的快照默认不随云硬盘自动释放,如果您不再需要某些云硬盘快照,可以将其手动释放。您还可以通过设置云硬盘释放策略,选择在释放云硬盘的同时释放该盘的全部快照。
接口约束
1、当前仅华东1资源池支持设置云硬盘删除策略。
2、随弹性云主机一起购买的数据盘的全部快照只支持手动释放,单独购买的数据盘的全部快照既支持手动释放,也支持通过设置云硬盘删除策略来释放。
3、“创建中”,“镜像上传中”的云硬盘不允许此操作。
接口是否审批
否
URI
POST /v4/ebs/set-delete-policy-ebs
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID。 | 41f64827f25f468595ffa3a5deb5d15d | |
diskID | 是 | String | 云硬盘ID。 | 4afo4ffa-7fd0-4307-822-69808d2a5cb | |
deleteSnapWithEbs | 是 | Boolean | 设置快照是否随盘删除。 | true |
响应参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
setDeletePolicyJobResult | String | 任务执行状态。 | 参考响应示例。 |
枚举参数
无
请求头header示例
{
}
请求url示例
无
请求体body示例
{
""regionID"":""41f64827f25f468595ffa3a5deb5d15d"",
""diskID"":""4afo4ffa-7fd0-4307-822-69808d2a5cb"",
""deleteSnapWithEbs"":true
}
响应示例
{
""returnObj"":{
""setDeletePolicyJobResult"":""任务执行成功""
},
""details"":"""",
""message"":""SUCCESS"",
""description"":""成功"",
""statusCode"":800
}
状态码
请参考状态码
错误码
请参考错误码