接口功能介绍

支持按需/包年包月订购SDWAN智能网关。

接口约束

用户SDWAN智能网关配额未满；用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单。

URI

POST /v4/sdwan/new

路径参数 无

Query参数 无

请求参数

请求头header参数 无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
clientToken	否	String	客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。
deviceType	是	String	本参数表示网关形态取值范围： hardware:硬件 software:软件
baseInfo	是	Object	网关开通基础信息		baseInfo
gatewayInfo	否	Object	智能网关资源，deviceType=hareware必填		gatewayInfo
softwareInfo	否	Object	智能网关资源，deviceType=software必填		softwareInfo
addrInfo	否	Object	联系人地址信息		addrInfo
addedService	否	Object	增值业务		addedService
onDemand	否	Boolean	是否按需下单。默认为False
cycleType	否	String	包周期类型，YEAR/MONTH。onDemand为false时，必须指定。
cycleCount	否	Integer	包周期数。onDemand为false时必须指定。周期最大长度不能超过36个月	6

表 baseInfo

参数	是否必填	参数类型	说明	示例
edgeName	是	String	智能网关实例名称
bandwidth	是	Integer	网关带宽	10
desc	否	String	描述

表 gatewayInfo

参数	是否必填	参数类型	说明	示例
isInstall	是	Integer	智能网关是否需要装维1-是， 0-否	1
edgeType	是	String	本参数表示设备类型取值范围： economic:经济 standard:标准 enterprise:企业 enhance:增强
useType	是	String	本参数表示使用方式取值范围： singleNode:单机 activeStandby:旁挂

表 softwareInfo

参数	是否必填	参数类型	说明	示例	下级对象
edgeType	是	String	本参数表示设备类型取值范围： gateway:网关
useType	是	String	本参数表示使用方式取值范围： singleNode:单机

表 addrInfo

参数	是否必填	参数类型	说明
name	是	String	客户联系人姓名
mobile	是	String	客户联系人电话
spareMobile	否	String	客户联系人备用电话
email	是	String	客户联系人邮箱
province	是	String	客户联系人省份
city	是	String	客户联系人城市
address	是	String	客户联系人详细地址

表 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三段式码.
details	String	错误明细。一般情况下，会对订单侧(bss)的SDWAN智能网关订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。
error	String	业务细分码，为product.module.code三段式码.

表 returnObj

参数	参数类型	说明	示例	下级对象
masterOrderID	String	订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。
masterOrderNO	String	订单号
masterResourceID	String	主资源ID。
masterResourceStatus	String	资源状态: started（启用） / renewed（续订） / refunded（退订） / destroyed（销毁） / failed（失败） / starting（正在启用） / changed（变配）/ expired（过期）/ unknown（未知）	started
regionID	String	资源所属资源池ID
resources	Object	资源明细列表,参考表resources		resources

表 resources

参数	参数类型	说明	示例	下级对象
resourceID	String	单项资源的变配、续订、退订等需要该资源项的ID。比如某个云主机资源作为主资源，对其挂载
orderID	String	无需关心
startTime	Integer	启动时刻，epoch时戳，毫秒精度	1000
expireTime	Integer	过期时刻，epoch时戳，毫秒精度	1000
createTime	Integer	创建时刻，epoch时戳，毫秒精度	1000
updateTime	Integer	更新时刻，epoch时戳，毫秒精度	1000
status	Integer	资源状态，无需关心	1
isMaster	Boolean	是否是主资源项	true
itemValue	Integer	资源规格，网关带宽大小	1000
resourceConfig	Object	智能网关订单相关资源配置(这里不做描述)		resourceConfig

枚举参数

无

请求示例

请求url

无

