接口功能介绍
支持包周期的数据盘续订。
接口约束
1、用户云硬盘配额未满的情况下允许续订。
2、用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单。
3、“创建中”，“镜像上传中”状态的云硬盘不允许续订。
4、只有包周期类型的云硬盘支持续订。
5、随云主机一起订购的系统盘不支持单独续订，需要与云主机一起续订。
6、按需云硬盘、包周期转按需（已完成转按需或正在进行转按需）的云硬盘不可续订。
7、未完成订单中的资源不允许续订，如开通中的资源、规格变更中的资源、退订中的资源。已退订或释放的资源不可续订。
接口是否审批
否
URI
POST JSON /v4/ebs/renew-ebs
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| diskID | 是 | String | 云硬盘ID。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1bxx | |
| regionID | 否 | String | 资源池ID。如本地语境支持保存regionID，那么建议传递。 | 81f7728662dd11ec810800155d307d5b | |
| cycleType | 是 | String | 包周期类型，取值范围： ●year：包年。 ●month：包月。 | month | |
| cycleCount | 是 | Integer | 包周期数。 周期为年（year）时，最大支持续订3年。 周期为月（month）时，最大支持续订36个月。 | 2 | |
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | renew-0211v1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用masterOrderID进一步确认订单状态及资源状态。 | 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",
"cycleType":"month",
"cycleCount":2,
"clientToken":"renew-0211v1"
}响应示例
{
"returnObj": {
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterOrderNO": "20220812171600203284"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}状态码
请参考状态码
错误码
请参考错误码
