创建站点
典型场景
创建站点。
接口功能
创建站点。
接口约束
该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。
调用方法
POST
URI
/controller/campus/v1/sdwan/net/sites
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
siteInfos |
是 |
REFERENCE |
详细请参见表2。 |
需创建的站点信息列表。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
sites |
否 |
ARRAY_REFERENCE |
1-100个列表项,详细请参见表3。 |
站点参数列表,一次最多操作100个站点 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
id |
否 |
uuid |
- |
- |
站点ID,格式为uuid。更新和删除时必填。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
name |
否 |
string |
0~64个字符。 |
- |
站点名称。支持配置中英文,数字,特殊字符(!"#$%&'()*+,_-./:;<=>@[]^`{|}~)。创建时必填。 |
"site1" |
locations |
否 |
ARRAY_REFERENCE |
0-2个列表项,详细请参见表4。 |
位置信息列表。创建时必填。 |
- |
|
devices |
否 |
ARRAY_REFERENCE |
0-2个列表项,详细请参见表5。 |
设备及对应的位置列表。站点为单网关时为一台设备;双网关时两台设备且必须同时填写。 |
- |
|
siteType |
否 |
string |
0~14个字符。 |
single-gateway |
站点类型。single-gateway:单网关,dual-gateways:双网关。创建时必填。 |
"single-gateway" |
interLink |
否 |
REFERENCE |
详细请参见表6。 |
双网关之间的内链路,当siteType为dual-gateways时填写。 |
- |
|
role |
否 |
array<string> |
1-3 个列表项。每个列表项0~12个字符。 |
- |
创建时必填。取值范围:"sd-wan-edge"、"evpn-rr"。"sd-wan-edge"表示边缘站点,"evpn-rr"表示控制站点,["sd-wan-edge","evpn-rr"]表示边缘站点和控制站点合设,暂不支持单设"evpn-rr"控制站点。 |
["sd-wan-edge","evpn-rr"] |
controlPoints |
否 |
array<string> |
0-2 个列表项。每个列表项0~64个字符。 |
- |
关联RR站点UUID。 |
["a99f794e-b510-438c-a75d-de59f02347eb"] |
timeZone |
否 |
string |
0~255个字符。 |
- |
时区信息。 |
"(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi" |
enableSummerConfig |
否 |
boolean |
|
- |
是否开启夏令时。当timeZone为空时,enableSummerConfig不生效。默认值为false。 |
- |
enableAutoConfig |
否 |
boolean |
|
- |
是否自动给设备下发夏令时时间,当enableSummerConfig为true时才生效,默认值为true。当enableAutoConfig为true时,daylightSavingTime必须为空,控制器会根据时区自动获取夏令时时间并下发给站点内的设备,否则daylightSavingTime必填。 |
true |
daylightSavingTime |
否 |
REFERENCE |
详细请参见表8。 |
夏令时配置信息。 |
- |
|
contact |
否 |
REFERENCE |
详细请参见表10。 |
站点联系人信息。 |
- |
|
description |
否 |
string |
0~256个字符。 |
- |
站点描述。 |
"sdwan Site" |
tag |
否 |
string |
0~64个字符。 |
- |
站点标签。 |
"tagHub" |
isolated |
否 |
boolean |
|
- |
站点隔离状态。只支持查询。 |
false |
enhancedMode |
否 |
boolean |
|
- |
增强模式。默认值为false。只支持查询。 |
false |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
name |
是 |
string |
1~64个字符。 |
- |
位置名称。可配置为字母,数字,特殊字符,其中特殊字符包含:_-/。 |
"Beijing" |
address |
否 |
string |
0~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 地址。 |
"Beijing" |
floor |
否 |
string |
0~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 楼层信息。 |
"5F" |
postcode |
否 |
string |
0~32个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 邮编。可配置为字母,数字,连字符(-)。 |
"100000" |
latitude |
否 |
string |
0~128个字符。 |
- |
纬度。取值范围:[-90, 90]。 |
"39.92" |
longitude |
否 |
string |
0~128个字符。 |
- |
经度。取值范围:[-180, 180]。 |
"116.46" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
deviceId |
是 |
string |
1~64个字符。 |
- |
设备ID。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
locationName |
是 |
string |
1~64个字符。 |
- |
设备对应的位置名称。 |
"nanjing" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
type |
是 |
string |
12个字符。 |
l3-interface |
内联链路端口类型。l3-interface:L3接口。l2-interface:L2接口。当端口类型为l2-interface时,请确保设备上对应的物理口支持切换为二层口,否则设备上线后,内链路端口配置下发失败,需要重新配置。 |
"l3-interface" |
enableGre |
否 |
boolean |
|
false |
是否启用GRE隧道。使能时双网关间链路使用GRE隧道。此开关仅AR6700V-L款型设备支持,且配置使能时type必须为l3-interface。 |
false |
vlanMin |
否 |
int32 |
[1-4086] |
- |
当type为L2的时候,最小值为2;当type为L3的时候,最小值为1。不能和extendVlans同时填写,推荐使用extendVlans。 |
4000 |
vlanMax |
否 |
int32 |
[9-4094] |
- |
vlanMin-vlanMax之间只能存在9个vlan。不能和extendVlans同时填写,推荐使用extendVlans。 |
4008 |
extendVlans |
否 |
array<string> |
1-16 个列表项。每个列表项0~10个字符。 |
- |
扩展vlan范围,总vlanId数范围:[9,301]。左边数字必须小于右边数字,且差值要在8和300之间。extendVlans和vlanMin-vlanMax只能填一种,推荐使用extendVlans。 |
["1:9"] |
portPairs |
是 |
ARRAY_REFERENCE |
1-2个列表项,详细请参见表7。 |
双网关至少一组,L3一组为子接口,L3两组自动成为以太trunk端口;L2都是Vlanif接口。 |
- |
|
mtu |
否 |
int32 |
[256-9000] |
- |
mtu,取值范围256-9000,默认值1500。三层子接口和以太trunk端口推荐最大不超过8996,Vlanif接口推荐最大不超过1600。 FW网关设备不支持。 |
1500 |
mss |
否 |
int32 |
[128-2048] |
- |
mss,取值范围128-2048,默认值1200。三层子接口和以太trunk端口推荐最大不超过2048,Vlanif接口推荐最大不超过1560。 FW网关设备不支持。 |
1200 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
device1PortId |
否 |
string |
0~64个字符。 |
- |
设备1端口ID。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device2PortId |
否 |
string |
0~64个字符。 |
- |
设备2端口ID。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device1Id |
否 |
string |
0~64个字符。 |
- |
设备1 ID。device1PortId为空时填写。可以根据device1Id,device1PortType,device1PortNum自动生成device1PortId。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device1PortType |
否 |
string |
0~64个字符。 |
- |
设备1端口类型,取值范围:GE、FE、XGE、40GE、MultiGE、25GE。创建和更新内部链路,device1PortId为空时填写。可以根据device1Id,device1PortType,device1PortNum自动生成device1PortId。 |
"GE" |
device1PortNum |
否 |
string |
0~64个字符。 |
- |
设备1端口号。创建和更新内部链路,device1PortId为空时填写。可以根据device1Id,device1PortType,device1PortNum自动创建device1PortId。 |
"0/0/1" |
device1PortAddress |
否 |
string |
0~64个字符。 |
- |
设备1端口地址,仅双网关为GRE隧道时填写生效。 |
"192.168.101.1" |
device1PortMask |
否 |
int32 |
[1-32] |
- |
设备1端口地址掩码,仅双网关为GRE隧道时填写生效。 |
24 |
device2Id |
否 |
string |
0~64个字符。 |
- |
设备2 ID。device2PortId为空时填写。可以根据device2Id,device2PortType,device2PortNum自动生成device2PortId。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device2PortType |
否 |
string |
0~64个字符。 |
- |
设备2端口类型,取值范围:GE、FE、XGE、40GE、MultiGE、25GE。创建和更新内部链路,device2PortId为空时填写。可以根据device2Id,device2PortType,device1PortNum自动生成device2PortId。 |
"GE" |
device2PortNum |
否 |
string |
0~64个字符。 |
- |
设备2端口号。创建和更新内部链路,device2PortId为空时填写。可以根据device2Id,device2PortType,device1PortNum自动创建Port2。 |
"0/0/1" |
device2PortAddress |
否 |
string |
0~64个字符。 |
- |
设备2端口地址,仅双网关为GRE隧道时填写生效。 |
"192.168.101.1" |
device2PortMask |
否 |
int32 |
[1-32] |
- |
设备2端口地址掩码,仅双网关为GRE隧道时填写生效。 |
24 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
name |
是 |
string |
1~32个字符。 |
- |
时区名称。可配置为英文,数字,特殊字符,其中特殊字符包含:_-/。 |
"Atlantic/Canary" |
offset |
是 |
string |
1~5个字符。 |
- |
相对零时区间隔,格式为HH:MM,取值范围00:01-02:00。 |
"01:00" |
enableWeekDay |
是 |
boolean |
|
- |
夏令时使能周期。当enableWeekDay为true时,startTime和stopTime中week和weekday必填;当enableWeekDay为false时,startTime和stopTime中day必填。默认值为false。 |
false |
startTime |
是 |
REFERENCE |
详细请参见表9。 |
夏令时开始时间。 |
{"month":"Jan","time":"05:00"} |
|
stopTime |
是 |
REFERENCE |
详细请参见表9。 |
夏令时结束时间。 |
{"month":"Jan","time":"05:00"} |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
month |
是 |
string |
|
- |
指定月份,取值范围为Jan(一月),Feb(二月),Mar(三月),Apr(四月),May(五月),Jun(六月),Jul(七月),Aug(八月),Sep(九月),Oct(十月),Nov(十一月),Dec(十二月)。 |
"Jan" |
time |
是 |
string |
5个字符。 |
- |
指定时间,24小时制时间,格式为HH:MM。 |
"23:59" |
week |
否 |
string |
0~64个字符。 |
- |
指定周,取值范围为first(月份起始的第一周),second(月份起始的第二周),third(月份起始的第三周),fourth(月份起始的第四周),fifth(月份起始的第五周),last(月份起始的最后一周)。 |
"first" |
weekday |
否 |
string |
|
- |
指定工作日,取值范围为Mon(周一),Tue(周二),Wed(周三),Thu(周四),Fri(周五),Sat(周六),Sun(周日)。 |
"Mon" |
day |
否 |
int16 |
[1-31] |
- |
指定天,取值范围是1-31,2月只到28号。 |
21 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
responsiblePerson |
否 |
string |
0~64个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 责任人。支持配置中英文,数字,特殊字符(!"#$%&'()*+,_-./:;<=>@[]^`{|}~)。 |
"Jack Lee" |
phoneNumber |
否 |
string |
0~64个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 电话。按照电话格式输入,以数字或+开始。 |
"152xxxxxxxx" |
emails |
否 |
array<string> |
0-32 个列表项。每个列表项0~256个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 邮箱列表。按照邮箱格式输入,需要包含@。 |
["xxx@xxx.xxx"] |
请求示例
POST /controller/campus/v1/sdwan/net/sites HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "sites" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } ] }
响应参数
返回状态码为201:创建站点成功,响应体参考SiteResponse。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
- |
- |
错误码。 |
"0" |
errmsg |
string |
- |
- |
错误信息。 |
"" |
success |
ARRAY_REFERENCE |
0-100个列表项,详细请参见表12。 |
成功的站点信息。 |
- |
|
fail |
ARRAY_REFERENCE |
0-100个列表项,详细请参见表20。 |
失败的站点信息。 |
- |
|
processInstanceId |
string |
0~36个字符。 |
- |
编排流程实例ID,UUID格式。当接口返回码为202时非空。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
id |
uuid |
- |
- |
站点ID,格式为uuid。更新和删除时必填。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
name |
string |
0~64个字符。 |
- |
站点名称。支持配置中英文,数字,特殊字符(!"#$%&'()*+,_-./:;<=>@[]^`{|}~)。创建时必填。 |
"site1" |
locations |
ARRAY_REFERENCE |
0-2个列表项,详细请参见表13。 |
位置信息列表。创建时必填。 |
- |
|
devices |
ARRAY_REFERENCE |
0-2个列表项,详细请参见表14。 |
设备及对应的位置列表。站点为单网关时为一台设备;双网关时两台设备且必须同时填写。 |
- |
|
siteType |
string |
0~14个字符。 |
single-gateway |
站点类型。single-gateway:单网关,dual-gateways:双网关。创建时必填。 |
"single-gateway" |
interLink |
REFERENCE |
详细请参见表15。 |
双网关之间的内链路,当siteType为dual-gateways时填写。 |
- |
|
role |
array<string> |
1-3 个列表项。每个列表项0~12个字符。 |
- |
创建时必填。取值范围:"sd-wan-edge"、"evpn-rr"。"sd-wan-edge"表示边缘站点,"evpn-rr"表示控制站点,["sd-wan-edge","evpn-rr"]表示边缘站点和控制站点合设,暂不支持单设"evpn-rr"控制站点。 |
["sd-wan-edge","evpn-rr"] |
controlPoints |
array<string> |
0-2 个列表项。每个列表项0~64个字符。 |
- |
关联RR站点UUID。 |
["a99f794e-b510-438c-a75d-de59f02347eb"] |
timeZone |
string |
0~255个字符。 |
- |
时区信息。 |
"(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi" |
enableSummerConfig |
boolean |
|
- |
是否开启夏令时。当timeZone为空时,enableSummerConfig不生效。默认值为false。 |
- |
enableAutoConfig |
boolean |
|
- |
是否自动给设备下发夏令时时间,当enableSummerConfig为true时才生效,默认值为true。当enableAutoConfig为true时,daylightSavingTime必须为空,控制器会根据时区自动获取夏令时时间并下发给站点内的设备,否则daylightSavingTime必填。 |
true |
daylightSavingTime |
REFERENCE |
详细请参见表17。 |
夏令时配置信息。 |
- |
|
contact |
REFERENCE |
详细请参见表19。 |
站点联系人信息。 |
- |
|
description |
string |
0~256个字符。 |
- |
站点描述。 |
"sdwan Site" |
tag |
string |
0~64个字符。 |
- |
站点标签。 |
"tagHub" |
isolated |
boolean |
|
- |
站点隔离状态。只支持查询。 |
false |
enhancedMode |
boolean |
|
- |
增强模式。默认值为false。只支持查询。 |
false |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
name |
string |
1~64个字符。 |
- |
位置名称。可配置为字母,数字,特殊字符,其中特殊字符包含:_-/。 |
"Beijing" |
address |
string |
0~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 地址。 |
"Beijing" |
floor |
string |
0~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 楼层信息。 |
"5F" |
postcode |
string |
0~32个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 邮编。可配置为字母,数字,连字符(-)。 |
"100000" |
latitude |
string |
0~128个字符。 |
- |
纬度。取值范围:[-90, 90]。 |
"39.92" |
longitude |
string |
0~128个字符。 |
- |
经度。取值范围:[-180, 180]。 |
"116.46" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
deviceId |
string |
1~64个字符。 |
- |
设备ID。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
locationName |
string |
1~64个字符。 |
- |
设备对应的位置名称。 |
"nanjing" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
type |
string |
12个字符。 |
l3-interface |
内联链路端口类型。l3-interface:L3接口。l2-interface:L2接口。当端口类型为l2-interface时,请确保设备上对应的物理口支持切换为二层口,否则设备上线后,内链路端口配置下发失败,需要重新配置。 |
"l3-interface" |
enableGre |
boolean |
|
false |
是否启用GRE隧道。使能时双网关间链路使用GRE隧道。此开关仅AR6700V-L款型设备支持,且配置使能时type必须为l3-interface。 |
false |
vlanMin |
int32 |
[1-4086] |
- |
当type为L2的时候,最小值为2;当type为L3的时候,最小值为1。不能和extendVlans同时填写,推荐使用extendVlans。 |
4000 |
vlanMax |
int32 |
[9-4094] |
- |
vlanMin-vlanMax之间只能存在9个vlan。不能和extendVlans同时填写,推荐使用extendVlans。 |
4008 |
extendVlans |
array<string> |
1-16 个列表项。每个列表项0~10个字符。 |
- |
扩展vlan范围,总vlanId数范围:[9,301]。左边数字必须小于右边数字,且差值要在8和300之间。extendVlans和vlanMin-vlanMax只能填一种,推荐使用extendVlans。 |
["1:9"] |
portPairs |
ARRAY_REFERENCE |
1-2个列表项,详细请参见表16。 |
双网关至少一组,L3一组为子接口,L3两组自动成为以太trunk端口;L2都是Vlanif接口。 |
- |
|
mtu |
int32 |
[256-9000] |
- |
mtu,取值范围256-9000,默认值1500。三层子接口和以太trunk端口推荐最大不超过8996,Vlanif接口推荐最大不超过1600。 FW网关设备不支持。 |
1500 |
mss |
int32 |
[128-2048] |
- |
mss,取值范围128-2048,默认值1200。三层子接口和以太trunk端口推荐最大不超过2048,Vlanif接口推荐最大不超过1560。 FW网关设备不支持。 |
1200 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
device1PortId |
string |
0~64个字符。 |
- |
设备1端口ID。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device2PortId |
string |
0~64个字符。 |
- |
设备2端口ID。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device1Id |
string |
0~64个字符。 |
- |
设备1 ID。device1PortId为空时填写。可以根据device1Id,device1PortType,device1PortNum自动生成device1PortId。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device1PortType |
string |
0~64个字符。 |
- |
设备1端口类型,取值范围:GE、FE、XGE、40GE、MultiGE、25GE。创建和更新内部链路,device1PortId为空时填写。可以根据device1Id,device1PortType,device1PortNum自动生成device1PortId。 |
"GE" |
device1PortNum |
string |
0~64个字符。 |
- |
设备1端口号。创建和更新内部链路,device1PortId为空时填写。可以根据device1Id,device1PortType,device1PortNum自动创建device1PortId。 |
"0/0/1" |
device1PortAddress |
string |
0~64个字符。 |
- |
设备1端口地址,仅双网关为GRE隧道时填写生效。 |
"192.168.101.1" |
device1PortMask |
int32 |
[1-32] |
- |
设备1端口地址掩码,仅双网关为GRE隧道时填写生效。 |
24 |
device2Id |
string |
0~64个字符。 |
- |
设备2 ID。device2PortId为空时填写。可以根据device2Id,device2PortType,device2PortNum自动生成device2PortId。 |
"a99f794e-b510-438c-a75d-de59f02347eb" |
device2PortType |
string |
0~64个字符。 |
- |
设备2端口类型,取值范围:GE、FE、XGE、40GE、MultiGE、25GE。创建和更新内部链路,device2PortId为空时填写。可以根据device2Id,device2PortType,device1PortNum自动生成device2PortId。 |
"GE" |
device2PortNum |
string |
0~64个字符。 |
- |
设备2端口号。创建和更新内部链路,device2PortId为空时填写。可以根据device2Id,device2PortType,device1PortNum自动创建Port2。 |
"0/0/1" |
device2PortAddress |
string |
0~64个字符。 |
- |
设备2端口地址,仅双网关为GRE隧道时填写生效。 |
"192.168.101.1" |
device2PortMask |
int32 |
[1-32] |
- |
设备2端口地址掩码,仅双网关为GRE隧道时填写生效。 |
24 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
name |
string |
1~32个字符。 |
- |
时区名称。可配置为英文,数字,特殊字符,其中特殊字符包含:_-/。 |
"Atlantic/Canary" |
offset |
string |
1~5个字符。 |
- |
相对零时区间隔,格式为HH:MM,取值范围00:01-02:00。 |
"01:00" |
enableWeekDay |
boolean |
|
- |
夏令时使能周期。当enableWeekDay为true时,startTime和stopTime中week和weekday必填;当enableWeekDay为false时,startTime和stopTime中day必填。默认值为false。 |
false |
startTime |
REFERENCE |
详细请参见表18。 |
夏令时开始时间。 |
{"month":"Jan","time":"05:00"} |
|
stopTime |
REFERENCE |
详细请参见表18。 |
夏令时结束时间。 |
{"month":"Jan","time":"05:00"} |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
month |
string |
|
- |
指定月份,取值范围为Jan(一月),Feb(二月),Mar(三月),Apr(四月),May(五月),Jun(六月),Jul(七月),Aug(八月),Sep(九月),Oct(十月),Nov(十一月),Dec(十二月)。 |
"Jan" |
time |
string |
5个字符。 |
- |
指定时间,24小时制时间,格式为HH:MM。 |
"23:59" |
week |
string |
0~64个字符。 |
- |
指定周,取值范围为first(月份起始的第一周),second(月份起始的第二周),third(月份起始的第三周),fourth(月份起始的第四周),fifth(月份起始的第五周),last(月份起始的最后一周)。 |
"first" |
weekday |
string |
|
- |
指定工作日,取值范围为Mon(周一),Tue(周二),Wed(周三),Thu(周四),Fri(周五),Sat(周六),Sun(周日)。 |
"Mon" |
day |
int16 |
[1-31] |
- |
指定天,取值范围是1-31,2月只到28号。 |
21 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
responsiblePerson |
string |
0~64个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 责任人。支持配置中英文,数字,特殊字符(!"#$%&'()*+,_-./:;<=>@[]^`{|}~)。 |
"Jack Lee" |
phoneNumber |
string |
0~64个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 电话。按照电话格式输入,以数字或+开始。 |
"152xxxxxxxx" |
emails |
array<string> |
0-32 个列表项。每个列表项0~256个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 邮箱列表。按照邮箱格式输入,需要包含@。 |
["xxx@xxx.xxx"] |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
- |
- |
错误码。 |
"0" |
errmsg |
string |
- |
- |
错误信息。 |
"" |
data |
REFERENCE |
详细请参见表12。 |
- |
- |
返回状态码为400:校验异常。
详细信息请参见实际响应消息体。
返回状态码为500:内部错误。
详细信息请参见实际响应消息体。
响应示例
返回状态码为201:创建站点成功,响应体参考SiteResponse。
HTTP/1.1 201 Created Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } } ], "processInstanceId" : "" }
返回状态码为400:校验异常。
HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
返回状态码为500:内部错误。
HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive