华为云用户手册

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 info-center-source 是 REFERENCE 详细请参见表4。 信息通道 - 表4 syslog-config-exactProperties-info-center-source-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:info-center-source 否 ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 信息通道 - 表5 syslog-config-exactProperties-info-center-source-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 module-name 是 string 1~31个字符。满足正则表达[^A-Z]*。 - 模块名称."1-31位小写字母或数字，如a-z或0-9，例如：default,其他特性在设备产品文档"日志参考"中可以查到设备当前支持的所有模块名称，如aaa、am，具体以设备产品文档为准。" "default" channel-id 是 int64 [0-9] - 通道ID 5 enable-log 否 boolean true false - 使能日志 - enable-log-level 否 string emergencies alert critical error warning notification informational debugging - 使能日志级别 - enable-trap 否 boolean true false - 使能Trap - enable-trap-level 否 string emergencies alert critical error warning notification informational debugging - 使能Trap级别 -

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/info-center-source 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 修改交换机防攻击策略配置参数体。 - 表3 DefendPolicyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 whitelist 是 ARRAY_REFERENCE 1个列表项，详细请参见表4。 交换机防攻击策略白名单列表。 - id 是 string 32个字符。 - 防攻击策略id "fbb684c80d37406fbafa4b06d6151e2e"

响应示例 返回状态码为200：修改交换机防攻击策略配置成功，返回交换机防攻击策略配置信息。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "whitelist" : [ { "aclConfigType" : "Custom", "aclProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "customAclRuleList" : [ { "ruleId" : 1, "policy" : "permit", "protocol" : "tcp", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "description" : "Rule1" } ] } ], "id" : "fbb684c80d37406fbafa4b06d6151e2e" } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /controller/campus/api/v1/networkconfig/lswdefendpolicy/devices/{deviceId}/defendpolicy 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

请求示例 HTTP的示例 PUT /controller/campus/api/v1/networkconfig/lswdefendpolicy/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/defendpolicy HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "whitelist" : [ { "aclConfigType" : "Custom", "aclProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "customAclRuleList" : [ { "ruleId" : 1, "policy" : "permit", "protocol" : "tcp", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "description" : "Rule1" } ] } ], "id" : "fbb684c80d37406fbafa4b06d6151e2e" }

响应示例 返回状态码为200：创建Loopback配置成功，响应体参考，返回结构体参见LoopbackResponseDtoLoopbackResponseDto。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "id" : "fbb684c80d37496fbafa4b06d5151e2e", "deviceName" : "device1", "esn" : "1019A063325", "nameAllocMode" : "manual", "loopBackName" : "LoopBack1", "ipAddress" : "192.168.0.1", "mask" : 24, "description" : "description" } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/api/v1/networkconfig/loopback/device/fbb684c8-0d37-496f-bafa-4b06d5151e2e 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 { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "id" : "fbb684c80d37496fbafa4b06d5151e2e", "deviceName" : "device1", "esn" : "1019A063325", "nameAllocMode" : "manual", "loopBackName" : "LoopBack1", "ipAddress" : "192.168.0.1", "mask" : 24, "description" : "description" }

响应参数 返回状态码为200：创建Loopback配置成功，响应体参考，返回结构体参见LoopbackResponseDtoLoopbackResponseDto。 表4 LoopbackResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 描述，一个中文占三个字符，结构体参见LoopbackDto。 - 表5 LoopbackDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" id string 32~36个字符。 - Loopback的id。创建时无需填写自动生成，创建成功后会返回id。修改时该id标识为需要修改的Loopback。 "fbb684c80d37496fbafa4b06d5151e2e" deviceName string 0~64个字符。 - 设备名称。 "device1" esn string 10~40个字符。 - 设备ESN。 "1019A063325" nameAllocMode string auto manual - 名称配置方式。auto表示自动分配，manual表示手动分配。 "manual" loopBackName string 9~10个字符。 - loopback名称，云杉AP最大限制8，其他设备类型15，不允许修改，另当nameAllocMode为auto的时候loopBackName不生效。 "LoopBack1" ipAddress string 0~64个字符。 - ip地址。 "192.168.0.1" mask int32 [1-32] - 掩码。 24 description string 0~242个字符。 - 描述，一个中文占三个字符。 "description" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 创建Loopback配置信息，结构体参见LoopbackDto。 - 表3 LoopbackDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" id 否 string 32~36个字符。 - Loopback的id。创建时无需填写自动生成，创建成功后会返回id。修改时该id标识为需要修改的Loopback。 "fbb684c80d37496fbafa4b06d5151e2e" deviceName 否 string 0~64个字符。 - 设备名称。 "device1" esn 否 string 10~40个字符。 - 设备ESN。 "1019A063325" nameAllocMode 否 string auto manual - 名称配置方式。auto表示自动分配，manual表示手动分配。 "manual" loopBackName 否 string 9~10个字符。 - loopback名称，云杉AP最大限制8，其他设备类型15，不允许修改，另当nameAllocMode为auto的时候loopBackName不生效。 "LoopBack1" ipAddress 否 string 0~64个字符。 - ip地址。 "192.168.0.1" mask 否 int32 [1-32] - 掩码。 24 description 否 string 0~242个字符。 - 描述，一个中文占三个字符。 "description"

请求示例 HTTP的示例 POST /v1/netcfg/sites/dfs-groups/13874933-09ae-cfff-9883-bcaa33422118/m-lags HTTPS 1.1 Host:192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "dfsGroupName": "MLAG01", "mode": "active-active", "peerLink": [ { "deviceId": "cfff4933-39aa-cfaf-9833-bcaa13874933", "deviceName": "device1", "ifName": "Eth-Trunk1", "priority": 150, "peerDeviceId": "09ae4933-196e-cfef-9183-bcaa13874a3c", "peerDeviceName": "device2", "peerIfName": "Eth-Trunk1", "peerPriority": 100 }], "mLagMemberList": [ { "mLagId": "1", "mLagMemberlink": { "deviceId": "cfff4933-39aa-cfaf-9833-bcaa13874933", "deviceName": "device1", "ifName": "Eth-Trunk2", "peerDeviceId": "09ae4933-196e-cfef-9183-bcaa13874a3c", "peerDeviceName": "device2", "peerIfName": "Eth-Trunk2", } }] }

响应示例 返回状态码为204：初始化配置成功 HTTP/1.1 204 No Content Date: Sun,11 May 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,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mlagConfiguration 是 REFERENCE 详细请参见表3。 Dfs-Group、Peer-Link以及成员口相关的配置 - 表3 MlagConfigration对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 dfsGroupName 否 string 0~64个字符。满足正则表达^[a-zA-Z0-9_.@-]+$。 - Dfs-Group组名称。 "dfsGroup1" mode 否 string 0~14个字符。满足正则表达active-standby|active-active。 active-active Dfs-Group组级别的工作模式，可不填，默认双活模式, 可指定主备模式。 "active-active" dualActiveDetectLink 否 REFERENCE 详细请参见表4。 配置双主检测链路。 - peerLink 否 ARRAY_REFERENCE 0-1个列表项，详细请参见表5。 为Dfs-Group指定的Peer-Link链路，仅能指定一条 - mLagMemberList 否 ARRAY_REFERENCE 0-1024个列表项，详细请参见表6。 成员列表。 - 表4 DualActiveDetectLink对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" deviceName 否 string 0~64个字符。 - 本端设备名称。 "fw1" ifName 否 string 0~64个字符。 - 双主检测本端接口名称，物理口，非Eth-Trunk口。 "10GE 1/0/7" peerDeviceId 否 string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45d" peerDeviceName 否 string 0~64个字符。 - 对端设备名称。 "fw2" peerIfName 否 string 0~64个字符。 - 双主检测对端接口名称，物理口，非Eth-Trunk口。 "10GE 1/0/7" ipPoolName 否 string 0~32个字符。 - 为接口分配IP地址的资源池名称。 "CoreIpPool" 表5 MlagLinkDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" deviceName 否 string 0~64个字符。 - 设备名称。 "fw1" ifName 否 string 0~64个字符。 - 设备名称。 "fw1" priority 否 int32 [1-254] 150 本端设备优先级。 100 peerDeviceId 否 string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" peerDeviceName 否 string 0~64个字符。 - 设备名称。 "fw1" peerIfName 否 string 0~64个字符。 - 设备名称。 "fw1" peerPriority 否 int32 [1-254] 100 对端设备优先级。 100 表6 MlagMembersDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mLagId 否 string 0~36个字符。 - M-LAG的组id。 "1" mLagMemberlink 否 REFERENCE 详细请参见表5。 M-LAG的成员链路。 -

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/monitor/netstream/switch?pageIndex=1&pageSize=10 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

响应示例 返回状态码为200：查询成功，响应体参考MonitorCfgResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100, "data" : [ "fbb684c8-0d37-496f-bafa-4b06d515j7l6" ], "fixPacketsNums" : [ 1 ] } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403：接口无权限。 HTTP/1.1 403 Forbidden Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /controller/campus/v1/sdwan/monitor/{metric}/switch 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 metric 是 string 0~64个字符。 - 采集项，该字段可以设置为以下几种： a) netstream：应用流量 b) tcpfpm：应用质量 c) wanlink：WAN链路流量 d) linkqualityEnhance：WAN链路质量增强 e) sourceip：LAN IP采集（源IP） f) wanSourceIp：WAN IP采集（源IP） g) wanDestIp：WAN IP采集（目的IP） h) wanSession：WAN IP采集（会话） i) thirdPartyNetstream：第三方Netstream "netstream" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-10000] - 当前页，从1开始。 1 pageSize 否 int32 [1-10000] - 页大小。 10

