接口功能介绍
该接口提供用户续订一台包年或者包月的轻量型云主机功能。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
成本估算:了解云主机的计费项,详细查看价格总览进行成本估算
异步接口:该接口为异步接口,下单过后会拿到主订单ID(masterOrderID),后续可以调用根据订单号查询uuid,使用主订单ID来对订单情况与开通成功后的资源ID进行查询
接口约束
1. 使用限制,本接口只支持在部分资源池进行公测
2. 确保当前请求资源池下,该云主机存在(即instanceID真实存在且与regionID相对应)
URI
POST /v4/ecs/lite/resubscribe
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,其他请求参数相同时,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 轻量型云主机ID,您可以查看轻量型云主机了解轻量型云主机的相关信息 获取: 查 查询轻量型云主机列表 创 创建轻量型云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
cycleCount | 是 | Integer | 订购时长, 注:最长订购周期为36个月(3年) |
6 | |
cycleType | 是 | String | 订购周期类型,取值范围: MONTH:按月, YEAR:按年。 |
MONTH |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后,在若干错误情况下,可以使用materOrderID进一步确认订单状态及资源状态。 | 20230712101502980592 | |
masterOrderNO | String | 订单号 | e87ff7ea205911ee983e0242ac110012 | |
regionID | String | 资源所属资源池ID | 41f64827f25f468595ffa3a5deb5d15d |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"clientToken": "8f924f6970fc09c1b469d7b96d1cjkl",
"regionID": "aaf589124d5d11eaa04d0242ac110002",
"instanceID": "a13693b6-e531-4c25-4642-63dcb41941ff",
"cycleType": "MONTH",
"cycleCount": 10
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230712101502980592",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"masterOrderID": "e87ff7ea205911ee983e0242ac110012"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码