网络
虚拟私有云 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
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建TNP

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

典型场景

传输网络端口北向API。

接口功能

创建TNP。

接口约束

1、该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。

2、删除开局TNP后,若不想重新开局,需清除WAN业务。清除WAN业务后,将设备恢复开局配置再重新配置TNP,否则可能存在控制器和设备配置不一致的冲突。

3、如果TNP有重建需求,建议设置自定义的vrf和rd。

4、双网关场景需要同步删除两个网关下的TNP。

5、单次操作仅支持创建一个站点的数据。

6、新建TNP时,Eth-Trunk的范围是1~63。

7、FW网关设备仅支持GE、XGE、LTE、Eth-Trunk等接口开局。

8、FW网关设备从V600R024C00及以上版本支持IPv6。

9、FW网关设备从V600R024C00及以上版本支持PPPOE协议。

10、FW网关设备从V600R024C00版本开始支持开启IPv4 Overlay隧道。

11、FW网关设备不支持与网关AR设备混合开局。

12、FW网关设备不支持与FW非网关设备混合开局。

13、FW网关设备不支持DHCP开局模式。

14、iMaster NCE-Campus V300R024C10版本之前开局的V300系列设备默认按照原始IP进行限速,如果需要按照WAN接口实际发出报文限速,需要使能内环隧道带宽统计开销开关。

调用方法

POST

URI

/controller/campus/v1/sdwan/net/transport-network-ports

请求参数

表1 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

tnpInfos

REFERENCE

详细请参见表2

创建TNP对象。

-

表2 TnpInfos对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

multipleSubIfEnabled

boolean

  • true

  • false

-

支持多子接口。第一次创建TNP时生效。若创建时不填,默认值为false。配置后不能修改。

false

enhancedMode

boolean

  • true

  • false

-

是否使能RDB方式启动。使能后URL开局的IPv4协议链路将支持在线更新网络参数,无需重新开局。使能RDB方式启动需要设备版本V300R019C13及以上。第一次创建TNP时生效,V300系列设备支持设置为true和false,V600系列设备只支持设置为true。若创建时不填,V300系列设备默认为false,V600系列设备默认为true。建议不填写此参数。

false

enableNtpAutoClient

boolean

  • true

  • false

-

是否开启客户端跟随父站点。只有站点角色为边缘站点时支持开启,当开启开关后,无需再手工配置链路的TNP配置。第一次创建TNP时生效。默认false。

false

tnps

ARRAY_REFERENCE

1-512个列表项,详细请参见表5

TNP配置信息

-

表3 InterlinkInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

type

string

12个字符。

l3-interface

内联链路端口类型。l3-interface:L3接口。l2-interface:L2接口。当端口类型为l2-interface时,请确保设备上对应的物理口支持切换为二层口,否则设备上线后,内链路端口配置下发失败,需要重新配置。

"l3-interface"

enableGre

boolean

  • true

  • false

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个列表项,详细请参见表4

双网关至少一组,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

表4 PortPairInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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

表5 TnpInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

id

string

-

-

传输网络端口ID,uuid格式。更新时必填。

"00000000-0000-0000-0000-000000000000"

name

string

0~64个字符。

-

传输网络端口名称。创建时必填。V300系列设备从V300R023C10版本开始支持修改,V600系列设备版本不支持修改。可以填写数字、字母、中文、空格(不能全为空格)和特殊字符,其中特殊字符包括!"#$%&'()*+,_-./:;<=>@[\]^`{|}~。

"Link1"

siteId

string

-

-

站点ID,uuid格式。创建时必填。

"00000000-0000-0000-0000-000000000000"

deviceId

string

-

-

设备ID,uuid格式。创建时必填。

"00000000-0000-0000-0000-000000000000"

portId

string

-

-

物理端口ID,uuid格式。Eth-Trunk、XGE创建时必填。

"00000000-0000-0000-0000-000000000000"

portType

integer

-

-

端口类型。portId为空时,必填,1:GE;2:FE;3:LTE;4:xDSL(ATM);5:xDSL(PTM);6:XGE;7:E1-IMA(ATM);8:Ima-group;9:Serial;10:Eth-Trunk;11:40GE;12:MultiGE;13:25GE;20:虚拟LoopBack。V600版本设备配置LTE接口时,必须开启子接口,且V600版本设备LTE接口不支持IPv6。

1

portNum

string

-

-

端口号。portId为空时,必填。LoopBack口时必填端口号,范围900~909。

"0/0/1"

enable5G

boolean

  • true

  • false

-

是否扩大带宽配置范围。配置无作用,废弃字段。

-

inSubInterface

boolean

  • true

  • false

false

是否开启子接口,默认不开启。创建后不可修改。

false

vlanId

int32

[1-4094]

-

VLAN ID:1~4094。开启子接口时必须指定。

1

subInterfaceNumber

int32

[1-4094]

-

子接口编号。开启子接口时填写,创建后不可修改,不填时默认值与vlanId一致。LTE接口,V600系列设备仅V600R021C00及之后版本的设备支持子接口范围:1~4,其他系列设备支持子接口范围:1~2。

1

tnplinkInfo

REFERENCE

详细请参见表6

链接信息。

-

ipConnection

REFERENCE

详细请参见表10

接口IP信息。

-

transportNetworkInfo

REFERENCE

详细请参见表13

TNP信息。

-

ntp

ARRAY_REFERENCE

0-12个列表项,详细请参见表14

NTP配置信息。

-

attributes

REFERENCE

详细请参见表15

属性信息。

-

description

string

0~242个字符。

-

