接口功能介绍
包年包月订购智能网关询价。
接口约束
输入参数名称类长度不超过64,描述类长度不超过128
URI
POST /v4/sdwan/query-price-new
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
deviceType | 是 | String | 本参数表示网关形态 取值范围: hardware:硬件 software:软件 |
hardware | |
baseInfo | 是 | Object | 网关开通基础信息 | baseInfo | |
gatewayInfo | 否 | Object | 智能网关资源,当上面的参数deviceType=hareware,此参数必填 | gatewayInfo | |
softwareInfo | 否 | Object | 智能网关资源,当上面的参数deviceType=software,此参数必填 | softwareInfo | |
addrInfo | 是 | Object | 联系人地址信息 | addrInfo | |
addedService | 是 | Object | 增值业务 | addedService | |
cycleType | 是 | String | 包周期类型,YEAR/MONTH。必须指定。 | MONTH | |
cycleCount | 是 | Integer | 包周期数。onDemand为false时必须指定。周期最大长度不能超过36个月 | 6 |
表baseInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
edgeName | 是 | String | 智能网关实例名称,长度不超过64位 | edge-001 | |
bandwidth | 是 | Integer | 网关带宽,单位Mbps,最大值1000 | 10 | |
desc | 否 | String | 描述,长度不超过128位 | 上海edge |
表gatewayInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
isInstall | 是 | Integer | 智能网关是否需要装维1-是, 0-否 | 1 | |
edgeType | 是 | String | 本参数表示设备类型 取值范围: economic:经济 standard:标准 enterprise:企业 enhance:增强 |
economic | |
useType | 是 | String | 本参数表示使用方式 取值范围: singleNode:单机 activeStandby:旁挂 |
singleNode |
表softwareInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
edgeType | 是 | String | 本参数表示设备类型 取值范围: gateway:网关 |
gateway | |
useType | 是 | String | 本参数表示使用方式 取值范围: singleNode:单机 |
singleNode |
表 addrInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 客户联系人姓名,长度不超过64位 | openapi-user | |
mobile | 是 | String | 客户联系人电话,长度不超过64位 | 13000000000 | |
spareMobile | 否 | String | 客户联系人备用电话,长度不超过64位 | 13111111111 | |
是 | String | 客户联系人邮箱,长度不超过64位 | asd@123.com | ||
province | 是 | String | 客户联系人省份,长度不超过64位 | 河北 | |
city | 是 | String | 客户联系人城市,长度不超过64位 | 保定 | |
address | 是 | String | 客户联系人详细地址,长度不超过64位 | 河北保定 |
表 addedService
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
is5G | 否 | Boolean | 是否支持5G,默认为否 | true | |
isWIFI | 否 | Boolean | 是否支持WIFI,默认为否 | true | |
isLTE | 否 | Boolean | 是否支持LTE,默认为否 | true |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码(800为成功,900为失败) | 800 | |
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 否 | Object | 返回参数列表 | returnObj | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码. |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPrice | 否 | Float | 总价,单位人民币/元 | 375.0 | |
isSucceed | 否 | Boolean | 是否成功 | true | |
subOrderPrices | 否 | Array of Objects | 订单价格列表。 | subOrderPrice | |
finalPrice | 否 | Float | 最终价格,单位人民币/元 | 375.0 |
表 subOrderPrice
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
serviceTag | 否 | String | 服务标识 | SD_WAN | |
totalPrice | 否 | Float | 总价,单位人民币/元 | 375.0 | |
orderItemPrices | 否 | Array of Objects | 单项价格列表。 | orderItemPrice | |
finalPrice | 否 | Float | 最终价格,单位人民币/元 | 375.0 |
表 orderItemPrice
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
itemId | 否 | String | 单项ID | 5c31576a763f4704be791e21e5dc79c8 | |
totalPrice | 否 | Float | 总价,单位人民币/元 | 375.0 | |
resourceType | 否 | String | 资源类型。 | SD_WAN_GATEWAY | |
finalPrice | 否 | Float | 最终价格,单位人民币/元 | 375.0 |
请求示例
请求头header
无
请求体body
可使用同clientToken重试下单,查询订单是否成功
{
"cycleType": "MONTH",
"cycleCount": 1,
"deviceType": "hardware",
"baseInfo": {
"edgeName": "edge1122-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": {
"totalPrice": 375.0,
"isSucceed": true,
"subOrderPrices": [
{
"serviceTag": "SD_WAN",
"totalPrice": 375.0,
"orderItemPrices": [
{
"itemId": "e6b44f91cb944d23a14909bf107c7427",
"resourceType": "SD_WAN_BANDWIDTH",
"totalPrice": 225.0,
"finalPrice": 225.0
},
{
"itemId": "5c31576a763f4704be791e21e5dc79c8",
"resourceType": "SD_WAN_GATEWAY",
"totalPrice": 150.0,
"finalPrice": 150.0
}
],
"finalPrice": 375.0
}
],
"finalPrice": 375.0
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求未成功(可能暂时未成功,首次下单后会是订单处理中,状态码为900) |
错误码
errorCode | 含义 |
---|---|
Sdwan.Order.AccessFailed | 订单系统访问失败,可使用clientToken重试订单 |
Sdwan.Order.InProgress | 订单处理中,可使用订单ID查询确认或使用原clientToken重试下单 |
Sdwan.Order.ProcFailed | 订单处理失败。无需重试。通过errorDetail确认具体失败原因 |
Sdwan.Order.OrderChanged | 订单状态变更,比如发生了撤单,取消等 |