接口功能介绍
支持退订一块包周期计费/按需的云硬盘。退订云硬盘后，将退还对应部分云硬盘费用。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
当云硬盘状态为“未挂载”时，才可以退订
URI
POST /v4/ecs/volume/delete
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，则代表为同一个请求。保留时间为24小时 | refund0211v1 | |
| diskID | 是 | String | 磁盘ID。您可以查看产品定义-云硬盘来了解云硬盘 获取： 查 云硬盘列表查询 创 创建云硬盘 |
0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 | |
| regionID | 否 | String | 如本地语境支持保存regionID，那么建议传递。资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中或失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | Param is null | |
| description | String | 失败时的错误描述，一般为中文描述 | 请求为空 | |
| returnObj | Object | 返回参数 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码。参考通用结果码 | Ebs.RegionInfo.AccessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 退订订单号，可以使用该订单号确认资源的最终退订状态 | beacf51a20dd4889bfc99877d89e03e2 | |
| masterOrderNO | String | 退订订单号 | 20230211111612272839 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterOrderNO": "20230211111612272839"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