请求头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": "b0646502627311edbf3f0242ac110011",
        "masterResourceID": "38ce85bb19fa4fd7bb3db3db7ca8ac8f",
        "masterOrderNO": null,
        "resources": [
            {
                "orderID": "2ffd87a8550b47e083e68f6b9ab4befa",
                "status": 2,
                "isMaster": true,
                "resourceType": "SD_WAN_BANDWIDTH",
                "resourceID": "38ce85bb19fa4fd7bb3db3db7ca8ac8f",
                "masterOrderID": "b0646502627311edbf3f0242ac110011",
                "updateTime": 1668248839000,
                "masterResourceID": "38ce85bb19fa4fd7bb3db3db7ca8ac8f",
                "itemValue": 5,
                "startTime": 1668248838000,
                "resourceConfig": {
                    "bizpackage": "standard",
                    "edgeid": "",
                    "projectID": "0",
                    "number": "5",
                    "isfive": "0",
                    "edition": "highAvailability",
                    "single": "",
                    "buydevice": "1",
                    "installcity": "北上广深",
                    "size": "5",
                    "caccountnum": "10",
                    "area": "mainland",
                    "serviceprovider": "yihuilian",
                    "edgename": "edge111201-openapi",
                    "usetype": "singleNode",
                    "ifautorenew": "false",
                    "version": "v2",
                    "vender": "yihuilian",
                    "type": "service",
                    "spec": "standard",
                    "autorenewcyclecnt": "0",
                    "projectno": "standard",
                    "enterpriseproject": "default",
                    "prodissupportedcredit": "PUB_100_02_0001",
                    "isauto": "1",
                    "devicetype": "hardware",
                    "ha": "N",
                    "zonetype": "",
                    "desc": "test",
                    "projecttype": "0",
                    "adminUrl": "http: //admin.huidu.inner.cn: 38082/",
                    "region": "",
                    "value": "5",
                    "loginemail": "",
                    "mt": "1",
                    "bw": "10",
                    "billmode": "",
                    "4g": "N",
                    "bandwidthtype": "SDWAN_BANDWIDTH",
                    "installmode": "1"
                },
                "createTime": 1668248462000
            },
            {
                "orderID": "2ffd87a8550b47e083e68f6b9ab4befa",
                "status": 2,
                "isMaster": false,
                "resourceType": "SD_WAN_INSTALL-SERVICE",
                "resourceID": "dea23e787e7f4f718647c556eccc920a",
                "masterOrderID": "b0646502627311edbf3f0242ac110011",
                "updateTime": 1668248839000,
                "masterResourceID": "38ce85bb19fa4fd7bb3db3db7ca8ac8f",
                "itemValue": 1,
                "startTime": 1668248838000,
                "resourceConfig": {
                    "city": "非北上广深",
                    "area": "mainland",
                    "adminUrl": "http: //admin.huidu.inner.cn: 38082/",
                    "projectID": "0",
                    "number": "1",
                    "value": "1",
                    "edition": "highAvailability",
                    "version": "v2",
                    "vender": "yihuilian",
                    "type": "standard",
                    "installmode": "1"
                },
                "createTime": 1668248462000
            },
            {
                "orderID": "2ffd87a8550b47e083e68f6b9ab4befa",
                "status": 2,
                "isMaster": false,
                "resourceType": "SD_WAN_GATEWAY",
                "resourceID": "1826dc46d4fb4f37aab6595d74bc43b6",
                "masterOrderID": "b0646502627311edbf3f0242ac110011",
                "updateTime": 1668248839000,
                "masterResourceID": "38ce85bb19fa4fd7bb3db3db7ca8ac8f",
                "itemValue": 1,
                "startTime": 1668248838000,
                "resourceConfig": {
                    "bizpackage": "standard",
                    "addrinfo": "
                    {
                        \"address\": \"哈哈哈\",
                        \"city\": \"shijiazhuang\",
                        \"mobile\": \"13000000000\",
                        \"spareMobile\": \"13111111111\",
                        \"province\": \"河北\",
                        \"name\": \"openapi-test\",
                        \"email\": \"asd@123.com\"
                    }
                    ",
                    "projectID": "0",
                    "number": "1",
                    "isfive": "0",
                    "ordernum": "1",
                    "edition": "highAvailability",
                    "single": "",
                    "buydevice": "1",
                    "loginemail": "",
                    "size": "1",
                    "hasnetworking": "",
                    "isauto": "1",
                    "area": "mainland",
                    "incloudvpclist": "",
                    "ifautorenew": "false",
                    "version": "v2",
                    "vender": "yihuilian",
                    "type": "singleNode",
                    "spec": "economic",
                    "accessinfo": "",
                    "autorenewcyclecnt": "0",
                    "projectno": "standard",
                    "enterpriseproject": "default",
                    "prodissupportedcredit": "PUB_100_02_0001",
                    "bw": "1",
                    "devicetype": "hardware",
                    "ha": "0",
                    "zonetype": "",
                    "projecttype": "0",
                    "adminUrl": "http: //admin.huidu.inner.cn: 38082/",
                    "value": "1",
                    "installcity": "非北上广深",
                    "mt": "1",
                    "billmode": "",
                    "extbandwidth": "1",
                    "installmode": "1"
                },
                "createTime": 1668248462000
            }
        ]
    },
    "details": "",
    "errorCode": "",
    "error": "",
    "message": "success",
    "description": "成功",
    "statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

天翼云SD-WAN

天翼云SD-WAN

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

天翼云SD-WAN

天翼云SD-WAN

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码