响应示例 返回状态码为200：删除成功，响应体参考CommonAaaResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "" } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/aaa/authentication/00000000-0000-0000-0000-000000000000 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

响应参数 返回状态码为200：删除成功，响应体参考CommonAaaResponse。 表2 CommonAaaResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：添加成功返回。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] } } 返回状态码为202：请求正在处理中，请求处理详情请通过查询业务编排结果，确认是否处理成功。响应体参考VnSiteAsyncResponse。 HTTP/1.1 202 Accepted Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] }, "processInstanceId" : "" } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/lanwan/vn/site-attachment 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 { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] }

响应参数 返回状态码为200：添加成功返回。 表4 VnSiteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 VN关联的站点信息。 - 表5 VnSiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vnId string 36个字符。 - VN标识，uuid格式。必填项。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vnName string 0~32个字符。 - VN名称，不需要填充。 "vn1" asyncEnable boolean true false - 是否开启异步下发。 true siteInfos ARRAY_REFERENCE 0-5000个列表项，详细请参见表5。 站点ID列表，单VN最多支持5000站点。每次最多变更100站点，比如修改时需要给VN新增和移除站点，单次操作新增和移除站点的数量之和需要小于100。 - 返回状态码为202：请求正在处理中，请求处理详情请通过查询业务编排结果，确认是否处理成功。响应体参考VnSiteAsyncResponse。 表6 VnSiteAsyncResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 VN关联的站点信息。 - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。在接口返回码为202时设置。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnSiteInfo 是 REFERENCE 详细请参见表2。 VN信息。 - 表2 VnSiteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnId 是 string 36个字符。 - VN标识，uuid格式。必填项。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vnName 否 string 0~32个字符。 - VN名称，不需要填充。 "vn1" asyncEnable 否 boolean true false - 是否开启异步下发。 true siteInfos 否 ARRAY_REFERENCE 0-5000个列表项，详细请参见表3。 站点ID列表，单VN最多支持5000站点。每次最多变更100站点，比如修改时需要给VN新增和移除站点，单次操作新增和移除站点的数量之和需要小于100。 - 表3 SiteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点标识，uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" siteName 否 string 0~64个字符。 - 站点名称，不需要填充。 "site" isWanServiceNeeded 否 boolean true false true 该参数已经废弃，无需设置。 true routeDistinguisher 否 string 0~21个字符。 - 路由标识RD，填写后不支持修改。支持的格式如下：2字节自治系统号:4字节用户自定义数，其中自治系统号的取值范围是0～65535，用户自定义数的取值范围是0～4294967295，例如101:3。自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；整数形式4字节自治系统号:2字节用户自定义数，自治系统号的取值范围是65536～4294967295，用户自定义数的取值范围是0～65535，例如0:3或者65537:3。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；点分形式4字节自治系统号:2字节用户自定义数，点分形式自治系统号通常写成x.y的形式，x和y的取值范围都是0～65535，用户自定义数的取值范围是0～65535，例如0.0:3或者0.1:0。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0.0:0；IPv4地址:2字节用户自定义数，例如：192.168.122.15:1。IP地址的取值范围是0.0.0.0～255.255.255.255；用户自定义数的取值范围是0～65535。不可配置5500:5500因预留给增强模式下的vlanif使用。 "101:3" status 否 string SUCCESS CONFIGURING FAIL - 下发状态，不需要填充。 "SUCCESS" errMsg 否 string 0~256个字符。 - 错误信息，不需要填充。 ""

