接口功能介绍
您可以删除不再需要的快照，以达到节省资源和成本的目的。
接口约束
1、只有快照状态为“可用”时才支持删除操作。
2、支持批量删除，仅支持批量删除同一个云硬盘创建的多个快照。
3、当refundOrder为true时，将删除该云硬盘下的所有的快照，当存在“创建中”的云硬盘快照时，不允许进行退订或删除。
4、开通了快照功能的云硬盘（即创建过快照的云硬盘，首次创建快照时会创建订单），在删除云硬盘之前需要先退订快照功能。
接口是否审批
否
Content-Type
application/json
URI
POST /v4/ebs_snapshot/delete-ebs-snap
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，请根据查询资源池列表接口返回值进行传参，获取“regionId”参数。 | fc862f71-d629-4a0e-9fe0-b104963b3f05 | |
| snapshotIDs | 是 | Array of Strings | 云硬盘快照ID列表，请根据“查询快照列表接口”，获取snapshotID参数的返回值并进行传参。当refundOrder为true时不校验该字段，将删除所有的快照，该字段传[ ]即可。 | ["f261-45863-499c407", "u2384-2342-29384skdjhf"] | |
| refundOrder | 否 | Boolean | 是否退订该硬盘下的所有的快照，取值范围： ●true：将删除所有的快照并删除订单 ●false：只删除快照不删除订单 默认值为false。 | true | |
| diskID | 是 | String | 云硬盘ID。 | 36e88a58-1ebf-40ac-91b6-a8c0eca38314 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为处理中/失败）。 | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述。 | SUCCESS | |
| description | String | 成功或失败时的描述，一般为中文描述。 | 成功 | |
| returnObj | Object | 返回数据结构体。 | returnObj | |
| details | String | 可忽略。 | ||
| errorCode | String | 业务细分码，为product.module.code三段式码。请参考错误码。 | ||
| error | String | 业务细分码，为product.module.code三段式大驼峰码。请参考错误码。 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotJobID | String | 删除快照任务ID，仅删除不退订时返回该字段。 | ||
| notAllowedList | Array of Strings | 状态不允许删除的快照ID列表，仅删除不退订时返回该字段。 | ||
| notFoundList | Array of Strings | 不存在的快照ID列表，仅删除不退订时返回该字段。 | ||
| masterOrderID | String | 主订单ID，退订时返回该参数，普通删除无该字段。 | ||
| masterOrderNO | String | 主订单号，退订时返回该参数，普通删除无该字段。 | ||
| regionID | String | 资源池ID，退订时返回该参数，普通删除无该字段。 |
请求示例
请求头header
{
}请求体body
{
"regionID":"fc862f71-d629-4a0e-9fe0-b104963b3f05",
"snapshotIDs":[
"f261-45863-499c407",
"u2384-2342-29384skdjhf"
],
"diskID":"36e88a58-1ebf-40ac-91b6-a8c0eca38314"
}响应示例
{
"returnObj": {
"snapshotJobID": "0f49c7be-6194-11ed-b5f5-525400cc3b79",
"notAllowedList": [],
"notFoundList":[]，
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
refundOrder为true时:
{
"description" : "成功",
"details" : "",
"message" : "success",
"returnObj" : {
"masterOrderID" : "de0c74e4eb744435b852f799a7dcfece",
"masterOrderNO" : "20221106181514283523",
"regionID" : "81f7728662dd11ec810800155d307d5b"
},
"statusCode" : 800
}状态码
请参考状态码
错误码
请参考错误码
