创建LANWAN互联OSPF邻居信息
典型场景
LANWAN互联路由,用于创建OSPF邻居。
接口功能
创建LANWAN互联OSPF邻居。
接口约束
该接口支持北向管理员访问,必须在用户会话建立后使用。
创建OSPF邻居之前需要先创建互联口和OSPF进程。
调用方法
POST
URI
/controller/campus/v1/lanwan/interconnection/route/ospf
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
routeLinkOspfInfo |
是 |
REFERENCE |
详细请参见表2。 |
创建LANWAN互联OSPF邻居。一次操作只能创建基于一个互联口信息的OSPF。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
linkId |
是 |
string |
0~64个字符。 |
- |
互联接口标识,创建和更新时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
neighborInfo |
否 |
REFERENCE |
详细请参见表3。 |
OSPF路由信息。兼容升级场景,废弃字段。 |
- |
|
coreProcessId |
否 |
int32 |
[1-65535] |
- |
核心侧OSPF进程号,必填。取值范围:1-65535。兼容升级场景,废弃字段。 |
10 |
gatewayProcessId |
否 |
int32 |
[1-20000] |
- |
网关侧OSPF进程号,必填。取值范围:1-20000。兼容升级场景,废弃字段。 |
10 |
gatewayRouterId |
否 |
string |
0~64个字符。 |
- |
用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。兼容升级场景,废弃字段。 |
"192.168.1.1" |
coreOspfIntfs |
否 |
ARRAY_REFERENCE |
0-32个列表项,详细请参见表6。 |
核心侧OSPF邻居部署信息。 |
- |
|
gatewayOspfIntfs |
否 |
ARRAY_REFERENCE |
0-32个列表项,详细请参见表6。 |
网关侧OSPF邻居部署信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
areaId |
是 |
int64 |
[0-4294967295] |
- |
区域ID。 |
10 |
areaType |
否 |
string |
0~10个字符。 |
- |
区域类型。取值:normal(缺省情况下,OSPF区域被定义为普通区域)、stub(不允许发布自治系统外部路由,只允许发布区域内路由和区域间的路由)、nssa(NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中)。 |
"normal" |
helloTimer |
否 |
int32 |
[1-65535] |
10 |
单位为秒,Hello报文时间间隔,单位:秒。建议Hello报文时间间隔取值不小于5,否则可能会造成邻接关系的中断,默认值为10。 |
1 |
timerPoll |
否 |
int32 |
[1-3600] |
- |
单位为秒,指定发送轮询Hello报文的时间间隔。仅网关侧支持。 |
1 |
timerDead |
否 |
int32 |
[1-235926000] |
- |
单位为秒,OSPF的邻居失效时间。仅网关侧支持。 |
1 |
timerRetransmit |
否 |
int32 |
[1-3600] |
- |
单位为秒,接口重传LSA的时间间隔。仅网关侧时支持。 |
1 |
authenticationInfo |
否 |
REFERENCE |
详细请参见表4。 |
认证加密参数 |
- |
|
coreInterfaceInfo |
否 |
REFERENCE |
详细请参见表5。 |
核心侧设备OSPF邻居信息。 |
- |
|
gatewayInterfaceInfo |
否 |
REFERENCE |
详细请参见表5。 |
网关侧设备OSPF邻居信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
authMode |
否 |
string |
0~16个字符。 |
cryptographic |
认证方式。取值:none(不验证)、simple(简单验证)、cryptographic(加密验证)。推荐使用cryptographic。 |
"cryptographic" |
algorithm |
否 |
string |
0~16个字符。 |
hmac-sha256 |
加密算法。取值:hmac-sha256、hmac-md5、md5。hmac-md5和md5验证模式存在安全风险,推荐使用hmac-sha256验证模式。当authMode为cryptographic时,algorithm必填。 |
"hmac-sha256" |
key |
否 |
int32 |
[1-255] |
- |
接口密文验证的验证字标识符。当authMode为ENCRYPTION时,key必填。 |
1 |
pwd |
否 |
password |
0~256个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 密码必须包含如下规则: -密码长度必须在1~255位。 -密码只支持特殊字符、英文大写字母、英文小写字母和数字。 -为提高安全性,建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种,同时密码长度不小于6个字符。当authMode为SIMPLE或者ENCRYPTION时,key必填。 |
"abc" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
interfaceName |
否 |
string |
0~16个字符。 |
- |
互联接口的名称。创建更新时不填,查询时返回。对于三层主接口,如:GE0/0/0;对于三层子接口,如:GE0/0/0.1;对于VLANIF接口,如vlanif20。兼容升级场景,后续废弃。 |
"vlanif20" |
subnetId |
否 |
string |
0~64个字符。 |
- |
互联子网标识。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
cost |
否 |
int32 |
[1-65535] |
- |
接口开销值。 |
1 |
drPriority |
否 |
int32 |
[0-255] |
1 |
接口DR优先级。仅网关侧时生效,默认值为1。 |
1 |
mtuEnable |
否 |
boolean |
|
- |
接口在发送DD报文时填充MTU值,同时还会检查邻居DD报文所携带的MTU是否超过本端的MTU值。仅网关侧时生效。 |
false |
networkType |
否 |
string |
0~16个字符。 |
- |
网络类型。取值:broadcast(将接口的网络类型更改为广播)、nbma(将接口的网络类型更改为NBMA)、p2mp(将接口的网络类型更改为点到多点)、p2p(将接口的网络类型更改为点到点)。仅网关侧生效。 |
"broadcast" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
processId |
否 |
int32 |
[1-20000] |
- |
网关侧OSPF进程号,必填。取值范围:1-20000。 |
10 |
routerId |
否 |
string |
0~64个字符。 |
- |
用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。兼容升级场景,废弃字段。 |
"192.168.1.1" |
configSource |
否 |
string |
0~32个字符。 |
- |
配置源 |
"LANWAN" |
OspfIntfInfo |
否 |
REFERENCE |
详细请参见表7。 |
OSPF路由信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
interfaceName |
否 |
string |
0~16个字符。 |
- |
互联接口的名称。创建更新时不填,查询时返回。对于三层主接口,如:GE0/0/0;对于三层子接口,如:GE0/0/0.1;对于VLANIF接口,如vlanif20。兼容升级场景,后续废弃。 |
"vlanif20" |
subnetId |
否 |
string |
0~64个字符。 |
- |
互联子网标识。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
cost |
否 |
int32 |
[1-65535] |
- |
接口开销值。 |
1 |
drPriority |
否 |
int32 |
[0-255] |
1 |
接口DR优先级。仅网关侧时生效,默认值为1。 |
1 |
mtuEnable |
否 |
boolean |
|
- |
接口在发送DD报文时填充MTU值,同时还会检查邻居DD报文所携带的MTU是否超过本端的MTU值。仅网关侧时生效。 |
false |
networkType |
否 |
string |
0~16个字符。 |
- |
网络类型。取值:broadcast(将接口的网络类型更改为广播)、nbma(将接口的网络类型更改为NBMA)、p2mp(将接口的网络类型更改为点到多点)、p2p(将接口的网络类型更改为点到点)。仅网关侧生效。 |
"broadcast" |
authMode |
否 |
string |
0~16个字符。 |
cryptographic |
认证方式。取值:none(不验证)、simple(简单验证)、cryptographic(加密验证)。推荐使用cryptographic。 |
"cryptographic" |
algorithm |
否 |
string |
0~16个字符。 |
hmac-sha256 |
加密算法。取值:hmac-sha256、hmac-md5、md5。hmac-md5和md5验证模式存在安全风险,推荐使用hmac-sha256验证模式。当authMode为cryptographic时,algorithm必填。 |
"hmac-sha256" |
key |
否 |
int32 |
[1-255] |
- |
接口密文验证的验证字标识符。当authMode为ENCRYPTION时,key必填。 |
1 |
pwd |
否 |
password |
0~256个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 密码必须包含如下规则: -密码长度必须在1~255位。 -密码只支持特殊字符、英文大写字母、英文小写字母和数字。 -为提高安全性,建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种,同时密码长度不小于6个字符。当authMode为SIMPLE或者ENCRYPTION时,key必填。 |
"abc" |
linkId |
否 |
string |
36个字符。 |
- |
互联标识,创建和修改时不填,查询时返回。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
linkName |
否 |
string |
0~128个字符。 |
- |
互联名称,创建和修改时不填,查询时返回。 |
"ConnectLink" |
areaId |
否 |
int64 |
[0-4294967295] |
- |
区域ID。 |
10 |
helloTimer |
否 |
int32 |
[1-65535] |
10 |
Hello报文时间间隔。建议Hello报文时间间隔取值不小于5,否则可能会造成邻接关系的中断,默认值为10。 |
1 |
areaType |
否 |
string |
0~10个字符。 |
- |
区域类型。取值:normal(缺省情况下,OSPF区域被定义为普通区域)、stub(不允许发布自治系统外部路由,只允许发布区域内路由和区域间的路由)、nssa(NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中)。 |
"normal" |
timerPoll |
否 |
int32 |
[1-3600] |
- |
单位为秒,指定发送轮询Hello报文的时间间隔。仅网关侧支持。 |
1 |
timerRetransmit |
否 |
int32 |
[1-3600] |
- |
单位为秒,接口重传LSA的时间间隔。仅网关侧时支持。 |
1 |
timerDead |
否 |
int32 |
[1-235926000] |
- |
单位为秒,OSPF的邻居失效时间。仅网关侧支持。 |
1 |
请求示例
POST /controller/campus/v1/lanwan/interconnection/route/ospf 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 { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreProcessId" : 10, "gatewayProcessId" : 10, "gatewayRouterId" : "192.168.1.1", "coreOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ], "gatewayOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ] }
响应参数
返回状态码为201:创建LANWAN互联OSPF邻居返回信息。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
0~64个字符。 |
- |
错误码。 |
"0" |
errmsg |
string |
0~256个字符。 |
- |
错误信息。 |
"" |
success |
REFERENCE |
详细请参见表9。 |
创建互联OSPF邻居成功信息。 |
- |
|
fail |
REFERENCE |
详细请参见表15。 |
创建互联OSPF邻居失败信息。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
linkId |
string |
0~64个字符。 |
- |
互联接口标识,创建和更新时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
neighborInfo |
REFERENCE |
详细请参见表10。 |
OSPF路由信息。兼容升级场景,废弃字段。 |
- |
|
coreProcessId |
int32 |
[1-65535] |
- |
核心侧OSPF进程号,必填。取值范围:1-65535。兼容升级场景,废弃字段。 |
10 |
gatewayProcessId |
int32 |
[1-20000] |
- |
网关侧OSPF进程号,必填。取值范围:1-20000。兼容升级场景,废弃字段。 |
10 |
gatewayRouterId |
string |
0~64个字符。 |
- |
用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。兼容升级场景,废弃字段。 |
"192.168.1.1" |
coreOspfIntfs |
ARRAY_REFERENCE |
0-32个列表项,详细请参见表13。 |
核心侧OSPF邻居部署信息。 |
- |
|
gatewayOspfIntfs |
ARRAY_REFERENCE |
0-32个列表项,详细请参见表13。 |
网关侧OSPF邻居部署信息。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
areaId |
int64 |
[0-4294967295] |
- |
区域ID。 |
10 |
areaType |
string |
0~10个字符。 |
- |
区域类型。取值:normal(缺省情况下,OSPF区域被定义为普通区域)、stub(不允许发布自治系统外部路由,只允许发布区域内路由和区域间的路由)、nssa(NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中)。 |
"normal" |
helloTimer |
int32 |
[1-65535] |
10 |
单位为秒,Hello报文时间间隔,单位:秒。建议Hello报文时间间隔取值不小于5,否则可能会造成邻接关系的中断,默认值为10。 |
1 |
timerPoll |
int32 |
[1-3600] |
- |
单位为秒,指定发送轮询Hello报文的时间间隔。仅网关侧支持。 |
1 |
timerDead |
int32 |
[1-235926000] |
- |
单位为秒,OSPF的邻居失效时间。仅网关侧支持。 |
1 |
timerRetransmit |
int32 |
[1-3600] |
- |
单位为秒,接口重传LSA的时间间隔。仅网关侧时支持。 |
1 |
authenticationInfo |
REFERENCE |
详细请参见表11。 |
认证加密参数 |
- |
|
coreInterfaceInfo |
REFERENCE |
详细请参见表12。 |
核心侧设备OSPF邻居信息。 |
- |
|
gatewayInterfaceInfo |
REFERENCE |
详细请参见表12。 |
网关侧设备OSPF邻居信息。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
authMode |
string |
0~16个字符。 |
cryptographic |
认证方式。取值:none(不验证)、simple(简单验证)、cryptographic(加密验证)。推荐使用cryptographic。 |
"cryptographic" |
algorithm |
string |
0~16个字符。 |
hmac-sha256 |
加密算法。取值:hmac-sha256、hmac-md5、md5。hmac-md5和md5验证模式存在安全风险,推荐使用hmac-sha256验证模式。当authMode为cryptographic时,algorithm必填。 |
"hmac-sha256" |
key |
int32 |
[1-255] |
- |
接口密文验证的验证字标识符。当authMode为ENCRYPTION时,key必填。 |
1 |
pwd |
password |
0~256个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 密码必须包含如下规则: -密码长度必须在1~255位。 -密码只支持特殊字符、英文大写字母、英文小写字母和数字。 -为提高安全性,建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种,同时密码长度不小于6个字符。当authMode为SIMPLE或者ENCRYPTION时,key必填。 |
"abc" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
interfaceName |
string |
0~16个字符。 |
- |
互联接口的名称。创建更新时不填,查询时返回。对于三层主接口,如:GE0/0/0;对于三层子接口,如:GE0/0/0.1;对于VLANIF接口,如vlanif20。兼容升级场景,后续废弃。 |
"vlanif20" |
subnetId |
string |
0~64个字符。 |
- |
互联子网标识。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
cost |
int32 |
[1-65535] |
- |
接口开销值。 |
1 |
drPriority |
int32 |
[0-255] |
1 |
接口DR优先级。仅网关侧时生效,默认值为1。 |
1 |
mtuEnable |
boolean |
|
- |
接口在发送DD报文时填充MTU值,同时还会检查邻居DD报文所携带的MTU是否超过本端的MTU值。仅网关侧时生效。 |
false |
networkType |
string |
0~16个字符。 |
- |
网络类型。取值:broadcast(将接口的网络类型更改为广播)、nbma(将接口的网络类型更改为NBMA)、p2mp(将接口的网络类型更改为点到多点)、p2p(将接口的网络类型更改为点到点)。仅网关侧生效。 |
"broadcast" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
processId |
int32 |
[1-20000] |
- |
网关侧OSPF进程号,必填。取值范围:1-20000。 |
10 |
routerId |
string |
0~64个字符。 |
- |
用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。兼容升级场景,废弃字段。 |
"192.168.1.1" |
configSource |
string |
0~32个字符。 |
- |
配置源 |
"LANWAN" |
OspfIntfInfo |
REFERENCE |
详细请参见表14。 |
OSPF路由信息。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
interfaceName |
string |
0~16个字符。 |
- |
互联接口的名称。创建更新时不填,查询时返回。对于三层主接口,如:GE0/0/0;对于三层子接口,如:GE0/0/0.1;对于VLANIF接口,如vlanif20。兼容升级场景,后续废弃。 |
"vlanif20" |
subnetId |
string |
0~64个字符。 |
- |
互联子网标识。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
cost |
int32 |
[1-65535] |
- |
接口开销值。 |
1 |
drPriority |
int32 |
[0-255] |
1 |
接口DR优先级。仅网关侧时生效,默认值为1。 |
1 |
mtuEnable |
boolean |
|
- |
接口在发送DD报文时填充MTU值,同时还会检查邻居DD报文所携带的MTU是否超过本端的MTU值。仅网关侧时生效。 |
false |
networkType |
string |
0~16个字符。 |
- |
网络类型。取值:broadcast(将接口的网络类型更改为广播)、nbma(将接口的网络类型更改为NBMA)、p2mp(将接口的网络类型更改为点到多点)、p2p(将接口的网络类型更改为点到点)。仅网关侧生效。 |
"broadcast" |
authMode |
string |
0~16个字符。 |
cryptographic |
认证方式。取值:none(不验证)、simple(简单验证)、cryptographic(加密验证)。推荐使用cryptographic。 |
"cryptographic" |
algorithm |
string |
0~16个字符。 |
hmac-sha256 |
加密算法。取值:hmac-sha256、hmac-md5、md5。hmac-md5和md5验证模式存在安全风险,推荐使用hmac-sha256验证模式。当authMode为cryptographic时,algorithm必填。 |
"hmac-sha256" |
key |
int32 |
[1-255] |
- |
接口密文验证的验证字标识符。当authMode为ENCRYPTION时,key必填。 |
1 |
pwd |
password |
0~256个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 密码必须包含如下规则: -密码长度必须在1~255位。 -密码只支持特殊字符、英文大写字母、英文小写字母和数字。 -为提高安全性,建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种,同时密码长度不小于6个字符。当authMode为SIMPLE或者ENCRYPTION时,key必填。 |
"abc" |
linkId |
string |
36个字符。 |
- |
互联标识,创建和修改时不填,查询时返回。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
linkName |
string |
0~128个字符。 |
- |
互联名称,创建和修改时不填,查询时返回。 |
"ConnectLink" |
areaId |
int64 |
[0-4294967295] |
- |
区域ID。 |
10 |
helloTimer |
int32 |
[1-65535] |
10 |
Hello报文时间间隔。建议Hello报文时间间隔取值不小于5,否则可能会造成邻接关系的中断,默认值为10。 |
1 |
areaType |
string |
0~10个字符。 |
- |
区域类型。取值:normal(缺省情况下,OSPF区域被定义为普通区域)、stub(不允许发布自治系统外部路由,只允许发布区域内路由和区域间的路由)、nssa(NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中)。 |
"normal" |
timerPoll |
int32 |
[1-3600] |
- |
单位为秒,指定发送轮询Hello报文的时间间隔。仅网关侧支持。 |
1 |
timerRetransmit |
int32 |
[1-3600] |
- |
单位为秒,接口重传LSA的时间间隔。仅网关侧时支持。 |
1 |
timerDead |
int32 |
[1-235926000] |
- |
单位为秒,OSPF的邻居失效时间。仅网关侧支持。 |
1 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
linkId |
string |
0~64个字符。 |
- |
互联接口标识。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
coreFailOspfIntfInfo |
ARRAY_REFERENCE |
0-32个列表项,详细请参见表16。 |
核心失败的互联OSPF信息。 |
- |
|
gatewayFailOspfIntfInfo |
ARRAY_REFERENCE |
0-32个列表项,详细请参见表16。 |
网关失败的互联OSPF信息。 |
- |
|
errcode |
string |
0~64个字符。 |
- |
错误码。兼容升级字段,后续废弃 |
"0" |
errmsg |
string |
0~256个字符。 |
- |
错误信息。兼容升级字段,后续废弃 |
"" |
neighborInfo |
REFERENCE |
详细请参见表10。 |
OSPF邻居信息。兼容升级字段,后续废弃 |
- |
|
coreFailInfo |
REFERENCE |
详细请参见表17。 |
核心失败的互联OSPF信息。兼容升级字段,后续废弃 |
- |
|
gatewayFailInfo |
REFERENCE |
详细请参见表17。 |
网关失败的互联OSPF信息。兼容升级字段,后续废弃 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
processId |
int32 |
[1-20000] |
- |
网关侧OSPF进程号,必填。取值范围:1-20000。 |
10 |
routerId |
string |
0~64个字符。 |
- |
用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。兼容升级场景,废弃字段。 |
"192.168.1.1" |
configSource |
string |
0~32个字符。 |
- |
配置源 |
"LANWAN" |
OspfIntfInfo |
REFERENCE |
详细请参见表14。 |
OSPF路由信息。 |
- |
|
errcode |
string |
0~64个字符。 |
- |
错误码。 |
"0" |
errmsg |
string |
0~256个字符。 |
- |
错误信息。 |
"" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
0~64个字符。 |
- |
错误码。 |
"0" |
errmsg |
string |
0~256个字符。 |
- |
错误信息。 |
"" |
processId |
int32 |
[1-65535] |
- |
OSPF进程号。 |
10 |
返回状态码为400:校验异常。
详细信息请参见实际响应消息体。
返回状态码为500:内部错误。
详细信息请参见实际响应消息体。
响应示例
返回状态码为201:创建LANWAN互联OSPF邻居返回信息。
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" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreProcessId" : 10, "gatewayProcessId" : 10, "gatewayRouterId" : "192.168.1.1", "coreOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ], "gatewayOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ] }, "fail" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreFailOspfIntfInfo" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 }, "errcode" : "0", "errmsg" : "" } ], "gatewayFailOspfIntfInfo" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 }, "errcode" : "0", "errmsg" : "" } ], "errcode" : "0", "errmsg" : "", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreFailInfo" : { "errcode" : "0", "errmsg" : "", "processId" : 10 }, "gatewayFailInfo" : { "errcode" : "0", "errmsg" : "", "processId" : 10 } } }
返回状态码为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