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