接口功能介绍
支持按需/包年包月订购SDWAN智能网关。
接口约束
用户SDWAN智能网关配额未满；用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单。
URI
POST /v4/sdwan/new
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | ||
| deviceType | 是 | String | 本参数表示订购的网关形态。 取值范围： hardware：硬件形态 software：软件形态 |
||
| baseInfo | 是 | Object | 网关开通基础信息 | ||
| gatewayInfo | 否 | Object | 智能网关资源，deviceType=hareware必填 | ||
| softwareInfo | 否 | Object | 智能网关资源，deviceType=software必填 | ||
| addrInfo | 否 | Object | 联系人地址信息 | ||
| addedService | 否 | Object | 增值业务 | ||
| onDemand | 否 | Boolean | 是否按需下单。默认为False | ||
| cycleType | 否 | String | 本参数表示包周期类型。 取值范围： YEAR：按年包 MONTH：按月包 当onDemand为false时，必须指定。 |
||
| cycleCount | 否 | Integer | 包周期数。onDemand为false时必须指定。周期最大长度不能超过36个月 |
表baseInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeName | 是 | String | 智能网关实例名称 | ||
| bandwidth | 是 | Integer | 网关带宽 | ||
| desc | 否 | String | 描述 |
表gatewayInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| isInstall | 是 | Integer | 本参数表示订购的智能网关是否需要装维服务。 取值范围： 1：需要 0：不需要 |
||
| edgeType | 是 | String | 本参数表示订购的智能网关要开通的设备类型。 取值范围： economic：经济型 standard：标准版 enterprise：企业版 enhance：企业增强版 |
||
| useType | 是 | String | 本参数表示订购的智能网关使用方式。 取值范围： singleNode：单机 activeStandby：双机备份 |
表softwareInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeType | 是 | String | 本参数表示订购的智能网关要开通的设备类型。 取值范围： gateway：软件网关 |
||
| useType | 是 | String | 本参数表示订购的智能网关使用方式。 取值范围： singleNode：单机 |
表addrInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 客户联系人姓名 | ||
| mobile | 是 | String | 客户联系人电话 | ||
| spareMobile | 否 | String | 客户联系人备用电话 | ||
| 是 | String | 客户联系人邮箱 | |||
| province | 是 | String | 客户联系人省份 | ||
| city | 是 | String | 客户联系人城市 | ||
| address | 是 | String | 客户联系人详细地址 |
表addedService
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| is5G | 否 | Boolean | 是否支持5G,默认为否 | false | |
| isWIFI | 否 | Boolean | 是否支持WIFI,默认为否 | ||
| isLTE | 否 | Boolean | 是否支持LTE,默认为否 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | 否 | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用masterOrderID进一步确认订单状态及资源状态。 | ||
| masterOrderNO | 否 | String | 订单号 | ||
| masterResourceID | 否 | String | 主资源ID。 | ||
| masterResourceStatus | 否 | String | 主资源状态。只有主订单资源会返回 | ||
| regionID | 否 | String | 资源所属资源池ID | ||
| resources | 否 | Object | 资源明细列表,参考表resources | resources |
表 resources
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourceID | 否 | String | 单项资源的变配、续订、退订等需要该资源项的ID。 | ||
| orderID | 否 | String | 无需关心 | ||
| startTime | 否 | Integer | 启动时刻，epoch时戳，毫秒精度 | ||
| expireTime | 否 | Integer | 过期时刻，epoch时戳，毫秒精度 | ||
| createTime | 否 | Integer | 创建时刻，epoch时戳，毫秒精度 | ||
| updateTime | 否 | Integer | 更新时刻，epoch时戳，毫秒精度 | ||
| status | 否 | Integer | 资源状态，无需关心。参考masterResourceStatus | ||
| isMaster | 否 | Boolean | 是否是主资源项 | ||
| itemValue | 否 | Integer | 资源规格，网关带宽大小 | ||
| resourceType | 否 | String | 资源类型 | SD_WAN_GATEWAY | |
| masterOrderID | 否 | String | 主订单ID | 5dcc43de72fa4b719d77fa7fb469ea5c | |
| masterResourceID | 否 | String | 主资源ID | 74691a122f0040c89d169343f726dcdd |
请求示例
请求头header
无
请求体body
可使用同clientToken重试下单，查询订单是否成功
{
"clientToken": "new1order2test3for4sdwan111201",
"onDemand": false,
"cycleType": "YEAR",
"cycleCount": 1,
"deviceType": "hardware",
"baseInfo": {
"edgeName": "edge111201-openapi",
"desc": "test",
"bandwidth": 5
},
"gatewayInfo": {
"isInstall": 1,
"edgeType": "economic",
"useType": "singleNode"
},
"addrInfo": {
"name": "openapi-test",
"mobile": "13000000000",
"spareMobile": "13111111111",
"email": "asd@123.com",
"province": "河北",
"city": "shijiazhuang",
"address": "哈哈哈"
},
"addedService": {
"is5G": true,
"isWIFI": false,
"isLTE": false
}
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": null,
"masterOrderID": "cef90828747011eea1490242ac110009",
"masterResourceID": "74691a122f0040c89d169343f726dcdd",
"masterOrderNO": null,
"resources": [
{
"orderID": "5e83db147c954fcb924e3b186c4f418b",
"status": 2,
"isMaster": true,
"resourceType": "SD_WAN_BANDWIDTH",
"resourceID": "74691a122f0040c89d169343f726dcdd",
"masterOrderID": "cef90828747011eea1490242ac110009",
"updateTime": 1698403428000,
"expireTime": 1730025827000,
"masterResourceID": "74691a122f0040c89d169343f726dcdd",
"itemValue": 5,
"startTime": 1698403427000,
"createTime": 1698373846000
},
{
"orderID": "5e83db147c954fcb924e3b186c4f418b",
"status": 2,
"isMaster": false,
"resourceType": "SD_WAN_INSTALL-SERVICE",
"resourceID": "7aba831260f24cdfb08542081c8d4c3d",
"masterOrderID": "cef90828747011eea1490242ac110009",
"updateTime": 1698403428000,
"expireTime": 1730025827000,
"masterResourceID": "74691a122f0040c89d169343f726dcdd",
"itemValue": 1,
"startTime": 1698403427000,
"createTime": 1698373846000
},
{
"orderID": "5e83db147c954fcb924e3b186c4f418b",
"status": 2,
"isMaster": false,
"resourceType": "SD_WAN_GATEWAY",
"resourceID": "5dcc43de72fa4b719d77fa7fb469ea5c",
"masterOrderID": "cef90828747011eea1490242ac110009",
"updateTime": 1698403428000,
"expireTime": 1730025827000,
"masterResourceID": "74691a122f0040c89d169343f726dcdd",
"itemValue": 1,
"startTime": 1698403427000,
"createTime": 1698373846000
}
]
},
"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 | 订单状态变更，比如发生了撤单，取消等。 |
