接口功能介绍
edge激活,设备类型包括:经济版、标准版、企业版、企业增强版、VCPE、PON口CPE
接口约束
输入参数名称类长度不超过64位,描述类长度不超过128位
旁挂激活时,lanControlIP和lanBusinessIP必须同网段
slaveLanBusinessIP和slaveLanControlIP必须同网段
URI
POST /v4/sdwan/edge-active/create
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
edgeID | 是 | String | edge的ID | 65768712-3890-11ed-a977-005056898fe0 | |
edgeCIDR | 是 | Array Of Strings | edge的子网 ,值类型为string | ["2.3.4.0/24","12.3.4.0/24"] | |
deployMode | 是 | String | 本参数表示接入方式 取值范围: inline-mode:串接 dual-arm-mode:双臂旁挂 single-arm-mode:单臂旁挂 |
inline-mode | |
dhcpDisable | 否 | Boolean | 串联模式下必填,是否关闭dhcp,默认值为False | False | |
lanControlIP | 否 | String | lan侧管理IP,旁挂必填,网段格式,IP的最后一个网段不能为0 | 12.3.6.5/24 | |
lanBusinessIP | 否 | String | lan侧业务IP,旁挂必填,网段格式,IP的最后一个网段不能为0 | 12.3.6.7/24 | |
lanBusinessIPv6 | 否 | String | lan侧业务IPv6,旁挂必填,网段格式 | 1234::12/24 | |
lanControlIPv6 | 否 | String | lan侧管理IPv6,旁挂必填,网段格式 | 1234::13/24 | |
lanVrrpIP | 否 | String | lan侧业务虚IP,旁挂必填,网段格式,IP的最后一个网段不能为0 | 12.3.4.6/24 | |
lanVrrpIPv6 | 否 | String | lan侧业务虚IPV6,旁挂必填,网段格式 | 12::23/24 | |
slaveLanControlIP | 否 | String | 备用设备lan侧管理IP,旁挂必填,网段格式,IP的最后一个网段不能为0 | 12.4.5.6/24 | |
slaveLanBusinessIP | 否 | String | 备用设备lan侧业务IP,旁挂必填,网段格式,IP的最后一个网段不能为0 | 12.4.5.8/24 | |
dcID | 是 | String | 资源池ID | 9aa1a302-388d-11ed-a977-005056898fe0 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码(800为成功,900为失败) ,默认值:800 | 800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 否 | Array of Objects | 返回参数 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
operationID | 否 | String | 操作日志Id | b516628e-380d-11ed-a977-005056898fe0 |
请求示例
请求头header
无
请求体body
{
"edgeID": "65768712-3890-11ed-a977-005056898fe0",
"edgeCIDR": ["2.3.4.0/24","12.3.3.0/24"],
"deployMode": "inline-mode",
"dhcpDisable": False,
"lanControlIP": "12.3.6.5/24",
"lanBusinessIP": "12.3.6.7/24",
"lanBusinessIPv6": "1234::12/24",
"lanControlIPv6": "1234::13/24",
"lanVrrpIP": "12.3.4.6/24",
"lanVrrpIPv6": "12::23/24",
"slaveLanControlIP": "12.4.5.6/24",
"slaveLanBusinessIP": "12.4.5.8/24",
"dcID": "9aa1a302-388d-11ed-a977-005056898fe0"
}
响应示例
{
"statusCode": 800,
"returnObj": [
{
"operationID": "9aa1a302-388d-11ed-a977-005056898fe0"
}
],
"errorCode": "",
"message": "",
"description": ""
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |