接口功能介绍
通过填写续订周期与续订时长，续订一台包年或者包月的云主机，请求过后获取本次续订的订单信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
成本估算：了解云主机的计费项
异步接口：该接口为异步接口，下单过后会拿到主订单ID（masterOrderID），后续可以调用根据订单号查询uuid，使用主订单ID来对订单情况y与开通成功后的资源ID进行查询。
代金券：只支持预付费用户抵扣包周期资源的金额，且不可超过包周期资源的金额
接口约束
1.云主机必须存在
2.续订只支持包周期的云主机
3.云主机处于“运行中”，“关机”和“已到期”的状态才可执行续订操作
URI
POST /v4/ecs/resubscribe-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| cycleCount | 是 | Integer | 订购时长，该参数需要与cycleType一同使用 注：最长订购周期为60个月（5年） |
6 | |
| cycleType | 是 | String | 订购周期类型，取值范围： MONTH：按月， YEAR：按年 |
MONTH | |
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| payVoucherPrice | 否 | Float | 代金券，满足以下规则：两位小数，不足两位自动补0，超过两位小数无效；不可为负数；字段为0时表示不使用代金券 | 20.55 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态。 | dd834bf8499511edaba00242ac110002 | |
| masterOrderNO | String | 订单号 | 20221021170431655227 | |
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：续订一台包周期的云主机10个月，代金券使用20.55
{
"clientToken": "8f924f6970fc09c1b469d7b96d1cjkl",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "a13693b6-e531-4c25-4642-63dcb41941ff",
"cycleType": "MONTH",
"cycleCount": 10,
"payVoucherPrice": 20.55
}
响应示例
{
"returnObj": {
"masterOrderNO": "20221021170431655227",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"masterOrderID": "dd834bf8499511edaba00242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
