接口功能介绍
续订物理机
URI
POST /v4/ebm/renew
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 是 | String | 可用区名称或者 default。您可以调用 https://www.ctyun.cn/document/10026730/10040590 获取资源池信息，查询结果中zoneList内返回可用区名称，若查询结果中zoneList为空，即为单可用区，本字段填写default | az1 | |
| instanceUUID | 是 | String | 实例UUID | ss-eztbrc1j541lb2pim0lxr3uctdfo | |
| payVoucherPrice | 否 | Float | 代金券，满足以下规则：两位小数，不足两位自动补0，超过两位小数无效；不可为负数；字段为0时表示不使用代金券 | 20.55 | |
| cycleType | 是 | String | 订购周期类型，值为"MONTH"表示cycleCount的值单位为月，值为"YEAR"表示cycleCount的值单位为年 | MONTH | |
| cycleCount | 是 | Integer | 订购周期，值的单位由cycleType决定 | 1 | |
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | uGTWoCHLiO |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.Instance.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，参考表returnObj | {} | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | 100054c0416811e9a6690242ac110002 | |
| masterOrderID | String | 订单ID | 86f7f49e241a11edb4f83003c86a1328 | |
| masterOrderNO | String | 订单号 | 20220825100639650114 |
请求示例
{
"regionID": "100054c0416811e9a6690242ac110002",
"azName": "az2",
"instanceUUID": "ss-eztbrc1j541lb2pim0lxr3uctdfo",
"cycleType": "MONTH",
"cycleCount": 3,
"clientToken": "ea1b9004-f450-11ec-8d4f-00155de3fd73"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj":
{
"regionID": "100054c0416811e9a6690242ac110002",
"masterOrderID": "86f7f49e241a11edb4f83003c86a1328",
"masterOrderNO": "20220825100639650114"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.Instance.NotValid | 请求参数非法 |
| Ebm.Instance.NotFound | 物理机不存在 |
| Ebm.Renew.NotValid | 请求参数非法 |
| Ebm.Renew.NotSupportedUnexpired | 续费仅支持包年包月实例 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
