网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建LANWAN互联OSPF邻居信息

更新时间:2025-02-17 GMT+08:00
分享

典型场景

LANWAN互联路由,用于创建OSPF邻居。

接口功能

创建LANWAN互联OSPF邻居。

接口约束

该接口支持北向管理员访问,必须在用户会话建立后使用。

创建OSPF邻居之前需要先创建互联口和OSPF进程。

调用方法

POST

URI

/controller/campus/v1/lanwan/interconnection/route/ospf

请求参数

表1 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

routeLinkOspfInfo

REFERENCE

详细请参见表2

创建LANWAN互联OSPF邻居。一次操作只能创建基于一个互联口信息的OSPF。

-

表2 RouteLinkOspfInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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邻居部署信息。

-

表3 OspfNeighborInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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邻居信息。

-

表4 AuthenticationInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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"

表5 InterfaceInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

接口在发送DD报文时填充MTU值,同时还会检查邻居DD报文所携带的MTU是否超过本端的MTU值。仅网关侧时生效。

false

networkType

string

0~16个字符。

-

网络类型。取值:broadcast(将接口的网络类型更改为广播)、nbma(将接口的网络类型更改为NBMA)、p2mp(将接口的网络类型更改为点到多点)、p2p(将接口的网络类型更改为点到点)。仅网关侧生效。

"broadcast"

表6 LinkOspfInterfaceInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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路由信息。

-

表7 OspfInterfaceInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

接口在发送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

请求示例

HTTP的示例
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邻居返回信息。

表8 RouteLinkOspfResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

0~64个字符。

-

错误码。

"0"

errmsg

string

0~256个字符。

-

错误信息。

""

success

REFERENCE

详细请参见表9

创建互联OSPF邻居成功信息。

-

fail

REFERENCE

详细请参见表15

创建互联OSPF邻居失败信息。

-

表9 RouteLinkOspfInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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邻居部署信息。

-

表10 OspfNeighborInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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邻居信息。

-

表11 AuthenticationInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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"

表12 InterfaceInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

接口在发送DD报文时填充MTU值,同时还会检查邻居DD报文所携带的MTU是否超过本端的MTU值。仅网关侧时生效。

false

networkType

string

0~16个字符。

-

网络类型。取值:broadcast(将接口的网络类型更改为广播)、nbma(将接口的网络类型更改为NBMA)、p2mp(将接口的网络类型更改为点到多点)、p2p(将接口的网络类型更改为点到点)。仅网关侧生效。

"broadcast"

表13 LinkOspfInterfaceInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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路由信息。

-

表14 OspfInterfaceInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

接口在发送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

表15 FailRouteLinkOspfInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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信息。兼容升级字段,后续废弃

-

表16 FailLinkOspfInterfaceInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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个字符。

-

错误信息。

""

表17 FailLinkOspfInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容