接口介绍
支持退订一块包周期计费/按需的云硬盘。退订云硬盘后，将退还对应部分云硬盘费用。
接口约束
1、当云硬盘状态为“未挂载”时，才可以退订；
URI
POST /v4/ebs/refund
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 参考请求示例 |
| resourceID | 是 | String | 资源ID，订单创建后的返回值。参考云硬盘开通表resources | 参考请求示例 |
| regionID | 否 | String | 如本地语境支持保存regionID，那么建议传递 | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为处理中/失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考表returnObj | 参考响应示例 | 参考表returnObj |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码. |
参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| masterOrderID | 是 | String | 退订订单号，可以使用该订单号确认资源的最终退订状态 | 参考响应示例 |
| masterOrderNO | 是 | String | 退订订单号 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"clientToken": "",
"resourceID": "eff436e3d44040f1b306ab3a14530f02",
"regionID": "41f64827f25f468595ffa3a5deb5d15d"
}
响应示例
{
"returnObj": {
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterOrderNO": "20220812171600203284"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
错误码
请参考通用结果码。