响应示例 返回状态码为200：更新BGP对等体出参。 HTTP/1.1 200 OK Date: Sun,11 May 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", "peerInfo" : { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 } }, "coreBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "gatewayBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "coreBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ], "gatewayBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ] }, "fail" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreBgpFailInfo" : { "errcode" : "0", "errmsg" : "", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "bgpAs" : 100, "peerIp" : "192.168.10.1" }, "gatewayBgpFailInfo" : { "errcode" : "0", "errmsg" : "", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "bgpAs" : 100, "peerIp" : "192.168.10.1" }, "coreBgpBaseInfos" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "bgpAs" : 100, "peerIp" : "192.168.10.1" } ], "gatewayBgpBaseInfos" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "bgpAs" : 100, "peerIp" : "192.168.10.1" } ] } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/lanwan/interconnection/route/bgp 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", "peerInfo" : { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 } }, "coreBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "gatewayBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "coreBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ], "gatewayBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ] }

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/oamservice/get-vpn-encrypted-status?deviceId=00000000-0000-0000-0000-000000000000&tnpId=00000000-0000-0000-0000-000000000000&vpnId=00000000-0000-0000-0000-000000000000 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

响应参数 返回状态码为200：查询成功，响应体参考GetVpnEncryptedStatusRsp。 表2 GetVpnEncryptedStatusRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-10000个列表项，详细请参见表3。 设备VPN加密状态结构体。 - 表3 VpnEncryptedStatus对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~36个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId string 0~36个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" tnpId string 0~36个字符。 - TNP ID。 "00000000-0000-0000-0000-000000000000" tnpName string 0~36个字符。 - TNP 名称。 "tnpName1" vpnId string 0~36个字符。 - VPN ID。 "00000000-0000-0000-0000-000000000000" vpnName string 0~36个字符。 - VPN 名称。 "vpn1" isEncrypted boolean true false - VPN是否加密，true则表示为加密状态，false则表示为不加密状态。 true 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考GetVpnEncryptedStatusRsp。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "tnpId" : "00000000-0000-0000-0000-000000000000", "tnpName" : "tnpName1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "isEncrypted" : true } ] } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /controller/campus/v1/sdwan/oamservice/get-vpn-encrypted-status 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~36个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" tnpId 否 string 0~36个字符。 - TNP ID。 tnpId和vpnId必须填写一个。 "00000000-0000-0000-0000-000000000000" vpnId 否 string 0~36个字符。 - VPN ID。 tnpId和vpnId必须填写一个。 "00000000-0000-0000-0000-000000000000"

