智能网关弹性带宽包订购
更新时间 2026-07-30 09:30:18
最近更新时间: 2026-07-30 09:30:18
接口功能介绍
支持按需天订购智能网关弹性带宽包。
接口约束
无
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天 | 10 | |
| effectiveTime | 否 | String | 生效时间，如果没有设置实时生效，如果设置时间只能设置当前时间之后的时间点 | 2023-03-02 17:50:50 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| details | String | 错误明细。一般情况下，会对订单侧(bss)的SDWAN智能网关APP订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 | ||
| error | 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时戳，毫秒精度 | 1000 | |
| expireTime | Integer | 过期时刻，epoch时戳，毫秒精度 | 1000 | |
| createTime | Integer | 创建时刻，epoch时戳，毫秒精度 | 1000 | |
| updateTime | Integer | 更新时刻，epoch时戳，毫秒精度 | 1000 | |
| status | Integer | 资源状态，无需关心。参考masterResourceStatus | 1 | |
| isMaster | Boolean | 是否是主资源项 | true | |
| itemValue | Integer | 资源规格，带宽大小 | 100 | |
| resourceConfig | Array of Objects | 智能网关APP订单相关资源配置(这里不做描述) | resourceConfig |
枚举参数
无
请求示例
请求url
无
请求头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": "44ccd5c463f211edb6d70242ac110011",
"masterResourceID": "ea12398a1dcd4d10a14b7cfb25875bfb",
"masterOrderNO": null,
"resources": [
{
"orderID": "02534cc4ac7547dab2689534feb3ed7e",
"status": 2,
"isMaster": true,
"resourceType": "SD_WAN_eBANDWIDTH",
"resourceID": "ea12398a1dcd4d10a14b7cfb25875bfb",
"masterOrderID": "44ccd5c463f211edb6d70242ac110011",
"updateTime": 1668412816000,
"masterResourceID": "ea12398a1dcd4d10a14b7cfb25875bfb",
"itemValue": 5,
"startTime": 1668412813000,
"createTime": 1668412779000
}
]
},
"details": "",
"errorCode": "",
"error": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
