续订一台包周期的云主机
接口功能介绍
续订一台包年或者包月的云主机。
接口约束
无
URI
POST /v4/ecs/resubscribe-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表。 | 81f7728662dd11ec810800155d307d5b | |
instanceID | 是 | String | 云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
cycleCount | 是 | Integer | 订购时长 | 6 | |
cycleType | 是 | String | 订购周期类型,取值范围:MONTH:按月,YEAR:按年,最长订购周期为5年 | 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 | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态。 | dd834bf8499511edaba00242ac110002 | |
masterOrderNO | String | 订单号 | 20221021170431655227 | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
请求示例
请求头header
无
请求体body
{
"clientToken": "8f924f6970fc09c1b469d7b96d1cjkl",
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceID": "a13693b6-e531-4c25-4642-63dcb41941ff",
"cycleType": "MONTH",
"cycleCount": 10,
"payVoucherPrice": 20.55
}
响应示例
{
"returnObj": {
"masterOrderNO": "20221021170431655227",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "dd834bf8499511edaba00242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserVisibleRegions.DataDamaged | 查询用戶可见资源池信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserVisibleRegions.AccessFailed | 查询用戶可见资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Parameter.InvalidRegionID | 可见资源池信息为空,请确认regionID是否正确 |
Ecs.Instance.ParameterInvalid | 请求参数无效 |
Openapi.CustomerAdmin.AccessFailed | 查询用户信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.CustomerAdmin.FormatError | 查询用户信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.CustomerCheck.UnknownError | 查询用户信息失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionAdmin.AccessFailed | 查询用户许可信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionAdmin.FormatError | 查询用户资源池许可信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionCheck.UnknownError | 查询用户许可信息失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.ResourcesWorkorder.AccessFailed | 查询用户已有资源错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.ResourcesFormat.FormatError | 查询用户已有资源格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.ResourcesCheck.UnknownError | 查询用户已有资源失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserPermission.AccessFailed | 查询用户权限失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserPermission.Empty | 查询用户权限信息为空,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserPermission.DataDamaged | 查询用户权限信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.OrderCheck.InvalidProjectID | 企业项目ID不存在,请确认企业项目ID是否有效 |
Ecs.OrderCheck.UserForbiddenOnDemand | 用户不允许订购按需类订单,请确认用户是否有该操作权限 |
Ecs.Parameter.InvalidCycleCount | cycleCount请求参数错误 |
Ecs.Parameter.InvalidCycleType | CycleType请求参数错误 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsFormat.FormatError | 查询云主机信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.OrderInfoNotExists | 查不到实例:{}的订单信息,请确认 |
Openapi.Workorder.AccessFailed | 资源订单信息数据异常,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.RenewNotSupportOndemand | 续费仅支持包年包月实例,请确认实例类型 |
Ecs.Order.AccessFailed | 访问订单系统失败 |
Ecs.Order.ProcFailed | 订单处理失败 |
Ecs.Order.UserFrozen | 用户受限,可能是被冻结的账户,或者余额不足 |