传输网络端口描述。支持配置字母,数字,特殊字符(!"#$%&'()*+,_-./:;<=>@[]^`{|}~)。

"site tnp"

natEnable

boolean

  • true

  • false

false

是否开启NAT穿越。默认false。RR站点只能传false。

false

ztpMode

int32

-

-

IPv4开局方式。0---链路参数通过U盘/邮件/手工下发;1---通过控制器下发。FW网关设备只能传1。

0

ipv6ZtpMode

int32

-

-

IPv6开局方式。0---链路参数通过U盘/邮件/手工下发;1---通过控制器下发。FW网关设备只能传1。该字段为0时,enableIPv6AcSouthAccess必须为true。

0

underlayVrf

string

0~31个字符。

-

VPN实例。不能包含?,空格,中文。建议使用underlay_开头。不可修改。

"underlay_1"

routingDistinguisher

string

0~64个字符。

-

路由标识值。不可配置为5500:5500,此值预留给增强模式下的vlanif使用。填写格式如下:

1、2字节自治系统号:4字节用户自定义数,自治系统号范围:0-65535,用户自定义数范围:0-4294967295,例如:101:3。不能配置为0:0。

2、4字节自治系统号:2字节用户自定义数,自治系统号范围:65536-4294967295,用户自定义数范围:0-65535,例如0:3或者65537:3。不能配置为0:0。

3、点分形式4字节自治系统号:2字节用户自定义数,点分形式自治系统号通常写成x.y的形式,x和y的范围都是0-65535,用户自定义数范围:0-65535,例如0.0:3或者0.1:0。不能配置为0.0:0。

4、IPv4地址:2字节用户自定义数,IP地址范围:0.0.0.0-255.255.255.255,用户自定义数范围:0-65535,例如:192.168.122.15:1。

"1111:1111"

clearDeviceConfig

boolean

  • true

  • false

true

仅删除时生效。 删除链路时是否删除设备配置。只在ztpMode为1且删除链路时使用该字段。删除链路时不删除设备配置易出现配置不一致问题,不推荐设置为false。

true

enableOverlay

boolean

  • true

  • false

true

是否使能Overlay功能。若使能,则在这条WAN链路上创建Overlay隧道。

true

enableIpv6Overlay

boolean

  • true

  • false

true

是否使能IPv6 Overlay功能。若使能,则在这条WAN链路上创建Overlay隧道。对于V300版本设备,仅支持IPv4 over IPv6隧道,即Underlay网络为IPv6网络,Overlay网络为IPv4网络场景。

false

acSouthAccessId

string

0~64个字符。

-

南向接入服务1的ID,uuid格式。填空字符串为不接入南向服务,配置后不能修改。不填时默认为00000000-0000-0000-0000-000000000001。创建且ztpMode为0时,acSouthAccessId必填。

"00000000-0000-0000-0000-000000000001"

mailUsedSouthAccess

boolean

  • true

  • false

false

邮件开局时,邮件url的南向接入服务。默认为false。多条URL链路选择不同南向接入服务时,需要指定邮件url的南向接入服务

false

linkInformation

string

0~128个字符。

-

链路ID。

"link1"

accessPreference

string

0~10个字符。

-

IPv4南向接入优先级,必须要有南向接入服务,取值范围:high、medium、low,high表示高,medium表示中,low表示低。

"low"

enableSecondSouthAccess

boolean

  • true

  • false

false

是否使用第二个IPv4南向接入服务,默认为false。如果要配置南向接入服务2,必须配置南向接入服务1。

false

secondSouthAccess

REFERENCE

详细请参见表16

IPv4南向接入服务2信息。当一条链路需要连接两个南向接入服务时填写。enableSecondSouthAccess为true时生效。

-

syncModifyDeviceUrlConfig

boolean

  • true

  • false

false

配置URL链路同步修改设备。默认false且首次配置时不允许设置为true,当链路为URL开局链路且设备在线时支持使能。V600系列设备不支持使能此功能。V300系列设备,首次配置后,新增开局链路时必须使能该配置。

false

enableLoopbackSrcInterface

boolean

  • true

  • false

false

物理口链路使能Loopback接口作为源接口注册。默认false。

仅V300系列设备在V300R023C00及以上版本支持该功能。

该功能不支持URL开局,需要在设备手工开局。

false

enableRu

boolean

  • true

  • false

-

是否为RU链路。仅查询时使用。

false

disableDefaultRuRoute

boolean

  • true

  • false

false

是否关闭RU链路默认路由。当链路为RU链路时支持配置。

false

表6 TnpLinkInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

cellular

REFERENCE

详细请参见表7

Cellular信息,关联主SIM卡。

-

standbyCellularEnable

boolean

  • true

  • false

false

是否使能备Cellular。V600系列设备不支持使能此功能。

false

standbyCellular

REFERENCE

详细请参见表7

备Cellular信息,关联备SIM卡。standbyCellularEnable为true时必填。

-

simSwitchBackEnable

boolean

  • true

  • false

false

使能备份SIM卡自动回切到主SIM卡。

false

simSwitchBackTime

int32

[1-65535]

-

表示经过多长时间,备份SIM卡才主动回切到主SIM卡,simSwitchBackEnable为true时,如果不填默认为60分钟。

60

atm

REFERENCE

详细请参见表9

atm信息

-

表7 TnpLinkInfoCellular对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

apn

string

0~99个字符。

-

接入点名称。支持英文字母,数字和连接符(-)。

"abc"

userName

string

0~128个字符。

-

用户名称。不能包含空格和中文字符。userName和userKey,必须同时配置。

"user1"

userKey

string

0~128个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

用户密码。支持配置特殊字符(/'`!@#$%^&()_+=-[]{},.;)、英文字母和数字。建议配置长度不小于8个字符。userName和userKey,必须同时配置。

"******"

authType

int32

-

-

鉴权方式。只能填0、1或2。0表示chap模式,1表示pap模式,2表示pap+chap模式。

0

priority

int8

[1-255]

100

优先级。值越大,优先级越高。

100

trackEnable

boolean

  • true

  • false

false

指定NQA测试例。

false

nqaInfo

REFERENCE

详细请参见表8

NQA测试例

-

表8 NqaInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

destAddress

string

0~15个字符。

-

目的IP。

"192.168.1.1"

表9 TnpLinkInfoAtm对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

pvcVpi

int32

[0-255]

-

PVC VPI。取值范围: 0-255

123

pvcVci

int32

-

-

PVC VCI。取值范围:0-2,5-65534

123

表10 IpConnectionInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

ipv4

REFERENCE

详细请参见表11

IPv4信息。在更新场景,若ipConnection非空,IPv4为null或不填表示删除IPv4配置;若ipConnection为空,表示IPv4配置不变。

-

ipv6

REFERENCE

详细请参见表12

IPv6信息。在更新场景,若ipConnection非空,IPv6为null或不填表示删除IPv6配置;若ipConnection为空,表示IPv6配置不变。

FW网关设备在V600R024C00及以上版本支持IPv6,使用IPv6功能,需要在管理面配置控制器南向和文件服务器的IPv6地址,并且V600系列设备需要V600R022C00及以上版本支持此功能。

IPv6功能仅支持FE、GE、XGE、25GE、40GE、MultiGE类型的接口。仅V300系列设备在V300R022C10及以上版本可以支持xDSL(PTM)接口。仅V300系列设备在V300R023C00及以上版本并且支持5G接口板的设备可以支持LTE接口。

-

表11 Ipv4Info对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

publicIP

string

0~15个字符。

-

公网IP,非路由反射器的角色必须为空。

"192.168.1.1"

accessType

string

0~16个字符。

-

接口协议类型:IPoE、PPPoE、IPoA、IPoEoA、PPPoA、PPPoEoA、PPP、HDLC、FR。创建时必填。AR6700V-L款型设备不支持PPPoE。

接口类型为FE/GE/MultiGE/XGE/40GE/xDSL(PTM)时支持:IPoE、PPPoE。

接口类型为xDSL(ATM)/E1-IMA(ATM)/Ima-group时支持:IPoA、IPoEoA、PPPoA、PPPoEoA。

接口类型为Serial时支持:PPP、HDLC、FR。

接口类型为Eth-Trunk时支持:IPoE。

接口类型为LoopBack时支持:IPoE。

"PPPoE"

ipMode

string

0~16个字符。

-

IP分配模式:Static、DHCP。当accessType为IPoE或IPoEoA时配置。当accessType为IPoE或IPoEoA时必填。RR站点仅支持Static。

"Static"

customerAddress

string

0~15个字符。

-

IP地址。当accessType为IPoE或IPoEoA并且ipMode为Static,或者accessType为IPoA,才需要配置。

"192.168.1.1"

prefixLength

int32

-

-

掩码, 取值范围:1-32。当accessType为IPoE或IPoEoA并且ipMode为Static,或者accessType为IPoA,才需要配置。

24

providerAddress

string

0~15个字符。

-

默认网关。当accessType为IPoE或IPoEoA并且ipMode为Static,或者accessType为IPoA,才需要配置。

"192.168.1.1"

peerIp

string

0~32个字符。

-

对端IP。

"192.168.1.1"

userName

string

0~64个字符。

-

PPPoE模式下:用户名。不能包含空格和中文字符。

"admin"

userKey

string

0~64个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

PPPoE模式下:密码。

支持配置特殊字符(/'`!@#$%^&()_+=-[]{},.;)、英文字母和数字,不能包含回车换行、空格、问号和双引号。

为提高安全性,建议密码至少包含小写字母、大写字母、数字、特殊字符(_~!@#$%^&*()+-={I:;<,>.})这四种形式中的两种。

建议配置长度不小于6个字符,不超过32个字符。

"******"

authType

int32

-

-

PPPoE等模式的鉴权方式,只能填0、1或2。0表示chap模式,1表示pap模式,2表示pap+chap模式。默认值为0。

0

dlci

int32

-

-

DLCI,接口类型为Serial,协议类型FR时填写,取值范围:16-1022。

55

interfaceMode

int32

-

-

接入类型,接口类型为Serial,协议类型FR,打开子接口开关时填写,0代表P2MP,1代表P2P。

0

表12 TnpIpv6Info对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

accessType

string

0~16个字符。

-

接口协议类型:只支持IPoE。创建时必填。

"IPoE"

ipMode

string

0~16个字符。

-

IP分配模式:Static、DHCPv6、ND、PD。创建时必填。RR站点仅支持Static,PD模式只支持URL开局链路。

静态: 配置从ISP处获得的固定IPv6地址。

动态:配置从ISP处自动获得IPv6地址。

邻居发现:通过邻居发现协议自动生成IPv6地址。V600系列设备仅V600R023C10及以上版本支持此功能。

"Static"

customerIPv6Address

string

0~39个字符。

-

IP地址。ipMode为Static时填写。

"fc00:3::1"

ipv6PrefixLength

int32

-

-

前缀长度,取值范围:1-128。ipMode为Static时填写。

64

providerIpv6Address

string

0~39个字符。

-

默认网关。ipMode为Static时填写。

"fc00:3::1"

linkIpv6Pd

string

0~63个字符。

-

指定PD接口的PD前缀。ipMode为PD时选填。

"sdwanprefix"

linkIpv6PdAddr

string

0~128个字符。

-

指定PD接口的IPv6地址。ipMode为PD时选填。

"fc00:3::1/64"

linkDhcpv6Option16Type

string

0~32个字符。

-

指定自定义的选项码字符串类型:ascii、hex,默认为ascii。ipMode为DHCPv6、PD时选填。

"ascii"

linkDhcpv6Option16

string

0~256个字符。

-

dhcpv6 option16值。linkDhcpv6Option16Type 为ascii时,字符串形式,不支持空格,区分大小写,长度范围是1~250。linkDhcpv6Option16Type为hex时,偶数位长度的十六进制字符串(如hh或hhhh),不支持空格,区分大小写,仅可以配置为包含0~9、A~F和a~f的组合,长度范围是10~256。ipMode为DHCPv6、PD时选填。

"101068,0001"

linkDhcpv6Pd

string

0~63个字符。

-

指定DHCPv6客户端的PD前缀的名称。ipMode为PD时选填。

"sdwanprefix"

enableIPv6AcSouthAccess

boolean

  • true

  • false

true

是否连接IPv6南向地址。

true

ipv6AcSouthAccessId

uuid

0~64个字符。

-

IPv6南向接入服务id,uuid格式。enableIPv6AcSouthAccess为true时,如果不填默认为00000000-0000-0000-0000-000000000003。

"00000000-0000-0000-0000-000000000003"

ipv6MailUsedSouthAccess

boolean

  • true

  • false

false

邮件开局时,邮件url的IPv6南向接入服务。默认为false。多条URL链路选择不同IPv6南向接入服务时,需要指定邮件url的IPv6南向接入服务

false

ipv6AccessPreference

string

0~10个字符。

-

IPv6南向接入优先级,必须要有南向接入服务,取值范围:high、medium、low,high表示高,medium表示中,low表示低。

V600版本的设备,此优先级配置仅对性能通道生效,且V600R022C00及以后的版本支持。V300版本的设备在V300R021C10及以后的版本支持。

"low"

表13 TnpTransportNetworkInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

transportNetworkId

string

-

-

传输网络ID,uuid格式。创建时必填。V300系列设备的V300R023C10或以上版本支持修改该字段。

"00000000-0000-0000-0000-000000000000"

workMode

string

6~7个字符。

active

传输网络对应的角色 active、standby。创建时必填,不区分大小写。

"active"

sendAlarmEnabled

boolean

  • true

  • false

false

standby链路被使用时,是否上报告警。默认值为false。

false

表14 NtpInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

id

uuid

-

-

NTP ID,uuid格式。

"00000000-0000-0000-0000-000000000000"

ntpType

string

4个字符。

IPv4

NTP服务器地址类型,取值范围:IPv4、IPv6。

"IPv6"

preferEn

boolean

  • true

  • false

false

是否指定该远程服务器为优先选择的服务器。

false

serverIP

string

0~39个字符。

-

NTP服务器地址。当ntpType为IPv4,serverIp为IPv4地址,如:192.168.1.1;当ntpType为IPv6,serverIp为IPv6地址,如:fc00:3::1。

"fc00:3::1"

authentication

boolean

  • true

  • false

false

是否认证。

false

mode

string

0~16个字符。

-

认证模式,取值范围:MD5、HMAC-SHA256。当authentication为true时,mode必填。V600版本设备不支持MD5。

"HMAC-SHA256"

authKey

string

6~255个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

认证密码,当authentication为true时,authKey必填。V300系列设备密码长度必须在6-255位,且必须满足复杂度,即必须包含特殊字符("`!@#$%^&()_+=-[]{},.;)、英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)中的任意两种组合及以上。V600系列设备仅V600R021C00及之后版本设备的密码必须包含12-255个字符,并且必须包含以下内容:大写字母,小写字母,数字和特殊字符("`!@#$%^&()_+=-[]{},.;)。建议密码长度配置在12位以上。

"******"

authId

int64

-

-

认证ID。取值范围:1-4294967295,其中V600版本设备在配置IPv6服务器时最大值为65535。当authentication为true时,authId必填。

10

表15 AttributesInfo对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

inputBandwidth

int32

-

-

下行容量(Kbps),取值范围:10-40000000。创建时必填,不同设备款型和接口类型有所差异,具体以设备为准。

如果未配置Overlay Inbound方向的流量分配或Overlay Inbound方向的QoS,则下行容量限速不生效。

1000

outputBandwidth

int32

-

-

上行容量(Kbps),取值范围:10-40000000。接口类型为Loopback时不支持,其余接口类型创建时必填,不同设备款型和接口类型有所差异,具体以设备为准。

如果未配置Overlay Outbound方向的流量分配或Overlay Outbound方向的QoS,则上行容量限速不生效。

1000

mtu

int32

-

1500

MTU,取值范围:46-9550,默认1500。

1500

TCPmss

int32

-

1200

TCP MSS。V300版本设备取值范围:230-2048,V600版本设备取值范围:128-9500,默认1200,建议MSS的值≤MTU的值-40。FW网关设备不支持。

1200

ipv6Mtu

int64

-

1500

MTU,取值范围:1280-9550,默认1500。

FW网关设备不支持。

1500

表16 SecondSouthAccess对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

acSouthAccessId

string

0~36个字符。

-

南向接入服务id,uuid格式。enableSecondSouthAccess为true时填写。不能与acSouthAccessId相同。

"00000000-0000-0000-0000-000000000002"

accessPreference

string

0~10个字符。

-

南向接入优先级,必须要有南向接入服务,取值范围:high、medium、low,high表示高,medium表示中,low表示低。

"low"

请求示例

HTTP的示例
POST /controller/campus/v1/sdwan/net/transport-network-ports 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
{
	"multipleSubIfEnabled" : false,
	"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
	},
	"enhancedMode" : false,
	"enableNtpAutoClient" : false,
	"tnps" : [
		{
			"id" : "00000000-0000-0000-0000-000000000000",
			"name" : "Link1",
			"siteId" : "00000000-0000-0000-0000-000000000000",
			"deviceId" : "00000000-0000-0000-0000-000000000000",
			"portId" : "00000000-0000-0000-0000-000000000000",
			"portType" : 1,
			"portNum" : "0/0/1",
			"enable5G" : "",
			"inSubInterface" : false,
			"vlanId" : 1,
			"subInterfaceNumber" : 1,
			"tnplinkInfo" : {
				"cellular" : {
					"apn" : "abc",
					"userName" : "user1",
					"userKey" : "******",
					"authType" : 0,
					"priority" : 100,
					"trackEnable" : false,
					"nqaInfo" : {
						"destAddress" : "192.168.1.1"
					}
				},
				"standbyCellularEnable" : false,
				"standbyCellular" : {
					"apn" : "abc",
					"userName" : "user1",
					"userKey" : "******",
					"authType" : 0,
					"priority" : 100,
					"trackEnable" : false,
					"nqaInfo" : {
						"destAddress" : "192.168.1.1"
					}
				},
				"simSwitchBackEnable" : false,
				"simSwitchBackTime" : 60,
				"atm" : {
					"pvcVpi" : 123,
					"pvcVci" : 123
				}
			},
			"ipConnection" : {
				"ipv4" : {
					"publicIP" : "192.168.1.1",
					"accessType" : "PPPoE",
					"ipMode" : "Static",
					"customerAddress" : "192.168.1.1",
					"prefixLength" : 24,
					"providerAddress" : "192.168.1.1",
					"peerIp" : "192.168.1.1",
					"userName" : "admin",
					"userKey" : "******",
					"authType" : 0,
					"dlci" : 55,
					"interfaceMode" : 0
				},
				"ipv6" : {
					"accessType" : "IPoE",
					"ipMode" : "Static",
					"customerIPv6Address" : "fc00:3::1",
					"ipv6PrefixLength" : 64,
					"providerIpv6Address" : "fc00:3::1",
					"linkIpv6Pd" : "sdwanprefix",
					"linkIpv6PdAddr" : "fc00:3::1/64",
					"linkDhcpv6Option16Type" : "ascii",
					"linkDhcpv6Option16" : "101068,0001",
					"linkDhcpv6Pd" : "sdwanprefix",
					"enableIPv6AcSouthAccess" : true,
					"ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003",
					"ipv6MailUsedSouthAccess" : false,
					"ipv6AccessPreference" : "low"
				}
			},
			"transportNetworkInfo" : {
				"transportNetworkId" : "00000000-0000-0000-0000-000000000000",
				"workMode" : "active",
				"sendAlarmEnabled" : false
			},
			"ntp" : [
				{
					"id" : "00000000-0000-0000-0000-000000000000",
					"ntpType" : "IPv6",
					"preferEn" : false,
					"serverIP" : "fc00:3::1",
					"authentication" : false,
					"mode" : "HMAC-SHA256",
					"authKey" : "******",
					"authId" : 10
				}
			],
			"attributes" : {
				"inputBandwidth" : 1000,
				"outputBandwidth" : 1000,
				"mtu" : 1500,
				"TCPmss" : 1200,
				"ipv6Mtu" : 1500
			},
			"description" : "site tnp",
			"natEnable" : false,
			"ztpMode" : 0,
			"ipv6ZtpMode" : 0,
			"underlayVrf" : "underlay_1",
			"routingDistinguisher" : "1111:1111",
			"clearDeviceConfig" : true,
			"enableOverlay" : true,
			"enableIpv6Overlay" : false,
			"acSouthAccessId" : "00000000-0000-0000-0000-000000000001",
			"mailUsedSouthAccess" : false,
			"linkInformation" : "link1",
			"accessPreference" : "low",
			"enableSecondSouthAccess" : false,
			"secondSouthAccess" : {
				"acSouthAccessId" : "00000000-0000-0000-0000-000000000002",
				"accessPreference" : "low"
			},
			"syncModifyDeviceUrlConfig" : false,
			"enableLoopbackSrcInterface" : false,
			"enableRu" : false,
			"disableDefaultRuRoute" : false
		}
	]
}

响应参数

返回状态码为201:创建TNP成功,响应体参考TnpResponse。

表17 TnpResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

-

-

错误码。

"0"

errmsg

string

-

-

错误信息。

""

success

ARRAY_REFERENCE

0-512个列表项,详细请参见表18

成功的TNP信息列表。

-

fail

ARRAY_REFERENCE

0-512个列表项,详细请参见表30

失败的TNP信息列表。

-

表18 TnpInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

id

string

-

-

传输网络端口ID,uuid格式。更新时必填。

"00000000-0000-0000-0000-000000000000"

name

string

0~64个字符。

-

传输网络端口名称。创建时必填。V300系列设备从V300R023C10版本开始支持修改,V600系列设备版本不支持修改。可以填写数字、字母、中文、空格(不能全为空格)和特殊字符,其中特殊字符包括!"#$%&'()*+,_-./:;<=>@[\]^`{|}~。

"Link1"

siteId

string

-

-

站点ID,uuid格式。创建时必填。

"00000000-0000-0000-0000-000000000000"

deviceId

string

-

-

设备ID,uuid格式。创建时必填。

"00000000-0000-0000-0000-000000000000"

portId

string

-

-

物理端口ID,uuid格式。Eth-Trunk、XGE创建时必填。

"00000000-0000-0000-0000-000000000000"

portType

integer

-

-

端口类型。portId为空时,必填,1:GE;2:FE;3:LTE;4:xDSL(ATM);5:xDSL(PTM);6:XGE;7:E1-IMA(ATM);8:Ima-group;9:Serial;10:Eth-Trunk;11:40GE;12:MultiGE;13:25GE;20:虚拟LoopBack。V600版本设备配置LTE接口时,必须开启子接口,且V600版本设备LTE接口不支持IPv6。

1

portNum

string

-

-

端口号。portId为空时,必填。LoopBack口时必填端口号,范围900~909。

"0/0/1"

enable5G

boolean

  • true

  • false

-

是否扩大带宽配置范围。配置无作用,废弃字段。

-

inSubInterface

boolean

  • true

  • false

false

是否开启子接口,默认不开启。创建后不可修改。

false

vlanId

int32

[1-4094]

-

VLAN ID:1~4094。开启子接口时必须指定。

1

subInterfaceNumber

int32

[1-4094]

-

子接口编号。开启子接口时填写,创建后不可修改,不填时默认值与vlanId一致。LTE接口,V600系列设备仅V600R021C00及之后版本的设备支持子接口范围:1~4,其他系列设备支持子接口范围:1~2。

1

tnplinkInfo

REFERENCE

详细请参见表19

链接信息。

-

ipConnection

REFERENCE

详细请参见表23

接口IP信息。

-

transportNetworkInfo

REFERENCE

详细请参见表26

TNP信息。

-

ntp

ARRAY_REFERENCE

0-12个列表项,详细请参见表27

NTP配置信息。

-

attributes

REFERENCE

详细请参见表28

属性信息。

-

description

string

0~242个字符。

-

传输网络端口描述。支持配置字母,数字,特殊字符(!"#$%&'()*+,_-./:;<=>@[]^`{|}~)。

"site tnp"

natEnable

boolean

  • true

  • false

false

是否开启NAT穿越。默认false。RR站点只能传false。

false

ztpMode

int32

-

-

IPv4开局方式。0---链路参数通过U盘/邮件/手工下发;1---通过控制器下发。FW网关设备只能传1。

0

ipv6ZtpMode

int32

-

-

IPv6开局方式。0---链路参数通过U盘/邮件/手工下发;1---通过控制器下发。FW网关设备只能传1。该字段为0时,enableIPv6AcSouthAccess必须为true。

0

underlayVrf

string

0~31个字符。

-

VPN实例。不能包含?,空格,中文。建议使用underlay_开头。不可修改。

"underlay_1"

routingDistinguisher

string

0~64个字符。

-

路由标识值。不可配置为5500:5500,此值预留给增强模式下的vlanif使用。填写格式如下:

1、2字节自治系统号:4字节用户自定义数,自治系统号范围:0-65535,用户自定义数范围:0-4294967295,例如:101:3。不能配置为0:0。

2、4字节自治系统号:2字节用户自定义数,自治系统号范围:65536-4294967295,用户自定义数范围:0-65535,例如0:3或者65537:3。不能配置为0:0。

3、点分形式4字节自治系统号:2字节用户自定义数,点分形式自治系统号通常写成x.y的形式,x和y的范围都是0-65535,用户自定义数范围:0-65535,例如0.0:3或者0.1:0。不能配置为0.0:0。

4、IPv4地址:2字节用户自定义数,IP地址范围:0.0.0.0-255.255.255.255,用户自定义数范围:0-65535,例如:192.168.122.15:1。

"1111:1111"

clearDeviceConfig

boolean

  • true

  • false

true

仅删除时生效。 删除链路时是否删除设备配置。只在ztpMode为1且删除链路时使用该字段。删除链路时不删除设备配置易出现配置不一致问题,不推荐设置为false。

true

enableOverlay

boolean

  • true

  • false

true

是否使能Overlay功能。若使能,则在这条WAN链路上创建Overlay隧道。

true

enableIpv6Overlay

boolean

  • true

  • false

true

是否使能IPv6 Overlay功能。若使能,则在这条WAN链路上创建Overlay隧道。对于V300版本设备,仅支持IPv4 over IPv6隧道,即Underlay网络为IPv6网络,Overlay网络为IPv4网络场景。

false

acSouthAccessId

string

0~64个字符。

-

南向接入服务1的ID,uuid格式。填空字符串为不接入南向服务,配置后不能修改。不填时默认为00000000-0000-0000-0000-000000000001。创建且ztpMode为0时,acSouthAccessId必填。

"00000000-0000-0000-0000-000000000001"

mailUsedSouthAccess

boolean

  • true

  • false

false

邮件开局时,邮件url的南向接入服务。默认为false。多条URL链路选择不同南向接入服务时,需要指定邮件url的南向接入服务

false

linkInformation

string

0~128个字符。

-

链路ID。

"link1"

accessPreference

string

0~10个字符。

-

IPv4南向接入优先级,必须要有南向接入服务,取值范围:high、medium、low,high表示高,medium表示中,low表示低。

"low"

enableSecondSouthAccess

boolean

  • true

  • false

false

是否使用第二个IPv4南向接入服务,默认为false。如果要配置南向接入服务2,必须配置南向接入服务1。

false

secondSouthAccess

REFERENCE

详细请参见表29

IPv4南向接入服务2信息。当一条链路需要连接两个南向接入服务时填写。enableSecondSouthAccess为true时生效。

-

syncModifyDeviceUrlConfig

boolean

  • true

  • false

false

配置URL链路同步修改设备。默认false且首次配置时不允许设置为true,当链路为URL开局链路且设备在线时支持使能。V600系列设备不支持使能此功能。V300系列设备,首次配置后,新增开局链路时必须使能该配置。

false

enableLoopbackSrcInterface

boolean

  • true

  • false

false

物理口链路使能Loopback接口作为源接口注册。默认false。

仅V300系列设备在V300R023C00及以上版本支持该功能。

该功能不支持URL开局,需要在设备手工开局。

false

enableRu

boolean

  • true

  • false

-

是否为RU链路。仅查询时使用。

false

disableDefaultRuRoute

boolean

  • true

  • false

false

是否关闭RU链路默认路由。当链路为RU链路时支持配置。

false

表19 TnpLinkInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

cellular

REFERENCE

详细请参见表20

Cellular信息,关联主SIM卡。

-

standbyCellularEnable

boolean

  • true

  • false

false

是否使能备Cellular。V600系列设备不支持使能此功能。

false

standbyCellular

REFERENCE

详细请参见表20

备Cellular信息,关联备SIM卡。standbyCellularEnable为true时必填。

-

simSwitchBackEnable

boolean

  • true

  • false

false

使能备份SIM卡自动回切到主SIM卡。

false

simSwitchBackTime

int32

[1-65535]

-

表示经过多长时间,备份SIM卡才主动回切到主SIM卡,simSwitchBackEnable为true时,如果不填默认为60分钟。

60

atm

REFERENCE

详细请参见表22

atm信息

-

表20 TnpLinkInfoCellular对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

apn

string

0~99个字符。

-

接入点名称。支持英文字母,数字和连接符(-)。

"abc"

userName

string

0~128个字符。

-

用户名称。不能包含空格和中文字符。userName和userKey,必须同时配置。

"user1"

userKey

string

0~128个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

用户密码。支持配置特殊字符(/'`!@#$%^&()_+=-[]{},.;)、英文字母和数字。建议配置长度不小于8个字符。userName和userKey,必须同时配置。

"******"

authType

int32

-

-

鉴权方式。只能填0、1或2。0表示chap模式,1表示pap模式,2表示pap+chap模式。

0

priority

int8

[1-255]

100

优先级。值越大,优先级越高。

100

trackEnable

boolean

  • true

  • false

false

指定NQA测试例。

false

nqaInfo

REFERENCE

详细请参见表21

NQA测试例

-

表21 NqaInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

destAddress

string

0~15个字符。

-

目的IP。

"192.168.1.1"

表22 TnpLinkInfoAtm对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

pvcVpi

int32

[0-255]

-

PVC VPI。取值范围: 0-255

123

pvcVci

int32

-

-

PVC VCI。取值范围:0-2,5-65534

123

表23 IpConnectionInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

ipv4

REFERENCE

详细请参见表24

IPv4信息。在更新场景,若ipConnection非空,IPv4为null或不填表示删除IPv4配置;若ipConnection为空,表示IPv4配置不变。

-

ipv6

REFERENCE

详细请参见表25

IPv6信息。在更新场景,若ipConnection非空,IPv6为null或不填表示删除IPv6配置;若ipConnection为空,表示IPv6配置不变。

FW网关设备在V600R024C00及以上版本支持IPv6,使用IPv6功能,需要在管理面配置控制器南向和文件服务器的IPv6地址,并且V600系列设备需要V600R022C00及以上版本支持此功能。

IPv6功能仅支持FE、GE、XGE、25GE、40GE、MultiGE类型的接口。仅V300系列设备在V300R022C10及以上版本可以支持xDSL(PTM)接口。仅V300系列设备在V300R023C00及以上版本并且支持5G接口板的设备可以支持LTE接口。

-

表24 Ipv4Info对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

publicIP

string

0~15个字符。

-

公网IP,非路由反射器的角色必须为空。

"192.168.1.1"

accessType

string

0~16个字符。

-

接口协议类型:IPoE、PPPoE、IPoA、IPoEoA、PPPoA、PPPoEoA、PPP、HDLC、FR。创建时必填。AR6700V-L款型设备不支持PPPoE。

接口类型为FE/GE/MultiGE/XGE/40GE/xDSL(PTM)时支持:IPoE、PPPoE。

接口类型为xDSL(ATM)/E1-IMA(ATM)/Ima-group时支持:IPoA、IPoEoA、PPPoA、PPPoEoA。

接口类型为Serial时支持:PPP、HDLC、FR。

接口类型为Eth-Trunk时支持:IPoE。

接口类型为LoopBack时支持:IPoE。

"PPPoE"

ipMode

string

0~16个字符。

-

IP分配模式:Static、DHCP。当accessType为IPoE或IPoEoA时配置。当accessType为IPoE或IPoEoA时必填。RR站点仅支持Static。

"Static"

customerAddress

string

0~15个字符。

-

IP地址。当accessType为IPoE或IPoEoA并且ipMode为Static,或者accessType为IPoA,才需要配置。

"192.168.1.1"

prefixLength

int32

-

-

掩码, 取值范围:1-32。当accessType为IPoE或IPoEoA并且ipMode为Static,或者accessType为IPoA,才需要配置。

24

providerAddress

string

0~15个字符。

-

默认网关。当accessType为IPoE或IPoEoA并且ipMode为Static,或者accessType为IPoA,才需要配置。

"192.168.1.1"

peerIp

string

0~32个字符。

-

对端IP。

"192.168.1.1"

userName

string

0~64个字符。

-

PPPoE模式下:用户名。不能包含空格和中文字符。

"admin"

userKey

string

0~64个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

PPPoE模式下:密码。

支持配置特殊字符(/'`!@#$%^&()_+=-[]{},.;)、英文字母和数字,不能包含回车换行、空格、问号和双引号。

为提高安全性,建议密码至少包含小写字母、大写字母、数字、特殊字符(_~!@#$%^&*()+-={I:;<,>.})这四种形式中的两种。

建议配置长度不小于6个字符,不超过32个字符。

"******"

authType

int32

-

-

PPPoE等模式的鉴权方式,只能填0、1或2。0表示chap模式,1表示pap模式,2表示pap+chap模式。默认值为0。

0

dlci

int32

-

-

DLCI,接口类型为Serial,协议类型FR时填写,取值范围:16-1022。

55

interfaceMode

int32

-

-

接入类型,接口类型为Serial,协议类型FR,打开子接口开关时填写,0代表P2MP,1代表P2P。

0

表25 TnpIpv6Info对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

accessType

string

0~16个字符。

-

接口协议类型:只支持IPoE。创建时必填。

"IPoE"

ipMode

string

0~16个字符。

-

IP分配模式:Static、DHCPv6、ND、PD。创建时必填。RR站点仅支持Static,PD模式只支持URL开局链路。

静态: 配置从ISP处获得的固定IPv6地址。

动态:配置从ISP处自动获得IPv6地址。

邻居发现:通过邻居发现协议自动生成IPv6地址。V600系列设备仅V600R023C10及以上版本支持此功能。

"Static"

customerIPv6Address

string

0~39个字符。

-

IP地址。ipMode为Static时填写。

"fc00:3::1"

ipv6PrefixLength

int32

-

-

前缀长度,取值范围:1-128。ipMode为Static时填写。

64

providerIpv6Address

string

0~39个字符。

-

默认网关。ipMode为Static时填写。

"fc00:3::1"

linkIpv6Pd

string

0~63个字符。

-

指定PD接口的PD前缀。ipMode为PD时选填。

"sdwanprefix"

linkIpv6PdAddr

string

0~128个字符。

-

指定PD接口的IPv6地址。ipMode为PD时选填。

"fc00:3::1/64"

linkDhcpv6Option16Type

string

0~32个字符。

-

指定自定义的选项码字符串类型:ascii、hex,默认为ascii。ipMode为DHCPv6、PD时选填。

"ascii"

linkDhcpv6Option16

string

0~256个字符。

-

dhcpv6 option16值。linkDhcpv6Option16Type 为ascii时,字符串形式,不支持空格,区分大小写,长度范围是1~250。linkDhcpv6Option16Type为hex时,偶数位长度的十六进制字符串(如hh或hhhh),不支持空格,区分大小写,仅可以配置为包含0~9、A~F和a~f的组合,长度范围是10~256。ipMode为DHCPv6、PD时选填。

"101068,0001"

linkDhcpv6Pd

string

0~63个字符。

-

指定DHCPv6客户端的PD前缀的名称。ipMode为PD时选填。

"sdwanprefix"

enableIPv6AcSouthAccess

boolean

  • true

  • false

true

是否连接IPv6南向地址。

true

ipv6AcSouthAccessId

uuid

0~64个字符。

-

IPv6南向接入服务id,uuid格式。enableIPv6AcSouthAccess为true时,如果不填默认为00000000-0000-0000-0000-000000000003。

"00000000-0000-0000-0000-000000000003"

ipv6MailUsedSouthAccess

boolean

  • true

  • false

false

邮件开局时,邮件url的IPv6南向接入服务。默认为false。多条URL链路选择不同IPv6南向接入服务时,需要指定邮件url的IPv6南向接入服务

false

ipv6AccessPreference

string

0~10个字符。

-

IPv6南向接入优先级,必须要有南向接入服务,取值范围:high、medium、low,high表示高,medium表示中,low表示低。

V600版本的设备,此优先级配置仅对性能通道生效,且V600R022C00及以后的版本支持。V300版本的设备在V300R021C10及以后的版本支持。

"low"

表26 TnpTransportNetworkInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

transportNetworkId

string

-

-

传输网络ID,uuid格式。创建时必填。V300系列设备的V300R023C10或以上版本支持修改该字段。

"00000000-0000-0000-0000-000000000000"

workMode

string

6~7个字符。

active

传输网络对应的角色 active、standby。创建时必填,不区分大小写。

"active"

sendAlarmEnabled

boolean

  • true

  • false

false

standby链路被使用时,是否上报告警。默认值为false。

false

表27 NtpInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

id

uuid

-

-

NTP ID,uuid格式。

"00000000-0000-0000-0000-000000000000"

ntpType

string

4个字符。

IPv4

NTP服务器地址类型,取值范围:IPv4、IPv6。

"IPv6"

preferEn

boolean

  • true

  • false

false

是否指定该远程服务器为优先选择的服务器。

false

serverIP

string

0~39个字符。

-

NTP服务器地址。当ntpType为IPv4,serverIp为IPv4地址,如:192.168.1.1;当ntpType为IPv6,serverIp为IPv6地址,如:fc00:3::1。

"fc00:3::1"

authentication

boolean

  • true

  • false

false

是否认证。

false

mode

string

0~16个字符。

-

认证模式,取值范围:MD5、HMAC-SHA256。当authentication为true时,mode必填。V600版本设备不支持MD5。

"HMAC-SHA256"

authKey

string

6~255个字符。

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

认证密码,当authentication为true时,authKey必填。V300系列设备密码长度必须在6-255位,且必须满足复杂度,即必须包含特殊字符("`!@#$%^&()_+=-[]{},.;)、英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)中的任意两种组合及以上。V600系列设备仅V600R021C00及之后版本设备的密码必须包含12-255个字符,并且必须包含以下内容:大写字母,小写字母,数字和特殊字符("`!@#$%^&()_+=-[]{},.;)。建议密码长度配置在12位以上。

"******"

authId

int64

-

-

认证ID。取值范围:1-4294967295,其中V600版本设备在配置IPv6服务器时最大值为65535。当authentication为true时,authId必填。

10

表28 AttributesInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

inputBandwidth

int32

-

-

下行容量(Kbps),取值范围:10-40000000。创建时必填,不同设备款型和接口类型有所差异,具体以设备为准。

如果未配置Overlay Inbound方向的流量分配或Overlay Inbound方向的QoS,则下行容量限速不生效。

1000

outputBandwidth

int32

-

-

上行容量(Kbps),取值范围:10-40000000。接口类型为Loopback时不支持,其余接口类型创建时必填,不同设备款型和接口类型有所差异,具体以设备为准。

如果未配置Overlay Outbound方向的流量分配或Overlay Outbound方向的QoS,则上行容量限速不生效。

1000

mtu

int32

-

1500

MTU,取值范围:46-9550,默认1500。

1500

TCPmss

int32

-

1200

TCP MSS。V300版本设备取值范围:230-2048,V600版本设备取值范围:128-9500,默认1200,建议MSS的值≤MTU的值-40。FW网关设备不支持。

1200

ipv6Mtu

int64

-

1500

MTU,取值范围:1280-9550,默认1500。

FW网关设备不支持。

1500

表29 SecondSouthAccess对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

acSouthAccessId

string

0~36个字符。

-

南向接入服务id,uuid格式。enableSecondSouthAccess为true时填写。不能与acSouthAccessId相同。

"00000000-0000-0000-0000-000000000002"

accessPreference

string

0~10个字符。

-

南向接入优先级,必须要有南向接入服务,取值范围:high、medium、low,high表示高,medium表示中,low表示低。

"low"

表30 FailTnpInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

-

-

错误码。

"error"

errmsg

string

-

-

错误信息。

"error message"

data

REFERENCE

详细请参见表18

TNP配置信息

-

返回状态码为400:校验异常。

详细信息请参见实际响应消息体。

返回状态码为500:内部错误。

详细信息请参见实际响应消息体。

响应示例

返回状态码为201:创建TNP成功,响应体参考TnpResponse。

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" : "00000000-0000-0000-0000-000000000000",
			"name" : "Link1",
			"siteId" : "00000000-0000-0000-0000-000000000000",
			"deviceId" : "00000000-0000-0000-0000-000000000000",
			"portId" : "00000000-0000-0000-0000-000000000000",
			"portType" : 1,
			"portNum" : "0/0/1",
			"enable5G" : "",
			"inSubInterface" : false,
			"vlanId" : 1,
			"subInterfaceNumber" : 1,
			"tnplinkInfo" : {
				"cellular" : {
					"apn" : "abc",
					"userName" : "user1",
					"userKey" : "******",
					"authType" : 0,
					"priority" : 100,
					"trackEnable" : false,
					"nqaInfo" : {
						"destAddress" : "192.168.1.1"
					}
				},
				"standbyCellularEnable" : false,
				"standbyCellular" : {
					"apn" : "abc",
					"userName" : "user1",
					"userKey" : "******",
					"authType" : 0,
					"priority" : 100,
					"trackEnable" : false,
					"nqaInfo" : {
						"destAddress" : "192.168.1.1"
					}
				},
				"simSwitchBackEnable" : false,
				"simSwitchBackTime" : 60,
				"atm" : {
					"pvcVpi" : 123,
					"pvcVci" : 123
				}
			},
			"ipConnection" : {
				"ipv4" : {
					"publicIP" : "192.168.1.1",
					"accessType" : "PPPoE",
					"ipMode" : "Static",
					"customerAddress" : "192.168.1.1",
					"prefixLength" : 24,
					"providerAddress" : "192.168.1.1",
					"peerIp" : "192.168.1.1",
					"userName" : "admin",
					"userKey" : "******",
					"authType" : 0,
					"dlci" : 55,
					"interfaceMode" : 0
				},
				"ipv6" : {
					"accessType" : "IPoE",
					"ipMode" : "Static",
					"customerIPv6Address" : "fc00:3::1",
					"ipv6PrefixLength" : 64,
					"providerIpv6Address" : "fc00:3::1",
					"linkIpv6Pd" : "sdwanprefix",
					"linkIpv6PdAddr" : "fc00:3::1/64",
					"linkDhcpv6Option16Type" : "ascii",
					"linkDhcpv6Option16" : "101068,0001",
					"linkDhcpv6Pd" : "sdwanprefix",
					"enableIPv6AcSouthAccess" : true,
					"ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003",
					"ipv6MailUsedSouthAccess" : false,
					"ipv6AccessPreference" : "low"
				}
			},
			"transportNetworkInfo" : {
				"transportNetworkId" : "00000000-0000-0000-0000-000000000000",
				"workMode" : "active",
				"sendAlarmEnabled" : false
			},
			"ntp" : [
				{
					"id" : "00000000-0000-0000-0000-000000000000",
					"ntpType" : "IPv6",
					"preferEn" : false,
					"serverIP" : "fc00:3::1",
					"authentication" : false,
					"mode" : "HMAC-SHA256",
					"authKey" : "******",
					"authId" : 10
				}
			],
			"attributes" : {
				"inputBandwidth" : 1000,
				"outputBandwidth" : 1000,
				"mtu" : 1500,
				"TCPmss" : 1200,
				"ipv6Mtu" : 1500
			},
			"description" : "site tnp",
			"natEnable" : false,
			"ztpMode" : 0,
			"ipv6ZtpMode" : 0,
			"underlayVrf" : "underlay_1",
			"routingDistinguisher" : "1111:1111",
			"clearDeviceConfig" : true,
			"enableOverlay" : true,
			"enableIpv6Overlay" : false,
			"acSouthAccessId" : "00000000-0000-0000-0000-000000000001",
			"mailUsedSouthAccess" : false,
			"linkInformation" : "link1",
			"accessPreference" : "low",
			"enableSecondSouthAccess" : false,
			"secondSouthAccess" : {
				"acSouthAccessId" : "00000000-0000-0000-0000-000000000002",
				"accessPreference" : "low"
			},
			"syncModifyDeviceUrlConfig" : false,
			"enableLoopbackSrcInterface" : false,
			"enableRu" : false,
			"disableDefaultRuRoute" : false
		}
	],
	"fail" : [
		{
			"errcode" : "error",
			"errmsg" : "error message",
			"data" : {
				"id" : "00000000-0000-0000-0000-000000000000",
				"name" : "Link1",
				"siteId" : "00000000-0000-0000-0000-000000000000",
				"deviceId" : "00000000-0000-0000-0000-000000000000",
				"portId" : "00000000-0000-0000-0000-000000000000",
				"portType" : 1,
				"portNum" : "0/0/1",
				"enable5G" : "",
				"inSubInterface" : false,
				"vlanId" : 1,
				"subInterfaceNumber" : 1,
				"tnplinkInfo" : {
					"cellular" : {
						"apn" : "abc",
						"userName" : "user1",
						"userKey" : "******",
						"authType" : 0,
						"priority" : 100,
						"trackEnable" : false,
						"nqaInfo" : {
							"destAddress" : "192.168.1.1"
						}
					},
					"standbyCellularEnable" : false,
					"standbyCellular" : {
						"apn" : "abc",
						"userName" : "user1",
						"userKey" : "******",
						"authType" : 0,
						"priority" : 100,
						"trackEnable" : false,
						"nqaInfo" : {
							"destAddress" : "192.168.1.1"
						}
					},
					"simSwitchBackEnable" : false,
					"simSwitchBackTime" : 60,
					"atm" : {
						"pvcVpi" : 123,
						"pvcVci" : 123
					}
				},
				"ipConnection" : {
					"ipv4" : {
						"publicIP" : "192.168.1.1",
						"accessType" : "PPPoE",
						"ipMode" : "Static",
						"customerAddress" : "192.168.1.1",
						"prefixLength" : 24,
						"providerAddress" : "192.168.1.1",
						"peerIp" : "192.168.1.1",
						"userName" : "admin",
						"userKey" : "******",
						"authType" : 0,
						"dlci" : 55,
						"interfaceMode" : 0
					},
					"ipv6" : {
						"accessType" : "IPoE",
						"ipMode" : "Static",
						"customerIPv6Address" : "fc00:3::1",
						"ipv6PrefixLength" : 64,
						"providerIpv6Address" : "fc00:3::1",
						"linkIpv6Pd" : "sdwanprefix",
						"linkIpv6PdAddr" : "fc00:3::1/64",
						"linkDhcpv6Option16Type" : "ascii",
						"linkDhcpv6Option16" : "101068,0001",
						"linkDhcpv6Pd" : "sdwanprefix",
						"enableIPv6AcSouthAccess" : true,
						"ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003",
						"ipv6MailUsedSouthAccess" : false,
						"ipv6AccessPreference" : "low"
					}
				},
				"transportNetworkInfo" : {
					"transportNetworkId" : "00000000-0000-0000-0000-000000000000",
					"workMode" : "active",
					"sendAlarmEnabled" : false
				},
				"ntp" : [
					{
						"id" : "00000000-0000-0000-0000-000000000000",
						"ntpType" : "IPv6",
						"preferEn" : false,
						"serverIP" : "fc00:3::1",
						"authentication" : false,
						"mode" : "HMAC-SHA256",
						"authKey" : "******",
						"authId" : 10
					}
				],
				"attributes" : {
					"inputBandwidth" : 1000,
					"outputBandwidth" : 1000,
					"mtu" : 1500,
					"TCPmss" : 1200,
					"ipv6Mtu" : 1500
				},
				"description" : "site tnp",
				"natEnable" : false,
				"ztpMode" : 0,
				"ipv6ZtpMode" : 0,
				"underlayVrf" : "underlay_1",
				"routingDistinguisher" : "1111:1111",
				"clearDeviceConfig" : true,
				"enableOverlay" : true,
				"enableIpv6Overlay" : false,
				"acSouthAccessId" : "00000000-0000-0000-0000-000000000001",
				"mailUsedSouthAccess" : false,
				"linkInformation" : "link1",
				"accessPreference" : "low",
				"enableSecondSouthAccess" : false,
				"secondSouthAccess" : {
					"acSouthAccessId" : "00000000-0000-0000-0000-000000000002",
					"accessPreference" : "low"
				},
				"syncModifyDeviceUrlConfig" : false,
				"enableLoopbackSrcInterface" : false,
				"enableRu" : false,
				"disableDefaultRuRoute" : false
			}
		}
	]
}

返回状态码为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

标记内容

同时提交标记内容