接口功能介绍
支持按需包年/包月订购云间高速带宽包
接口约束
用户云间高速带宽包配额未满；用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单
URI
POST /v4/ec/packet/new
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | unique-any-string | |
| regionID | 是 | String | 资源池ID | 100054c0416811e9a6690242ac110002 | |
| packetName | 是 | String | 带宽包名字 | cloudhigh-packet02-openapi | |
| ecID | 是 | String | 云间高速ID | 3acd1ed4-426a-4ea0-a8e4-8584657cddee | |
| bandwidth | 是 | Integer | 带宽，单位MB | 5 | |
| onDemand | 否 | Boolean | 布尔类型，是否按需下单。默认为false | false | |
| cycleType | 是 | String | 包周期类型,当onDemand为False时，必须指定 取值如下： "YEAR": 包年 "MONTH":包月 |
MONTH | |
| cycleCount | 是 | Integer | 包周期数。onDemand为False时必须指定。周期最大长度不能超过36个月 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| message | String | 失败时的错误描述，一般为英文描述 | success | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态 | ||
| masterOrderNO | String | 订单号 | ||
| masterResourceID | String | 主资源ID | d708e8925dc743829cfc5b26c3d314e2 | |
| masterResourceStatus | String | 主资源状态，只有主订单资源会返回 | started | |
| regionID | String | 资源所属资源池ID | 81f7728662dd11ec810800155d307d5b | |
| resources | Array of Objects | 资源明细列表,参考表resources | Resource |
表 Resource
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resourceID | String | 单项资源的变配、续订、退订等需要该资源项的ID | d708e8925dc743829cfc5b26c3d314e2 | |
| orderID | String | 订单ID | bb4e607c0da348a6ab6be71c10fc2a5b | |
| startTime | Integer | 启动时刻，epoch时戳，毫秒精度 | 1667902478000 | |
| expireTime | Integer | 过期时刻，epoch时戳，毫秒精度 | 1667902480000 | |
| createTime | Integer | 创建时刻，epoch时戳，毫秒精度 | 1667902456000 | |
| updateTime | Integer | 更新时刻，epoch时戳，毫秒精度 | 1667902481000 | |
| status | Integer | 资源状态。参考masterResourceStatus | 2 | |
| isMaster | Boolean | 布尔类型，是否是主资源项 | true | |
| itemValue | Integer | 资源规格，带宽包大小，单位MB | 5 | |
| resourceType | String | 本参数表示订单资源类型 | OVERLAY_BANDWIDTH | |
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态 | ||
| masterResourceID | String | 主资源ID | d708e8925dc743829cfc5b26c3d314e2 |
请求示例
可使用同clientToken重试下单，查询订单是否成功
请求头header
请求体body
{
"clientToken": "unique-any-string",
"ecID": "3acd1ed4-426a-4ea0-a8e4-8584657cddee",
"packetName": "cloudhigh-packet02-openapi",
"regionID": "81f7728662dd11ec810800155d307d5b",
"bandwidth": 5,
"onDemand": false,
"cycleType": "MONTH",
"cycleCount": 1
}
响应示例
{
"returnObj":{
"masterResourceStatus":"started",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"04dcdb8c73c611eeae680242ac11000b",
"masterResourceID":"f01b09c8914043d4b6a3216390993b2f",
"masterOrderNO":"20231026140802246632",
"resources":[
{
"orderID":"3c83b4d9e37848a28c09ea7d6c9c3ef9",
"status":2,
"isMaster":true,
"resourceType":"OVERLAY_BANDWIDTH",
"resourceID":"f01b09c8914043d4b6a3216390993b2f",
"masterOrderID":"04dcdb8c73c611eeae680242ac11000b",
"updateTime":1698300492000,
"expireTime":1703570891000,
"masterResourceID":"f01b09c8914043d4b6a3216390993b2f",
"itemValue":10,
"startTime":1698300491000,
"createTime":1698300485000
}
]
},
"message":"success",
"description":"成功",
"statusCode":800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功（可能暂时未成功，首次下单后会是订单处理中，状态码为900） |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.PacketEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