响应参数 返回状态码为200：响应对象，接口返回体参考GetIpListResponseVo。 表4 GetIpListResponseVo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" pageVo REFERENCE 详细请参见表5。 分页的响应数据。 - ipItems ARRAY_REFERENCE 0-65535个列表项，详细请参见表6。 Ip资源详细信息列表。 - 表5 PageVo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [1-1000] - 当前页数。 1 pageSize int32 [1-1000] - 每页显示数量。 20 totalRecords int32 [1-65535] - 总的数据条数。 1 表6 IpItem对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string [1-64] - 站点Id。 "d235353a-1284-4aad-9f35-18af543fcf5b" siteName string [0-64] - 站点名称。 "s74" deviceName string 0~64个字符。 - 设备名称。 "AR8140-74" deviceId string 1~36个字符。 - 设备Id。 "6a650c65-b5d7-482f-811a-18efbbde48b6" linkName string 0~128个字符。 - 链路名称。 "GigabitEthernet0/0/3" vrf string 0~64个字符。 - vrf实例名称。 "underlay_2" vpnName string 0~128个字符。 - VN名称。 "vpn1" ipAddress string 0~128个字符。 - IP地址。 "10.1.1.1" ipv6Address string 0~128个字符。 - IPV6地址。 "10::1" usage string - - 业务类型：| UNDERLAY：UNDERLAY， evpn：EVPN， inter-cpe：内联链路， lan-access：LAN侧接入， inter-loopback：内环隧道， inter-tunnel， system：EVPN管理口， VAS：VAS， iwg：IWG， tunnel-configuration：隧道配置， cloud-security： 云安全 ， management：管理配置， unknown：其他。 "UNDERLAY" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。