接口功能介绍
删除云硬盘快照,单个租户下的单个快照的最后一个快照删除时,回去删除该硬盘快照的订单;
接口约束
1、只有快照状态为可用时才支持删除操作;
2、支持批量删除,仅支持批量删除同一个卷下的多个快照;
3、当refundOrder为true时,将退订云硬盘的快照功能,将删除该云硬盘下的所有的快照,当存在创建中的云硬盘快照时,不允许进行退订;开通了快照功能的云硬盘(即创建过快照,首次创建快照时会创建订单)在删除云硬盘之前需要先退订快照功能;
URI
POST /v4/ebs_snapshot/delete
请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | String | 资源池ID,请根据查询资源池列表接口返回值进行传参,获取“regionId”参数 | 参考请求示例 |
snapshotIDs | 是 | Object of Array | 云硬盘快照ID列表,请根据查询快照列表接口返回值进行传参,获取snapshotID参数,当refundOrder为True时不校验该字段,将删除所有的快照,该字段传空即可 | 参考请求示例 |
refundOrder | 否 | Boolean | 是否退订该硬盘下的所有的快照,True时将删除所有的快照并删除订单,False时只删除快照不删除订单 | 参考请求示例 |
volumeID | 是 | String | 云硬盘ID | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 参考表returnObj | 参考响应示例 | 参考表returnObj |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码. 参考通用结果码 |
参考响应示例 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
jobID | 是 | String | 删除快照任务ID,仅删除不退订时返回该字段 | 参考响应示例 |
not_allowed_list | 是 | Object of Array | 状态不允许的快照ID列表,仅删除不退订时返回该字段 | 参考响应示例 |
not_found_list | 是 | Object of Array | 不存在的快照ID列表,仅删除不退订时返回该字段 | 参考响应示例 |
masterOrderID | 是 | String | 主订单ID,退订时返回该参数,普通删除无该字段 | 参考响应示例 |
masterOrderNO | 是 | String | 主订单号,退订时返回该参数,普通删除无该字段 | 参考响应示例 |
regionID | 是 | String | 区域ID,退订时返回该参数,普通删除无该字段 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID":"fc862f71-d629-4a0e-9fe0-b104963b3f05",
"snapshotIDs":["f261-45863-499c407"],
"volumeID": "36e88a58-1ebf-40ac-91b6-a8c0eca38314"
}
响应示例
{
"returnObj": {
"jobID": "0f49c7be-6194-11ed-b5f5-525400cc3b79",
"not_allowed_list": [],
"not_found_list":[]
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
refundOrder为true时:
{
"description" : "\u6210\u529f",
"details" : "",
"message" : "success",
"returnObj" : {
"masterOrderID" : "de0c74e4eb744435b852f799a7dcfece",
"masterOrderNO" : "20221106181514283523",
"regionID" : "81f7728662dd11ec810800155d307d5b"
},
"statusCode" : 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功 |
900 | 订单类返回900并且message为order in progress为成功,其他情况为失败 |
错误码
请参考通用结果码。