接口介绍
支持包周期计费的云硬盘续订。
接口约束
1、用户云硬盘配额未满；
2、用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单；
URI
POST /v4/ebs/renew
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| resourceID | 是 | String | 资源ID，订单创建后的返回值。参考云硬盘开通表resources | 参考请求示例 |
| regionID | 否 | String | 如本地语境支持保存regionID，那么建议传递。 | 参考请求示例 |
| cycleType | 是 | String | 包周期类型，year/month。 | 参考请求示例 |
| cycleCount | 是 | Integer | 包周期数。 | 参考请求示例 |
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。 要求单个云平台账户内唯一 |
参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为处理中/失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考表returnObj | 参考响应示例 | 参考表returnObj |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码. |
参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| masterOrderID | 是 | String | 订单ID。调用方在拿到masterOrderID之后， 在若干错误情况下，可以使用masterOrderID进一步确认订单状态及资源状态。 参考结果码 |
参考响应示例 |
| masterOrderNO | 是 | String | 订单号 | 参考响应示例 |
| masterResourceID | 是 | String | 主资源ID。云硬盘场景下，无需关心。 | 参考响应示例 |
| masterResourceStatus | 是 | String | 主资源状态。只有主订单资源会返回。unknown/failed/ starting，具体状态信息请参考资源状态 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"clientToken": "",
"resourceID": "eff436e3d44040f1b306ab3a14530f02",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"cycleType": "month",
"cycleCount": 2
}
响应示例
{
"returnObj": {
"masterResourceStatus": "changed",
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterOrderNO": "20220812171600203284"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
错误码
请参考通用结果码。
