接口功能介绍
按天订购智能网关弹性带宽包
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/elastic-bandwidth-package/new
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | ||
| edgeName | 是 | String | edge的名称 | ||
| edgeID | 是 | String | edge的ID | ||
| bandwidth | 是 | Integer | 智能网关APP 带宽 | 100 | |
| onDemand | 否 | Boolean | 是否按需下单。默认为false | false | |
| cycleType | 是 | String | 本参数表示包周期类型 取值范围: DAY:按天 onDemand为False时，必须指定。 |
||
| cycleCount | 是 | Integer | 包周期数。onDemand为False时必须指定。周期最大长度不能超过30天 | ||
| effectiveTime | 否 | String | 生效时间，如果没有设置实时生效，如果设置时间只能设置当前时间之后的时间点 | 2023-03-02 17:50:50 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | 否 | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。 | ||
| masterOrderNO | 否 | String | 订单号 | ||
| masterResourceID | 否 | String | 主资源ID | ||
| masterResourceStatus | 否 | String | 主资源状态。只有主订单资源会返回 | ||
| regionID | 否 | String | 资源所属资源池ID | ||
| resources | 否 | Object | 资源明细列表,参考表Resource | Resource |
表 Resource
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourceID | 否 | String | 单项资源的变配、续订、退订等需要该资源项的ID。 | ||
| orderID | 否 | String | 无需关心 | ||
| startTime | 否 | Integer | 启动时刻，epoch时戳，毫秒精度 | ||
| expireTime | 否 | Integer | 过期时刻，epoch时戳，毫秒精度 | ||
| createTime | 否 | Integer | 创建时刻，epoch时戳，毫秒精度 | ||
| updateTime | 否 | Integer | 更新时刻，epoch时戳，毫秒精度 | ||
| status | 否 | Integer | 本参数表示订单状态 取值范围： 1:待支付 2:已支付 3:完成 4:取消 5:施工失败 |
||
| isMaster | 否 | Boolean | 是否是主资源项 | ||
| itemValue | 否 | Integer | 资源规格，带宽大小 | ||
| resourceType | 否 | String | 资源类型 | SD_WAN_GATEWAY | |
| masterOrderID | 否 | String | 主订单ID | 5dcc43de72fa4b719d77fa7fb469ea5c | |
| masterResourceID | 否 | String | 主资源ID | 74691a122f0040c89d169343f726dcdd |
请求示例
请求头header
无
请求体body
可使用同clientToken重试下单，查询订单是否成功
{
"clientToken": "any-uniqure-string",
"edgeName": "openapi-sdwanapp-01",
"edgeID": "b35fcd88-5e7b-11ed-9fa7-525400af7402",
"onDemand": False,
"cycleType": "DAY",
"cycleCount": 1,
"bandwidth": 5,
"effectiveTime": "2023-03-02 17:50:50"
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": null,
"masterOrderID": "5b1cfc9e746a11eeb0530242ac110009",
"masterResourceID": "af651c16f47d4f60bdb136d36672fbe6",
"masterOrderNO": null,
"resources": [
{
"orderID": "093c739a89b640fab801d0fab3b1b73b",
"status": 2,
"isMaster": true,
"resourceType": "SD_WAN_eBANDWIDTH",
"resourceID": "af651c16f47d4f60bdb136d36672fbe6",
"masterOrderID": "5b1cfc9e746a11eeb0530242ac110009",
"updateTime": 1698403448000,
"expireTime": 1698489848000,
"masterResourceID": "af651c16f47d4f60bdb136d36672fbe6",
"itemValue": 5,
"startTime": 1698403448000,
"createTime": 1698371067000
}
]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功(可能暂时未成功，首次下单后会是订单处理中,状态码为900) |
错误码
| errorCode | 含义 |
|---|---|
| Sdwan.Order.AccessFailed | 订单系统访问失败，可使用clientToken重试订单 |
| Sdwan.Order.InProgress | 订单处理中，可使用订单ID查询确认或使用原clientToken重试下单 |
| Sdwan.Order.ProcFailed | 订单处理失败。无需重试。通过errorDetail确认具体失败原因 |
| Sdwan.Order.OrderChanged | 订单状态变更，比如发生了撤单，取消等。 |
