批量创建IP Subnet
典型场景
IP Subnet北向API。
接口功能
批量创建IP Subnet。
接口约束
该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。
调用方法
POST
URI
/controller/campus/v1/sdwan/overlay-network/ip-subnets
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
ipSubnetInfos |
是 |
REFERENCE |
详细请参见表2。 |
IP Subnet信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
IPSubnets |
否 |
ARRAY_REFERENCE |
1-100个列表项,详细请参见表3。 |
IP Subnet信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
vpnId |
否 |
uuid |
- |
- |
所在VPN的ID。创建时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
siteId |
否 |
uuid |
- |
- |
对应站点的ID。创建时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
deviceId |
否 |
uuid |
- |
- |
对应设备的ID。创建时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
id |
否 |
uuid |
- |
- |
IP Subnet ID,主键。创建时不填,自动生成,更新时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
interfaceType |
否 |
string |
0~16个字符。 |
- |
接口类型,取值范围:interface(三层物理接口)、sub-interface(子接口)、bd-interface(VLANIF接口)。创建时必填。 |
"interface" |
interfaceName |
否 |
string |
0~128个字符。 |
- |
接口名称,创建时不填,查询时返回。对于物理接口,如:GE0/0/0;对于子接口,如:GE0/0/0.1;对于VLANIF接口,如vlanif20。 |
"vlanif20" |
portLagFlag |
否 |
boolean |
|
false |
Lag标志位。使能时portId为Lag的ID反之为port的ID。 |
false |
portId |
否 |
uuid |
- |
- |
接口ID,接口类型为interface、sub-interface时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
vlanId |
否 |
int32 |
[1-4094] |
- |
接口类型为sub-interface时必填,表示子接口号;接口类型为bd-interface时必填,表示引用的bridge domain。 |
1 |
subInterfaceName |
否 |
string |
0~128个字符。 |
- |
子接口名称,创建时选填,如果填写了该参数,则子接口以填写的为准;如果不填,则使用interfacName+vlanId自动拼接。该参数只对interfaceType为sub-interface生效,其他类型不生效。不允许修改。 |
"GE0/0/0.1" |
trustEnable |
否 |
boolean |
|
false |
trust使能开关。接口类型为sub-interface时填写。 |
false |
trust |
否 |
string |
|
- |
trust选项。 |
"dscp" |
ipAddress |
否 |
string |
0~32个字符。 |
- |
IP地址。使能IPv4时填写。 |
"192.168.1.1" |
prefixLength |
否 |
int32 |
[1-32] |
- |
掩码。使能IPv4时填写。 |
24 |
secondaryIP |
否 |
array<string> |
0-31 个列表项。每个列表项0~64个字符。 |
- |
接口从IP地址。使能IPv4时填写。 |
["10.10.10.2/24","10.10.11.2/24"] |
siteName |
否 |
string |
- |
- |
站点名称。仅查询接口使用。 |
"site" |
deviceName |
否 |
string |
- |
- |
设备名称。仅查询接口使用。 |
"device" |
vrrp |
否 |
REFERENCE |
详细请参见表4。 |
VRRP信息。使能IPv4时填写。 |
- |
|
dhcp |
否 |
REFERENCE |
详细请参见表8。 |
Dhcp信息。使能IPv4时填写。 |
- |
|
securityZone |
否 |
string |
0~32个字符。 |
trust |
安全域,取值范围:trust、untrust、自定义安全域。 |
"trust" |
proxyArp |
否 |
boolean |
|
false |
开启Proxy ARP。使能IPv4时填写。 |
false |
innerProxyArp |
否 |
boolean |
|
- |
开启VLAN内Proxy ARP。使能IPv4时填写,当interfaceType为sub-interface时可配置,当interfaceType为interface时请配置为null。V300版本设备VLAN内ARP代理会自动开启VLAN间ARP代理,V300版本设备R23C00之后的版本开始支持;V600系列设备中AR6700V-L不支持此配置。 |
false |
attributes |
否 |
REFERENCE |
详细请参见表19。 |
MTU、MSS信息。使能IPv4时填写。 |
- |
|
description |
否 |
string |
0~242个字符。 |
- |
IP Subnet对应的描述。描述中包含?和中文字符时不下发。当前不支持下发到FW网关设备。 |
"description" |
toVasEnable |
否 |
boolean |
|
false |
to Vas使能,表示该接口为连接VAS的LAN接口 |
false |
enableIpv4 |
否 |
boolean |
|
true |
是否使能IPv4。创建时,默认值为true。enableIpv4与enableIpv6必须使能一个。 |
true |
enableIpv6 |
否 |
boolean |
|
false |
是否使能IPv6。创建时,默认值为false。enableIpv4与enableIpv6必须使能一个。 FW网关设备不支持使能Ipv6。 |
false |
ipv6Info |
否 |
REFERENCE |
详细请参见表20。 |
IPv6信息。使能IPv6时填写。 |
- |
|
configSource |
否 |
string |
0~32个字符。 |
- |
配置源信息,用于区分是WAN业务还是LanWan互联业务,仅查询接口使用,不能修改,取值范围:Wan、LanWan。 |
"Wan" |
ntpDisable |
否 |
boolean |
|
false |
是否禁止NTP报文。创建时,默认值为false。使能IPv4时填写。V600系列设备不支持配置该字段。 |
false |
unrHostRouteAdvertiseEnable |
否 |
boolean |
|
- |
使能ARP主机路由发布。创建时,默认值为false。使能IPv4时填写。V600系列设备不支持配置该字段。 |
false |
dhcpTriggerEnable |
否 |
boolean |
|
- |
使能DHCP的ARP主机路由发布。unrHostRouteAdvertiseEnable为true时必须配置此项。 |
false |
unrRoutesLimitEnable |
否 |
boolean |
|
- |
使能接口上的unr路由限制。 |
false |
unrRoutesLimit |
否 |
int32 |
[1-4096] |
- |
接口上的unr路由限制。unrRoutesLimitEnable为true时必须配置此项。 |
24 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
enable |
否 |
boolean |
|
false |
是否开启VRRP,如果为false则其他参数不再处理。 FW单网关站点不支持开启VRRP。 |
true |
vrrpId |
否 |
int32 |
[1-255] |
- |
VRRP ID,开启VRRP时必填。 |
1 |
virtualIpAddress |
否 |
string |
0~1024个字符。 |
- |
虚拟IP地址,开启VRRP时必填,最多支持16个,地址之间用分号隔开。 |
"10.1.1.1;10.1.2.1" |
defaultRole |
否 |
string |
0~16个字符。 |
- |
取值范围:master、backup,兼容升级场景,不推荐使用。R19C10版本适配旧版本,priority未填的情况下,若defaultRole=master,设置priority为120;若defaultRole=backup,设置priority为100。 |
"master" |
preemptDelay |
否 |
int32 |
[0-3600] |
- |
延时抢占时间,单位秒,开启VRRP时必填,FW网关设备不支持。 |
0 |
priority |
否 |
int32 |
[1-254] |
- |
VRRP优先级。 |
1 |
track |
否 |
ARRAY_REFERENCE |
1-8个列表项,详细请参见表5。 |
开启VRRP时选填,最多配置8个。 |
- |
|
vrrpList |
否 |
ARRAY_REFERENCE |
1-32个列表项,详细请参见表7。 |
开启VRRP时选填,最多配置32个。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
bfdSession |
否 |
REFERENCE |
详细请参见表6。 |
BFD会话信息 |
- |
|
interfaceName |
否 |
string |
0~32个字符。 |
- |
接口名称。非必填,取值范围:此接口必须在Tnp中存在才允许配置。 |
"GE0/0/1" |
addOrReduce |
否 |
string |
0~16个字符。 |
reduce |
变更方式。非必填,取值范围:increase,reduce,需与value配套使用。 |
"reduce" |
value |
否 |
int32 |
[1-255] |
10 |
变更值,非必填,需与addOrReduce配套使用。 |
1 |
type |
否 |
string |
0~16个字符。 |
- |
协议类型。非必填,在VRRP6场景下可配置,取值范围:ipv4,ipv6,仅对V600款型设备生效。 |
"ipv4" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
localDiscriminator |
否 |
int32 |
[1-8191] |
- |
本地标识符。 |
1 |
remoteDiscriminator |
否 |
int32 |
[1-8191] |
- |
远端标识符。 |
1 |
sourceIp |
否 |
string |
0~32个字符。 |
- |
本端IP。 |
"192.168.1.1" |
peerIp |
否 |
string |
0~32个字符。 |
- |
对端IP。 |
"192.168.1.1" |
interval |
否 |
int32 |
[10-2000] |
1000 |
检测周期。 |
10 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
vrrpId |
否 |
int32 |
[1-255] |
- |
VRRP ID,开启VRRP时必填。 |
1 |
virtualIpAddress |
否 |
string |
0~1024个字符。 |
- |
虚拟IP地址,开启VRRP时必填,最多支持16个,地址之间用分号隔开。 |
"10.1.1.1;10.1.2.1" |
defaultRole |
否 |
string |
0~16个字符。 |
- |
取值范围:master、backup,兼容升级场景,废弃字段。R19C10版本适配旧版本,priority未填的情况下,若defaultRole=master,设置priority为120;若defaultRole=backup,设置priority为100。 |
"master" |
preemptDelay |
否 |
int32 |
[0-3600] |
- |
延时抢占时间,单位秒,开启VRRP时必填。 |
0 |
priority |
否 |
int32 |
[1-254] |
- |
VRRP优先级,开启VRRP时必填。 FW网关设备只支持配置为100,120。 |
1 |
authMode |
否 |
int32 |
- |
0 |
VRRP认证方式,0:不认证,1:MD5,2:simple。V600系列设备不支持此功能。 |
0 |
authKey |
否 |
string |
0~8个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 VRRP认证key,authMode为1和2时必填。authKey必须包含如下规则:-长度必须在1~8位。-只支持英文特殊字符、英文大写字母、英文小写字母和数字。-当输入的字符串两端使用双引号时,可在字符串中输入空格。V600系列设备不支持此功能。该字段相关配置会下发设备,建议根据设备款型以及版本参考设备资料进行配置。 |
- |
track |
否 |
ARRAY_REFERENCE |
1-8个列表项,详细请参见表5。 |
开启VRRP时选填,最多支持8个。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
enable |
否 |
boolean |
|
false |
是否开启DHCP。 |
false |
dhcpServiceType |
否 |
string |
0~16个字符。 |
server |
取值范围:server、relay。 不区分大小写。 |
"server" |
dhcpServer |
否 |
REFERENCE |
详细请参见表9。 |
DHCP Server信息。 |
- |
|
dhcpRelay |
否 |
REFERENCE |
详细请参见表16。 |
DHCP Relay信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
excludeIpGroups |
否 |
ARRAY_REFERENCE |
0-64个列表项,详细请参见表10。 |
dhcp接口地址池中不参与自动分配的IP地址范围,startAddress与endAddress必须都有值或都没有值,startAddress与endAddress相同时,表示只有一个IP地址。 |
- |
|
leaseTime |
否 |
REFERENCE |
详细请参见表11。 |
DHCP有效期,全0表示unlimited。 |
- |
|
voiceOption |
否 |
REFERENCE |
详细请参见表12。 |
语音Option,option 184。 |
- |
|
dhcpOption |
否 |
ARRAY_REFERENCE |
1-16个列表项,详细请参见表14。 |
配置当前接口的DHCP地址池的自定义选项。V300系列设备单接口下最多支持8个。 |
- |
|
dhcpStatic |
否 |
ARRAY_REFERENCE |
0-64个列表项,详细请参见表15。 |
配置全局地址池下IP地址与MAC地址的绑定关系。 |
- |
|
dns |
否 |
array<string> |
1-6 个列表项。每个列表项0~32个字符。 |
- |
DNS列表。 |
["8.8.8.8","114.114.114.114"] |
domainName |
否 |
string |
0~63个字符。 |
- |
域名。支持数字、字母、特殊字符(_-和.),但不能为“_”。 |
"example.com" |
useSecondaryIP |
否 |
boolean |
|
- |
地址分配范围,为false时只从ipAddress参数对应的网段分配地址,为true时可以从ipAddress和secondaryIP参数对应的网段分配地址。修改接口时不允许修改,如需修改请先关闭DHCP Server功能再打开。 |
false |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
startAddress |
否 |
string |
0~32个字符。 |
- |
开始地址。 |
"192.168.1.2" |
endAddress |
否 |
string |
0~32个字符。 |
- |
结束地址,与startAddress在同一网段,并且不能小于startAddress。 |
"192.168.1.3" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
day |
否 |
int32 |
[0-999] |
- |
IP地址的租用有效期限天数。 |
0 |
hour |
否 |
int32 |
[0-23] |
- |
IP地址的租用有效期限小时数。 |
0 |
minute |
否 |
int32 |
[0-59] |
- |
IP地址的租用有效期限分钟数。 |
0 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
asIp |
否 |
string |
0~32个字符。 |
- |
AS IP地址。 |
"192.168.1.10" |
ncpIp |
否 |
string |
0~32个字符。 |
- |
NCP IP地址。 |
"192.168.1.10" |
voiceVlan |
否 |
int32 |
[1-4094] |
- |
voice-vlan的VLAN编号。 |
3 |
failOver |
否 |
REFERENCE |
详细请参见表13。 |
fail-over。 |
- |
|
description |
否 |
string |
0~64个字符。 |
- |
VoiceOption描述 |
"description" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
ipAddress |
否 |
string |
0~32个字符。 |
- |
fail-over IP地址。 |
"192.168.1.10" |
dialerString |
否 |
string |
1~64个字符。 |
- |
拨号字符串。 |
"12345678" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
code |
否 |
int32 |
[1-254] |
- |
Option码。取值范围1-254,但1、3、6、50、51、52、53、54、55、57、58、59、61、82、121、184不能配置。44表示Wins/Netbios server,46表示Wins/Netbios node type,120表示SIP Server。 |
44 |
type |
否 |
string |
0~10个字符。 |
- |
Option类型。取值:ip、ascii、hex、domain。 |
"ascii" |
description |
否 |
string |
0~64个字符。 |
- |
Option code描述。 |
"Wins/Netbios server" |
value |
否 |
string |
0~512个字符。 |
- |
Option值。当code为44或type为ip时,取值为用分号分隔的1-8个不同的IP地址;code为46时,取值b-node,p-node,m-node,h-node;当type为hex时,取值为十六进制字符(数字或a-f),长度为偶数且小于255;当code为120且type为ip时,取值为用分号分隔的1-2个不同的IP地址,type为domain时取值为用分号分隔的1-2个不同的域名(用分号分隔,每个域名字符串长度范围为1-63);当code为184时,取值为用分号分隔的as-ip,fail-over(用逗号分隔:ip,拨号字符串[范围1-64]),ncp-ip,voice-vlan[范围1-4094]。 |
"192.168.1.1" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
ipAddress |
否 |
string |
0~32个字符。 |
- |
IP地址。 |
"192.168.1.10" |
macAddress |
否 |
string |
0~64个字符。 |
- |
MAC地址,MAC地址不能为组播地址(第二位不能为奇数)。 |
"xxxx-xxxx-xxxx" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverIps |
否 |
array<string> |
1-8 个列表项。每个列表项0~32个字符。 |
- |
中继服务器IP。 |
["192.168.1.1"] |
sourceAddress |
否 |
string |
0~32个字符。 |
- |
源地址。 |
"10.10.10.2" |
gatewayAddress |
否 |
string |
0~32个字符。 |
- |
网关地址。 |
"10.10.10.3" |
dhcpRelayOption82 |
否 |
REFERENCE |
详细请参见表17。 |
配置当前接口DHCP Relay的option82选项,V600系列设备的L3主接口不支持此功能。 |
- |
|
linkSelectionEnable |
否 |
boolean |
|
- |
是否使能link-selection。创建时,默认值为false。V600系列设备不支持此功能。 |
true |
linkSelectionAddress |
否 |
string |
0~64个字符。 |
- |
link-selection地址。linkSelectionEnable为true时才能配置此项。 |
"10.10.10.1" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
function |
否 |
int32 |
- |
- |
功能。0--insert;1--rebuild;2--关闭。 |
0 |
vlanId |
否 |
int32 |
[1-4094] |
- |
接口类型为sub-interface时必填,表示子接口号;接口类型为bd-interface时必填,表示引用的bridge domain。 |
1 |
subOption |
否 |
ARRAY_REFERENCE |
1-2个列表项,详细请参见表18。 |
Option82子选项配置。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
subOptionCode |
否 |
integer |
[0-254] |
- |
子选项类型。0表示配置circuit-id,1表示配置remote-id。 |
0 |
isUserDefined |
否 |
boolean |
|
false |
是否为用户自定义的格式。 |
true |
value |
否 |
string |
1~255个字符。 |
- |
用户自定义的格式值,需要添加转义双引号。 |
"\"ZID023301\"" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
mtu |
否 |
int32 |
- |
1500 |
MTU取值范围:46-9600,默认1500。设备支持具体范围请查看各个款型产品手册。 |
1500 |
TCPmss |
否 |
int32 |
- |
1200 |
V300系列设备TCPmss取值范围:128-2048,V600系列设备TCPmss取值范围:128-9500,默认1200,建议MSS的值≤MTU的值-40。 FW网关设备不支持配置。 |
1200 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
ipv6Address |
否 |
string |
- |
- |
IPv6地址。创建时必填。 |
"fc00:3::1" |
ipv6PrefixLength |
否 |
int32 |
[1-127] |
- |
掩码。创建时必填。 |
64 |
dhcpV6Enable |
否 |
boolean |
|
false |
是否开启DHCPV6。V600系列AR设备不支持配置该字段。FW网关设备在V600R024C00及以上版本支持IPv6。 |
true |
dhcpV6 |
否 |
REFERENCE |
详细请参见表21。 |
DhcpV6信息,开启DHCPv6时必填。 |
- |
|
vrrp6Enable |
否 |
boolean |
|
false |
是否开启VRRP6。 |
true |
vrrp6 |
否 |
REFERENCE |
详细请参见表25。 |
VRRP6 Protocol信息,开启VRRP6时必填。FW单网关设备不支持VRRP6属性。 |
- |
|
ipv6NtpDisable |
否 |
boolean |
|
false |
是否禁止NTP IPV6报文。V600系列设备不支持配置该字段。 |
false |
raHaltEnable |
否 |
boolean |
|
- |
是否使能发布RA报文。V600系列设备不支持配置该字段。开启后,周期性的向主机发布RA报文中的IPv6地址前缀合有状态自动配置标志位的信息。 |
false |
managedAddressFlagEnable |
否 |
boolean |
|
- |
是否使能有状态配置地址。V600系列设备不支持配置该字段。开启后,主机通过有状态自动配置获得IPv6地址,需要同步开启接口发布RA报文开关才能生效。 |
false |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
dhcpv6ServiceType |
否 |
string |
0~16个字符。 |
server |
取值范围:server、relay,开启DHCPv6时必填。 |
"server" |
dhcpv6Server |
否 |
REFERENCE |
详细请参见表22。 |
DHCPv6 Server信息,DHCPv6类型为server时必填。 |
- |
|
dhcpv6Relay |
否 |
REFERENCE |
详细请参见表24。 |
DHCPv6 Relay信息,DHCPv6类型为relay时必填。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
addressPrefix |
否 |
string |
- |
- |
地址前缀,创建时必填。 |
"fc00:3::/64" |
addressPrefixLeaseTime |
否 |
REFERENCE |
详细请参见表11。 |
地址前缀有效期。 |
- |
|
delegationPrefix |
否 |
string |
- |
- |
代理前缀。 |
"fc00:3::/64" |
delegationPrefixAssignLength |
否 |
integer |
[1-128] |
- |
代理前缀可分配长度,必须大于或等于代理前缀长度,且与代理前缀长度之差小于或等于16。 |
64 |
delegationPrefixLeaseTime |
否 |
REFERENCE |
详细请参见表11。 |
代理前缀有效期。 |
- |
|
excludeIpGroups |
否 |
ARRAY_REFERENCE |
0-128个列表项,详细请参见表23。 |
DHCPv6接口地址池中不参与自动分配的IP地址范围,startAddress与endAddress必须都有值或都没有值,startAddress与endAddress相同时,表示只有一个IP地址。 |
- |
|
firstDnsServer |
否 |
string |
- |
- |
首选DNS服务器。 |
"fc00:3::1" |
secondDnsServer |
否 |
string |
- |
- |
备选DNS服务器。 |
"fc00:3::2" |
domainName |
否 |
string |
0~63个字符。 |
- |
域名。支持数字、字母、特殊字符(_-和.),但不能为“--”或“-”。 |
"0" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
startAddress |
否 |
string |
- |
- |
指定不参与自动分配的IPv6地址段的起始IPv6地址。 |
"fc00:1::1" |
endAddress |
否 |
string |
- |
- |
指定不参与自动分配的IPv6地址段的结束IPv6地址,与startAddress在同一网段,并且不能小于startAddress。 |
"fc00:1::10" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverIps |
否 |
array<string> |
0-128 个列表项。 |
- |
中继服务器IP。 |
["fc00::1"] |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
vrrp6Id |
否 |
int32 |
[1-255] |
- |
VRRP ID,开启VRRP6时必填。 |
1 |
virtualIpv6AddressLinkLocal |
否 |
string |
- |
- |
本地链路地址,前缀必须匹配fe80::/10,开启VRRP6时必填,最多支持1个。 |
"fe80::7" |
virtualIpv6Address |
否 |
string |
- |
- |
虚拟IP地址,开启VRRP6时必填,最多支持15个,地址之间用分号隔开。对于云杉FW,只支持配置1个。 |
"fc00:3::10;fc00:3::11" |
preemptDelay |
否 |
int32 |
[0-3600] |
- |
延时抢占时间,单位秒,开启VRRP6时必填。 |
0 |
priority |
否 |
int32 |
[1-254] |
- |
1 VRRP优先级,非fw网关场景开启VRRP6时必填。 2 FW网关场景不支持自定义优先级。 |
1 |
trackEnable |
否 |
boolean |
|
false |
是否开启track。 |
true |
track |
否 |
ARRAY_REFERENCE |
1-8个列表项,详细请参见表5。 |
开启VRRP6 Track时必填。 |
- |
|
vrrp6Role |
否 |
string |
满足正则表达^(active|standby)?$。 |
- |
只针对FW网关场景,主备角色转换成active/standby下发,其他场景该字段不会下发到设备。 |
- |
请求示例
POST /controller/campus/v1/sdwan/overlay-network/ip-subnets 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 { "IPSubnets" : [ { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } ] }
响应参数
返回状态码为201:接口调用成功,响应体参考IPSubnetResponse。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
- |
- |
错误码。 |
"0" |
errmsg |
string |
- |
- |
错误信息。 |
"" |
success |
ARRAY_REFERENCE |
0-100个列表项,详细请参见表27。 |
创建或者更新成功的IP Subnet信息。 |
- |
|
fail |
ARRAY_REFERENCE |
0-100个列表项,详细请参见表50。 |
创建或者更新失败的IP Subnet信息。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
vpnId |
uuid |
- |
- |
所在VPN的ID。创建时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
siteId |
uuid |
- |
- |
对应站点的ID。创建时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
deviceId |
uuid |
- |
- |
对应设备的ID。创建时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
id |
uuid |
- |
- |
IP Subnet ID,主键。创建时不填,自动生成,更新时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
interfaceType |
string |
0~16个字符。 |
- |
接口类型,取值范围:interface(三层物理接口)、sub-interface(子接口)、bd-interface(VLANIF接口)。创建时必填。 |
"interface" |
interfaceName |
string |
0~128个字符。 |
- |
接口名称,创建时不填,查询时返回。对于物理接口,如:GE0/0/0;对于子接口,如:GE0/0/0.1;对于VLANIF接口,如vlanif20。 |
"vlanif20" |
portLagFlag |
boolean |
|
false |
Lag标志位。使能时portId为Lag的ID反之为port的ID。 |
false |
portId |
uuid |
- |
- |
接口ID,接口类型为interface、sub-interface时必填。格式是uuid。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
vlanId |
int32 |
[1-4094] |
- |
接口类型为sub-interface时必填,表示子接口号;接口类型为bd-interface时必填,表示引用的bridge domain。 |
1 |
subInterfaceName |
string |
0~128个字符。 |
- |
子接口名称,创建时选填,如果填写了该参数,则子接口以填写的为准;如果不填,则使用interfacName+vlanId自动拼接。该参数只对interfaceType为sub-interface生效,其他类型不生效。不允许修改。 |
"GE0/0/0.1" |
trustEnable |
boolean |
|
false |
trust使能开关。接口类型为sub-interface时填写。 |
false |
trust |
string |
|
- |
trust选项。 |
"dscp" |
ipAddress |
string |
0~32个字符。 |
- |
IP地址。使能IPv4时填写。 |
"192.168.1.1" |
prefixLength |
int32 |
[1-32] |
- |
掩码。使能IPv4时填写。 |
24 |
secondaryIP |
array<string> |
0-31 个列表项。每个列表项0~64个字符。 |
- |
接口从IP地址。使能IPv4时填写。 |
["10.10.10.2/24","10.10.11.2/24"] |
siteName |
string |
- |
- |
站点名称。仅查询接口使用。 |
"site" |
deviceName |
string |
- |
- |
设备名称。仅查询接口使用。 |
"device" |
vrrp |
REFERENCE |
详细请参见表28。 |
VRRP信息。使能IPv4时填写。 |
- |
|
dhcp |
REFERENCE |
详细请参见表32。 |
Dhcp信息。使能IPv4时填写。 |
- |
|
securityZone |
string |
0~32个字符。 |
trust |
安全域,取值范围:trust、untrust、自定义安全域。 |
"trust" |
proxyArp |
boolean |
|
false |
开启Proxy ARP。使能IPv4时填写。 |
false |
innerProxyArp |
boolean |
|
- |
开启VLAN内Proxy ARP。使能IPv4时填写,当interfaceType为sub-interface时可配置,当interfaceType为interface时请配置为null。V300版本设备VLAN内ARP代理会自动开启VLAN间ARP代理,V300版本设备R23C00之后的版本开始支持;V600系列设备中AR6700V-L不支持此配置。 |
false |
attributes |
REFERENCE |
详细请参见表43。 |
MTU、MSS信息。使能IPv4时填写。 |
- |
|
description |
string |
0~242个字符。 |
- |
IP Subnet对应的描述。描述中包含?和中文字符时不下发。当前不支持下发到FW网关设备。 |
"description" |
toVasEnable |
boolean |
|
false |
to Vas使能,表示该接口为连接VAS的LAN接口 |
false |
enableIpv4 |
boolean |
|
true |
是否使能IPv4。创建时,默认值为true。enableIpv4与enableIpv6必须使能一个。 |
true |
enableIpv6 |
boolean |
|
false |
是否使能IPv6。创建时,默认值为false。enableIpv4与enableIpv6必须使能一个。 FW网关设备不支持使能Ipv6。 |
false |
ipv6Info |
REFERENCE |
详细请参见表44。 |
IPv6信息。使能IPv6时填写。 |
- |
|
configSource |
string |
0~32个字符。 |
- |
配置源信息,用于区分是WAN业务还是LanWan互联业务,仅查询接口使用,不能修改,取值范围:Wan、LanWan。 |
"Wan" |
ntpDisable |
boolean |
|
false |
是否禁止NTP报文。创建时,默认值为false。使能IPv4时填写。V600系列设备不支持配置该字段。 |
false |
unrHostRouteAdvertiseEnable |
boolean |
|
- |
使能ARP主机路由发布。创建时,默认值为false。使能IPv4时填写。V600系列设备不支持配置该字段。 |
false |
dhcpTriggerEnable |
boolean |
|
- |
使能DHCP的ARP主机路由发布。unrHostRouteAdvertiseEnable为true时必须配置此项。 |
false |
unrRoutesLimitEnable |
boolean |
|
- |
使能接口上的unr路由限制。 |
false |
unrRoutesLimit |
int32 |
[1-4096] |
- |
接口上的unr路由限制。unrRoutesLimitEnable为true时必须配置此项。 |
24 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
enable |
boolean |
|
false |
是否开启VRRP,如果为false则其他参数不再处理。 FW单网关站点不支持开启VRRP。 |
true |
vrrpId |
int32 |
[1-255] |
- |
VRRP ID,开启VRRP时必填。 |
1 |
virtualIpAddress |
string |
0~1024个字符。 |
- |
虚拟IP地址,开启VRRP时必填,最多支持16个,地址之间用分号隔开。 |
"10.1.1.1;10.1.2.1" |
defaultRole |
string |
0~16个字符。 |
- |
取值范围:master、backup,兼容升级场景,不推荐使用。R19C10版本适配旧版本,priority未填的情况下,若defaultRole=master,设置priority为120;若defaultRole=backup,设置priority为100。 |
"master" |
preemptDelay |
int32 |
[0-3600] |
- |
延时抢占时间,单位秒,开启VRRP时必填,FW网关设备不支持。 |
0 |
priority |
int32 |
[1-254] |
- |
VRRP优先级。 |
1 |
track |
ARRAY_REFERENCE |
1-8个列表项,详细请参见表29。 |
开启VRRP时选填,最多配置8个。 |
- |
|
vrrpList |
ARRAY_REFERENCE |
1-32个列表项,详细请参见表31。 |
开启VRRP时选填,最多配置32个。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
bfdSession |
REFERENCE |
详细请参见表30。 |
BFD会话信息 |
- |
|
interfaceName |
string |
0~32个字符。 |
- |
接口名称。非必填,取值范围:此接口必须在Tnp中存在才允许配置。 |
"GE0/0/1" |
addOrReduce |
string |
0~16个字符。 |
reduce |
变更方式。非必填,取值范围:increase,reduce,需与value配套使用。 |
"reduce" |
value |
int32 |
[1-255] |
10 |
变更值,非必填,需与addOrReduce配套使用。 |
1 |
type |
string |
0~16个字符。 |
- |
协议类型。非必填,在VRRP6场景下可配置,取值范围:ipv4,ipv6,仅对V600款型设备生效。 |
"ipv4" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
localDiscriminator |
int32 |
[1-8191] |
- |
本地标识符。 |
1 |
remoteDiscriminator |
int32 |
[1-8191] |
- |
远端标识符。 |
1 |
sourceIp |
string |
0~32个字符。 |
- |
本端IP。 |
"192.168.1.1" |
peerIp |
string |
0~32个字符。 |
- |
对端IP。 |
"192.168.1.1" |
interval |
int32 |
[10-2000] |
1000 |
检测周期。 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
vrrpId |
int32 |
[1-255] |
- |
VRRP ID,开启VRRP时必填。 |
1 |
virtualIpAddress |
string |
0~1024个字符。 |
- |
虚拟IP地址,开启VRRP时必填,最多支持16个,地址之间用分号隔开。 |
"10.1.1.1;10.1.2.1" |
defaultRole |
string |
0~16个字符。 |
- |
取值范围:master、backup,兼容升级场景,废弃字段。R19C10版本适配旧版本,priority未填的情况下,若defaultRole=master,设置priority为120;若defaultRole=backup,设置priority为100。 |
"master" |
preemptDelay |
int32 |
[0-3600] |
- |
延时抢占时间,单位秒,开启VRRP时必填。 |
0 |
priority |
int32 |
[1-254] |
- |
VRRP优先级,开启VRRP时必填。 FW网关设备只支持配置为100,120。 |
1 |
authMode |
int32 |
- |
0 |
VRRP认证方式,0:不认证,1:MD5,2:simple。V600系列设备不支持此功能。 |
0 |
authKey |
string |
0~8个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 VRRP认证key,authMode为1和2时必填。authKey必须包含如下规则:-长度必须在1~8位。-只支持英文特殊字符、英文大写字母、英文小写字母和数字。-当输入的字符串两端使用双引号时,可在字符串中输入空格。V600系列设备不支持此功能。该字段相关配置会下发设备,建议根据设备款型以及版本参考设备资料进行配置。 |
- |
track |
ARRAY_REFERENCE |
1-8个列表项,详细请参见表29。 |
开启VRRP时选填,最多支持8个。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
enable |
boolean |
|
false |
是否开启DHCP。 |
false |
dhcpServiceType |
string |
0~16个字符。 |
server |
取值范围:server、relay。 不区分大小写。 |
"server" |
dhcpServer |
REFERENCE |
详细请参见表33。 |
DHCP Server信息。 |
- |
|
dhcpRelay |
REFERENCE |
详细请参见表40。 |
DHCP Relay信息。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
excludeIpGroups |
ARRAY_REFERENCE |
0-64个列表项,详细请参见表34。 |
dhcp接口地址池中不参与自动分配的IP地址范围,startAddress与endAddress必须都有值或都没有值,startAddress与endAddress相同时,表示只有一个IP地址。 |
- |
|
leaseTime |
REFERENCE |
详细请参见表35。 |
DHCP有效期,全0表示unlimited。 |
- |
|
voiceOption |
REFERENCE |
详细请参见表36。 |
语音Option,option 184。 |
- |
|
dhcpOption |
ARRAY_REFERENCE |
1-16个列表项,详细请参见表38。 |
配置当前接口的DHCP地址池的自定义选项。V300系列设备单接口下最多支持8个。 |
- |
|
dhcpStatic |
ARRAY_REFERENCE |
0-64个列表项,详细请参见表39。 |
配置全局地址池下IP地址与MAC地址的绑定关系。 |
- |
|
dns |
array<string> |
1-6 个列表项。每个列表项0~32个字符。 |
- |
DNS列表。 |
["8.8.8.8","114.114.114.114"] |
domainName |
string |
0~63个字符。 |
- |
域名。支持数字、字母、特殊字符(_-和.),但不能为“_”。 |
"example.com" |
useSecondaryIP |
boolean |
|
- |
地址分配范围,为false时只从ipAddress参数对应的网段分配地址,为true时可以从ipAddress和secondaryIP参数对应的网段分配地址。修改接口时不允许修改,如需修改请先关闭DHCP Server功能再打开。 |
false |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
startAddress |
string |
0~32个字符。 |
- |
开始地址。 |
"192.168.1.2" |
endAddress |
string |
0~32个字符。 |
- |
结束地址,与startAddress在同一网段,并且不能小于startAddress。 |
"192.168.1.3" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
day |
int32 |
[0-999] |
- |
IP地址的租用有效期限天数。 |
0 |
hour |
int32 |
[0-23] |
- |
IP地址的租用有效期限小时数。 |
0 |
minute |
int32 |
[0-59] |
- |
IP地址的租用有效期限分钟数。 |
0 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
asIp |
string |
0~32个字符。 |
- |
AS IP地址。 |
"192.168.1.10" |
ncpIp |
string |
0~32个字符。 |
- |
NCP IP地址。 |
"192.168.1.10" |
voiceVlan |
int32 |
[1-4094] |
- |
voice-vlan的VLAN编号。 |
3 |
failOver |
REFERENCE |
详细请参见表37。 |
fail-over。 |
- |
|
description |
string |
0~64个字符。 |
- |
VoiceOption描述 |
"description" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
ipAddress |
string |
0~32个字符。 |
- |
fail-over IP地址。 |
"192.168.1.10" |
dialerString |
string |
1~64个字符。 |
- |
拨号字符串。 |
"12345678" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
code |
int32 |
[1-254] |
- |
Option码。取值范围1-254,但1、3、6、50、51、52、53、54、55、57、58、59、61、82、121、184不能配置。44表示Wins/Netbios server,46表示Wins/Netbios node type,120表示SIP Server。 |
44 |
type |
string |
0~10个字符。 |
- |
Option类型。取值:ip、ascii、hex、domain。 |
"ascii" |
description |
string |
0~64个字符。 |
- |
Option code描述。 |
"Wins/Netbios server" |
value |
string |
0~512个字符。 |
- |
Option值。当code为44或type为ip时,取值为用分号分隔的1-8个不同的IP地址;code为46时,取值b-node,p-node,m-node,h-node;当type为hex时,取值为十六进制字符(数字或a-f),长度为偶数且小于255;当code为120且type为ip时,取值为用分号分隔的1-2个不同的IP地址,type为domain时取值为用分号分隔的1-2个不同的域名(用分号分隔,每个域名字符串长度范围为1-63);当code为184时,取值为用分号分隔的as-ip,fail-over(用逗号分隔:ip,拨号字符串[范围1-64]),ncp-ip,voice-vlan[范围1-4094]。 |
"192.168.1.1" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
ipAddress |
string |
0~32个字符。 |
- |
IP地址。 |
"192.168.1.10" |
macAddress |
string |
0~64个字符。 |
- |
MAC地址,MAC地址不能为组播地址(第二位不能为奇数)。 |
"xxxx-xxxx-xxxx" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverIps |
array<string> |
1-8 个列表项。每个列表项0~32个字符。 |
- |
中继服务器IP。 |
["192.168.1.1"] |
sourceAddress |
string |
0~32个字符。 |
- |
源地址。 |
"10.10.10.2" |
gatewayAddress |
string |
0~32个字符。 |
- |
网关地址。 |
"10.10.10.3" |
dhcpRelayOption82 |
REFERENCE |
详细请参见表41。 |
配置当前接口DHCP Relay的option82选项,V600系列设备的L3主接口不支持此功能。 |
- |
|
linkSelectionEnable |
boolean |
|
- |
是否使能link-selection。创建时,默认值为false。V600系列设备不支持此功能。 |
true |
linkSelectionAddress |
string |
0~64个字符。 |
- |
link-selection地址。linkSelectionEnable为true时才能配置此项。 |
"10.10.10.1" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
function |
int32 |
- |
- |
功能。0--insert;1--rebuild;2--关闭。 |
0 |
vlanId |
int32 |
[1-4094] |
- |
接口类型为sub-interface时必填,表示子接口号;接口类型为bd-interface时必填,表示引用的bridge domain。 |
1 |
subOption |
ARRAY_REFERENCE |
1-2个列表项,详细请参见表42。 |
Option82子选项配置。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
subOptionCode |
integer |
[0-254] |
- |
子选项类型。0表示配置circuit-id,1表示配置remote-id。 |
0 |
isUserDefined |
boolean |
|
false |
是否为用户自定义的格式。 |
true |
value |
string |
1~255个字符。 |
- |
用户自定义的格式值,需要添加转义双引号。 |
"\"ZID023301\"" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
mtu |
int32 |
- |
1500 |
MTU取值范围:46-9600,默认1500。设备支持具体范围请查看各个款型产品手册。 |
1500 |
TCPmss |
int32 |
- |
1200 |
V300系列设备TCPmss取值范围:128-2048,V600系列设备TCPmss取值范围:128-9500,默认1200,建议MSS的值≤MTU的值-40。 FW网关设备不支持配置。 |
1200 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
ipv6Address |
string |
- |
- |
IPv6地址。创建时必填。 |
"fc00:3::1" |
ipv6PrefixLength |
int32 |
[1-127] |
- |
掩码。创建时必填。 |
64 |
dhcpV6Enable |
boolean |
|
false |
是否开启DHCPV6。V600系列AR设备不支持配置该字段。FW网关设备在V600R024C00及以上版本支持IPv6。 |
true |
dhcpV6 |
REFERENCE |
详细请参见表45。 |
DhcpV6信息,开启DHCPv6时必填。 |
- |
|
vrrp6Enable |
boolean |
|
false |
是否开启VRRP6。 |
true |
vrrp6 |
REFERENCE |
详细请参见表49。 |
VRRP6 Protocol信息,开启VRRP6时必填。FW单网关设备不支持VRRP6属性。 |
- |
|
ipv6NtpDisable |
boolean |
|
false |
是否禁止NTP IPV6报文。V600系列设备不支持配置该字段。 |
false |
raHaltEnable |
boolean |
|
- |
是否使能发布RA报文。V600系列设备不支持配置该字段。开启后,周期性的向主机发布RA报文中的IPv6地址前缀合有状态自动配置标志位的信息。 |
false |
managedAddressFlagEnable |
boolean |
|
- |
是否使能有状态配置地址。V600系列设备不支持配置该字段。开启后,主机通过有状态自动配置获得IPv6地址,需要同步开启接口发布RA报文开关才能生效。 |
false |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
dhcpv6ServiceType |
string |
0~16个字符。 |
server |
取值范围:server、relay,开启DHCPv6时必填。 |
"server" |
dhcpv6Server |
REFERENCE |
详细请参见表46。 |
DHCPv6 Server信息,DHCPv6类型为server时必填。 |
- |
|
dhcpv6Relay |
REFERENCE |
详细请参见表48。 |
DHCPv6 Relay信息,DHCPv6类型为relay时必填。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
addressPrefix |
string |
- |
- |
地址前缀,创建时必填。 |
"fc00:3::/64" |
addressPrefixLeaseTime |
REFERENCE |
详细请参见表35。 |
地址前缀有效期。 |
- |
|
delegationPrefix |
string |
- |
- |
代理前缀。 |
"fc00:3::/64" |
delegationPrefixAssignLength |
integer |
[1-128] |
- |
代理前缀可分配长度,必须大于或等于代理前缀长度,且与代理前缀长度之差小于或等于16。 |
64 |
delegationPrefixLeaseTime |
REFERENCE |
详细请参见表35。 |
代理前缀有效期。 |
- |
|
excludeIpGroups |
ARRAY_REFERENCE |
0-128个列表项,详细请参见表47。 |
DHCPv6接口地址池中不参与自动分配的IP地址范围,startAddress与endAddress必须都有值或都没有值,startAddress与endAddress相同时,表示只有一个IP地址。 |
- |
|
firstDnsServer |
string |
- |
- |
首选DNS服务器。 |
"fc00:3::1" |
secondDnsServer |
string |
- |
- |
备选DNS服务器。 |
"fc00:3::2" |
domainName |
string |
0~63个字符。 |
- |
域名。支持数字、字母、特殊字符(_-和.),但不能为“--”或“-”。 |
"0" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
startAddress |
string |
- |
- |
指定不参与自动分配的IPv6地址段的起始IPv6地址。 |
"fc00:1::1" |
endAddress |
string |
- |
- |
指定不参与自动分配的IPv6地址段的结束IPv6地址,与startAddress在同一网段,并且不能小于startAddress。 |
"fc00:1::10" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverIps |
array<string> |
0-128 个列表项。 |
- |
中继服务器IP。 |
["fc00::1"] |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
vrrp6Id |
int32 |
[1-255] |
- |
VRRP ID,开启VRRP6时必填。 |
1 |
virtualIpv6AddressLinkLocal |
string |
- |
- |
本地链路地址,前缀必须匹配fe80::/10,开启VRRP6时必填,最多支持1个。 |
"fe80::7" |
virtualIpv6Address |
string |
- |
- |
虚拟IP地址,开启VRRP6时必填,最多支持15个,地址之间用分号隔开。对于云杉FW,只支持配置1个。 |
"fc00:3::10;fc00:3::11" |
preemptDelay |
int32 |
[0-3600] |
- |
延时抢占时间,单位秒,开启VRRP6时必填。 |
0 |
priority |
int32 |
[1-254] |
- |
1 VRRP优先级,非fw网关场景开启VRRP6时必填。 2 FW网关场景不支持自定义优先级。 |
1 |
trackEnable |
boolean |
|
false |
是否开启track。 |
true |
track |
ARRAY_REFERENCE |
1-8个列表项,详细请参见表29。 |
开启VRRP6 Track时必填。 |
- |
|
vrrp6Role |
string |
满足正则表达^(active|standby)?$。 |
- |
只针对FW网关场景,主备角色转换成active/standby下发,其他场景该字段不会下发到设备。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
- |
- |
错误码。 |
"0" |
errmsg |
string |
- |
- |
错误信息。 |
"" |
data |
REFERENCE |
详细请参见表27。 |
IP Subnet信息。 |
- |
返回状态码为204:执行成功,没有数据。
返回状态码为400:校验异常。
详细信息请参见实际响应消息体。
返回状态码为500:内部错误。
详细信息请参见实际响应消息体。
响应示例
返回状态码为201:接口调用成功,响应体参考IPSubnetResponse。
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" : [ { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } } ] }
返回状态码为204:执行成功,没有数据。
HTTP/1.1 204 No Content 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
返回状态码为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