接口功能介绍
您可以退订/删除一块包周期/按需的云硬盘，以释放存储空间资源。退订/删除云硬盘后，将停止对云硬盘收费。
包周期云硬盘退订时，按照原始订单实付价格折算退订金额并进行返还。
当云硬盘被退订/删除后，云硬盘的数据将无法被访问。
接口约束
1、对于按需云硬盘，当云硬盘状态为“未挂载”或“已冻结”时，才可以被删除；对于包周期云硬盘，当云硬盘状态为“未挂载“时，才可以被退订。
2、在退订云硬盘之前，您需要先删除该云硬盘的所有快照或者将云硬盘释放策略设置为“全部快照随云硬盘释放“。
3、随云主机一起订购的系统盘不支持单独退订/删除，而数据盘可在云主机界面进行产品拆分后卸载、退订/删除。
接口是否审批
否
URI
POST JSON /v4/ebs/refund-ebs
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | refund0211v1 | |
| diskID | 是 | String | 需要退订的云硬盘ID。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1bxx | |
| regionID | 否 | String | 资源池ID。如本地语境支持保存regionID，那么建议传递。 | 81f7728662dd11ec810800155d307d5b | |
| deleteSnapWithEbs | 否 | Boolean | 设置快照是否随盘删除，只能设置为true。 | true |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败)。 | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述。 | region info empty | |
| description | String | 失败时的错误描述，一般为中文描述。 | 资源池信息为空。 | |
| returnObj | Object | 返回结构体。 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码，请参考错误码。 | ebs.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码，请参考错误码。 | Ebs.RegionInfo.Empty | |
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 其他订单侧(bss)的错误，以Ebs.Order.ProcFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息。 | errorDetail |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 退订订单号，可以使用该订单号确认资源的最终退订状态。 | beacf51a20dd4889bfc99877d89e03e2 | |
| masterOrderNO | String | 退订订单号。 | 20220812171600203284 | |
| regionID | String | 资源池ID。 | 81f7728662dd11ec810800155d307d5b |
表 errorDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bssErrCode | String | bss错误明细码，包含于bss格式化JSON错误信息中。 | bss.xxx.xxx | |
| bssErrMsg | String | bss错误信息，包含于bss格式化JSON错误信息中。 | 账号验证失败。 | |
| bssOrigErr | String | 无法明确解码bss错误信息时，原样透出的bss错误信息。 | get account info failed | |
| bssErrPrefixHint | String | bss格式化JSON错误信息的前置提示信息。 | get account info failed |
请求示例
请求头header
{
}请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"diskID":"0ae97ef5-6ee2-44af-9d05-1a509b0a1be6",
"clientToken":"refund0211v1"
}响应示例
{
"returnObj": {
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterOrderNO": "20230211111612272839"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}状态码
请参考状态码
错误码
请参考错误码
