华为云用户手册

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/performance/spr-statistics/query-metrics-detailed 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "metrics" : "pkgLoss", "metricDistbt" : ["0-1","1-5","5-10","10-100"], "startTime" : 1616824800000, "endTime" : 1616828400000 }

响应示例 返回状态码为200：查询成功，响应体参考StatisticsRsp。 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" : "", "total" : 10, "data" : [ { "key" : "link1", "value" : "35" } ] } 返回状态码为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/authconfigservice/accessconfig/fbb684c8-0d37-496f-bafa-4b06d5151e2e/ppsk/PPSK001 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 { "psk" : "pskofPPSK001", "vlan" : 100, "description" : "", "accDevNum" : 0, "macAddress" : "XX-XX-XX-XX-XX-XX", "ssidName" : "Huawei-Guest" }

响应示例 返回状态码为200：修改PPSK帐号成功，返回创建的帐号信息，响应体参考PpskPostOrPutResponseDto。 HTTP/1.1 200 OK Date: Tue,16 Aug 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : { "psk" : null, "vlan" : 100, "accDevNum" : 0, "macAddress" : "XX-XX-XX-XX-XX-XX", "ssidName" : "Huawei-Guest", "account" : "PPSK001", "id" : "00000000-0000-0000-0000-000000000000", "modifyTime" : 1534848006000, "ppskInfoList": null } } 返回状态码为400：校验异常，响应体参考BaseResponseDto。 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 { "errcode" : "0", "errmsg" : "" }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 PPSK帐号信息参数体。 - 表3 PPSKPutRequestDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 psk 是 password 8~63个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 接入密钥。创建、修改和查询账号时psk返回值为空。 "pskofPPSK001" vlan 否 integer [0-4094] - 绑定VLAN，值为0表示不绑定VLAN。 100 description 否 string 0~255个字符。 - 描述。 - accDevNum 否 integer [0-250] - 接入终端数，值为0表示不限制接入终端数，当macAddress参数非空时，接入终端数固定为1。 0 macAddress 否 string - - 帐号绑定的MAC地址，大小写不敏感，MAC地址支持三种格式：XX:XX:XX:XX:XX:XX/XX-XX-XX-XX-XX-XX/XXXX-XXXX-XXXX。创建和修改账号时该返回值为空。 "XX-XX-XX-XX-XX-XX" ssidName 是 string 1~32个字符。 - SSID名称。 "Huawei-Guest"

URI /controller/campus/v1/authconfigservice/accessconfig/{siteId}/ppsk/{account} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" account 是 string 1~64个字符。 - PPSK帐号名称。 "PPSK001"

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

响应示例 返回状态码为200：批量删除交换机端口配置成功，返回结构体参见ResetPortsConfigResponseDto。 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" : [ "" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "interfaceName" : "GigabitEthernet0/0/1" } ] } 返回状态码为207：批量删除交换机端口配置部分成功，返回结构体参见ResetPortsConfigResponseDto。 HTTP/1.1 207 Multi-Status 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" : [ "" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "interfaceName" : "GigabitEthernet0/0/1" } ] } 返回状态码为400：批量删除交换机端口配置失败，返回结构体参见ResetPortsConfigResponseDto。 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 { "errcode" : "0", "errmsg" : "", "success" : [ "" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "interfaceName" : "GigabitEthernet0/0/1" } ] } 返回状态码为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/v1/networkservice/networkconfig/net/lswport/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/ports/action/batch-delete 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 { "interfaceNames" : ["GigabitEthernet0/0/1","GigabitEthernet0/0/2"] }

URI /v1/networkservice/hierarchy-template/template-groups/tasks/{taskId}/template-bindings 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 taskId 是 string 36个字符。 - 绑定部署任务ID，UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-2000] 1 页码。 1 pageSize 否 int32 [1-100] 20 每页数量。 20 bindingName 否 string 0~128个字符。 - 绑定名称。 "binding1" templateName 否 string 0~128个字符。 - 模板名称。 "template1" templateBindingStatus 否 string 22~32个字符。 - 部署状态。 last-template-partly-deployed：未全部部署， last-template-deployed：全部部署。 "last-template-partly-deployed"

请求示例 HTTP的示例 GET /v1/networkservice/hierarchy-template/template-groups/tasks/00000000-0000-0000-0000-000000000000/template-bindings?pageIndex=1&pageSize=20&bindingName=binding1&templateName=template1&templateBindingStatus=last-template-partly-deployed 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：操作成功。 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 { "totalRecords" : 100, "progress" : 0.9, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "TemplateBinding1", "templateId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1713880927744", "description" : "this is TemplateBinding1", "totalDeviceNum" : 100, "deployedLastestSuccessDeviceCount" : 100, "templateBindingStatus" : "last-template-partly-deployed", "deployLastVersion" : true, "templateName" : "this is template1", "devices" : { "totalRecords" : 100, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "device1", "ip" : "127.0.0.1", "siteName" : "site1", "deployStatus" : "deployment-successed", "deployTime" : "1713880927744", "deployLastVersion" : true, "deployErrorMsg" : {"errorCode":"0x00c8000c","errorType":"APPLICATION","message":"The request failed because the mandatory node is empty"} } ] } } ] } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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/policy/traffic/woc/policy 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-500] 1 分页索引。 1 pageSize 否 int32 [0-100] 10 分页大小。 10 vpnId 否 string 0~64个字符。 - VPN业务ID。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 策略名称。 "WocPolicy" sort 否 string 0~255个字符。 - 排序字段。 "policyName" siteId 否 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" policyId 否 string 0~64个字符。 - 策略ID。 "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/woc/policy?pageIndex=1&pageSize=10&vpnId=00000000-0000-0000-0000-000000000000&policyName=WocPolicy&sort=policyName&siteId=00000000-0000-0000-0000-000000000000&policyId=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：查询成功，返回体参考QueryWocResponse。 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" : "500", "errmsg" : "error", "pageSize" : 10, "pageIndex" : 1, "totalRecords" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "WocPolicy", "priority" : 1, "vpnId" : "00000000-0000-0000-0000-000000000000", "optimizationType" : "FEC", "isActive" : true, "status" : 10, "fecData" : { "antiLossType" : "A-FEC", "lossRate" : 1, "blockSize" : 40, "timeout" : 40, "mtu" : 400, "continuousLoss" : 10 }, "compressionData" : { "compressionType" : "LZ4" }, "classifytemplate" : { "id" : "00000000-0000-0000-0000-000000000000", "templateName" : "template" }, "timeTemplate" : { "id" : "00000000-0000-0000-0000-000000000000", "templateName" : "timeTemplate" } } ] } 返回状态码为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

响应参数 返回状态码为200：查询成功，返回体参考QueryWocResponse。 表2 QueryWocResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~32个字符。 - 错误码。 "500" errmsg string 0~512个字符。 - 错误信息。 "error" pageSize int32 [0-100] - 每页显示数量。 10 pageIndex int32 [0-500] - 当前页数。 1 totalRecords int32 [0-500] - 数据总数。 1 data ARRAY_REFERENCE 详细请参见表9。 策略列表。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-direct-route-vlink:vlink-if 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-direct-route-vlink:vlink-if" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "if-name" : "GE0/0/3", "vlink-route" : [ { "address-family" : "ipv4uni" } ], "vlink-configuration" : { "preference" : 233 } } ] }

响应示例 返回状态码为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 返回状态码为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 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-direct-route-vlink:vlink-if 是 REFERENCE 详细请参见表4。 ARP Vlink直连路由。 - 表4 nes-ne-vlink-if-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-direct-route-vlink:vlink-if 否 ARRAY_REFERENCE 详细请参见表5。 ARP Vlink直连路由。 - 表5 nes-ne-vlink-if对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态，对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态；不支持编辑，仅查询返回。 "configured-database-success" last-committed-time 否 string 0~255个字符。 - 最后提交时间，该特性最后提交时间；不支持编辑，仅查询返回。 "2022-01-01 00:00:00" related-pkg-version 否 string 0~255个字符。 - 包版本，插件包版本；不支持编辑，仅查询返回。 "1.0.1" edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态，对应运行状态、候选状态、取消部署状态、未部署状态；不支持编辑，仅查询返回。 "RUNNING" if-name 否 string 1~63个字符。 - interface name "GE0/0/3" vlink-route 否 ARRAY_REFERENCE 详细请参见表6。 发布ARP Vlink直连路由。 - vlink-configuration 否 REFERENCE 详细请参见表7。 Vlink配置。 - 表6 nes-ne-vlink-if-vlink-route对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address-family 否 string ipv4uni ipv6uni - 地址族类型，单一主键字段。 "ipv4uni" 表7 vlink-configuration对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 preference 否 int32 [0-255] - 优先级。 233

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-direct-route-vlink:vlink-if 表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"

响应示例 返回状态码为200：创建成功，响应体参考NatResponse。 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" : { "dynamicNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "natMode" : "EASY_IP", "startAddress" : "192.168.1.1", "endAddress" : "192.168.1.2", "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ], "staticNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "isUserDefined" : true, "externalIp" : "10.2.0.1", "internalIp" : "10.1.0.1", "translationType" : 1, "protocol" : "1", "externalPort" : 90, "internalPort" : 90, "addressMask" : 30, "advanceSetEnable" : false, "direction" : 1, "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ] } }

响应参数 返回状态码为200：创建成功，响应体参考NatResponse。 表4 NatResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~512个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 详细的返回信息。 - 表5 DetailNatResponseInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dynamicNatInfo ARRAY_REFERENCE 0-1024个列表项，详细请参见表6。 动态NAT的详细返回信息。 - staticNatInfo ARRAY_REFERENCE 0-1024个列表项，详细请参见表8。 静态NAT的详细返回信息。 - 表6 DynamicNatDetailModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 policyId string 0~64个字符。 - 策略ID，创建时不需要填写。 "00000000-0000-0000-0000-000000000000" isOverlay boolean true false - 是否Overlay NAT。 true：Overlay NAT； false，Underlay NAT。 true vpnId string 0~64个字符。 - VPN业务ID。 Overlay NAT，填写WAN虚拟网络ID； Underlay NAT，填写“UnderlayId”。 "00000000-0000-0000-0000-000000000000" siteId string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId string 0~64个字符。 - 部署动态NAT策略的CPE设备的ID。 "00000000-0000-0000-0000-000000000000" policyName string 0~64个字符。 - 策略名称，创建时必填。 "policyName" linkId string 0~64个字符。 - 使能NAT策略的接口ID。 Overlay NAT，填写LAN侧接口ip-subnet ID，如果在所有的Tunnel口上做NAT转换，填写"Overlay Tunnel"。 Underlay NAT，填写设备WAN链路的tnpId。 "00000000-0000-0000-0000-000000000000" interfaceName string 0~64个字符。 - 接口名称，创建修改不需要填写，查询返回。 "GE0/0/8" natMode string EASY_IP PAT NO_PAT - NAT模式，该字段可以设置为以下几种： a) EASY_IP：使用接口的地址作为NAT转换后的地址； b) PAT：支持端口转换，地址转换为多对一； c) NO_PAT：不支持端口转换，进行一对一的地址转换。 "EASY_IP" startAddress string 0~20个字符。 - 开始地址，NAT转换后的IP的范围，仅当NAT模式选择PAT或者No-PAT时，才可配置。 约束： a) 结束IP必须大于或等于起始IP； b) 地址范围不能超过255； c) 同一接口下，不同NAT策略的IP段不能重叠。 "192.168.1.1" endAddress string 0~20个字符。 - 结束地址，约束同开始地址。 "192.168.1.2" natRuleInfos ARRAY_REFERENCE 0-100个列表项，详细请参见表7。 规则信息。 - 表7 NatRuleModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ruleId string 0~64个字符。 - 规则id，创建时不填写。 "00000000-0000-0000-0000-000000000000" priority int32 [1-100] - 优先级，范围：1（高）-100（低）。 1 action string permit deny - 动作，该字段可以设置为以下几种： a) permit：允许 b) deny：拒绝 "permit" protocol int32 [0-255] - ACL规则匹配报文的协议类型。 常用协议类型：0：IP；1：ICMP；2：IGMP；4：IPinIP；6：TCP；17：UDP；47：GRE；89：OSPF。 6 sourceIp string 0~20个字符。 - ACL规则匹配报文的源IP网段。 "10.1.0.1/16" destinationIp string 0~20个字符。 - ACL规则匹配报文的目的IP网段。 "10.2.0.1/16" sourcePort int32 [0-65535] - ACL规则匹配报文的源端口。 仅当协议选择为TCP或者UDP时，才可配置。 1 destinationPort int32 [0-65535] - ACL规则匹配报文的目的IP端口。 仅当协议选择为TCP或者UDP时，才可配置。 1 表8 StaticNatDetailModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 policyId string 0~64个字符。 - 策略id。 创建时不需要填写。 "00000000-0000-0000-0000-000000000000" isOverlay boolean true false - 是否Overlay NAT。 true：Overlay NAT； false，Underlay NAT。 true vpnId string 0~64个字符。 - VPN业务ID。 Overlay NAT，填写WAN虚拟网络ID； Underlay NAT，填写“UnderlayId”。 "00000000-0000-0000-0000-000000000000" siteId string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId string 0~64个字符。 - 部署静态NAT策略的CPE设备的ID。 "00000000-0000-0000-0000-000000000000" policyName string 0~64个字符。 - 静态NAT策略的名称，创建时必填。 "policyName" linkId string 0~64个字符。 - 使能NAT策略的接口ID。 Overlay NAT，填写LAN侧接口ip-subnet ID，如果在所有的Tunnel口上做NAT转换，填写"Overlay Tunnel"。 Underlay NAT，填写设备WAN链路的tnpId。 "00000000-0000-0000-0000-000000000000" interfaceName string 0~64个字符。 - 接口名称，创建修改不需要填写，查询返回。 "GE0/0/8" isUserDefined boolean true false - 是否用户自定义外部IP。 true，用户自定义； false，使用当前接口IP。 true externalIp string 0~20个字符。 - 外部IP，NAT转换后的IP，一般是公网IP。 "10.2.0.1" internalIp string 0~20个字符。 - 内部IP，NAT转换前的IP，一般是私网IP。 "10.1.0.1" translationType int32 [0-1] - 转换类型，该字段可以设置为以下几种： a) 0：地址转换 b) 1：协议转换 当isUserDefined为false时，只能填写1。 1 protocol string 0~10个字符。 - 协议，该字段可以设置为以下几种： a) 0：TCP b) 1：UDP c) 2：ICMP "1" externalPort int32 [0-65535] - 外部端口，NAT转换后的端口号。 90 internalPort int32 [0-65535] - 内部端口，NAT转换前的端口号。 90 addressMask int32 [24-32] - addressMask，用户自定义时填写，范围24-32。 30 advanceSetEnable boolean true false - 高级设置开关。 true:开启，方向和匹配规则设置生效； false：关闭。 false direction int32 [0-2] - 方向，该字段可以设置为以下几种： a) 0：双向 b) 1：外部访问内部 c) 2：内部访问外部 1 natRuleInfos ARRAY_REFERENCE 0-100个列表项，详细请参见表7。 规则信息。 -

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/nat/dynamicnat 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 { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "natMode" : "EASY_IP", "startAddress" : "192.168.1.1", "endAddress" : "192.168.1.2", "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 动态NAT策略信息。 - 表2 DynamicNatDetailModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyId 否 string 0~64个字符。 - 策略ID，创建时不需要填写。 "00000000-0000-0000-0000-000000000000" isOverlay 是 boolean true false - 是否Overlay NAT。 true：Overlay NAT； false，Underlay NAT。 true vpnId 是 string 0~64个字符。 - VPN业务ID。 Overlay NAT，填写WAN虚拟网络ID； Underlay NAT，填写“UnderlayId”。 "00000000-0000-0000-0000-000000000000" siteId 是 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 string 0~64个字符。 - 部署动态NAT策略的CPE设备的ID。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 策略名称，创建时必填。 "policyName" linkId 是 string 0~64个字符。 - 使能NAT策略的接口ID。 Overlay NAT，填写LAN侧接口ip-subnet ID，如果在所有的Tunnel口上做NAT转换，填写"Overlay Tunnel"。 Underlay NAT，填写设备WAN链路的tnpId。 "00000000-0000-0000-0000-000000000000" interfaceName 否 string 0~64个字符。 - 接口名称，创建修改不需要填写，查询返回。 "GE0/0/8" natMode 是 string EASY_IP PAT NO_PAT - NAT模式，该字段可以设置为以下几种： a) EASY_IP：使用接口的地址作为NAT转换后的地址； b) PAT：支持端口转换，地址转换为多对一； c) NO_PAT：不支持端口转换，进行一对一的地址转换。 "EASY_IP" startAddress 否 string 0~20个字符。 - 开始地址，NAT转换后的IP的范围，仅当NAT模式选择PAT或者No-PAT时，才可配置。 约束： a) 结束IP必须大于或等于起始IP； b) 地址范围不能超过255； c) 同一接口下，不同NAT策略的IP段不能重叠。 "192.168.1.1" endAddress 否 string 0~20个字符。 - 结束地址，约束同开始地址。 "192.168.1.2" natRuleInfos 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 规则信息。 - 表3 NatRuleModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ruleId 否 string 0~64个字符。 - 规则id，创建时不填写。 "00000000-0000-0000-0000-000000000000" priority 是 int32 [1-100] - 优先级，范围：1（高）-100（低）。 1 action 是 string permit deny - 动作，该字段可以设置为以下几种： a) permit：允许 b) deny：拒绝 "permit" protocol 是 int32 [0-255] - ACL规则匹配报文的协议类型。 常用协议类型：0：IP；1：ICMP；2：IGMP；4：IPinIP；6：TCP；17：UDP；47：GRE；89：OSPF。 6 sourceIp 否 string 0~20个字符。 - ACL规则匹配报文的源IP网段。 "10.1.0.1/16" destinationIp 否 string 0~20个字符。 - ACL规则匹配报文的目的IP网段。 "10.2.0.1/16" sourcePort 否 int32 [0-65535] - ACL规则匹配报文的源端口。 仅当协议选择为TCP或者UDP时，才可配置。 1 destinationPort 否 int32 [0-65535] - ACL规则匹配报文的目的IP端口。 仅当协议选择为TCP或者UDP时，才可配置。 1

响应示例 返回状态码为201：接口调用成功，响应体参考IPv6OspfRouteResponse。 HTTP/1.1 201 Created 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "routerId" : "192.168.1.1", "processId" : 501, "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "DIRECT", "processId" : 501, "cost" : 1 } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "importRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "configSource" : "Wan" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "routerId" : "192.168.1.1", "processId" : 501, "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "DIRECT", "processId" : 501, "cost" : 1 } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "importRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "configSource" : "Wan" } } ] } 返回状态码为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

响应参数 返回状态码为201：接口调用成功，响应体参考IPv6OspfRouteResponse。 表13 IPv6OspfRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-8个列表项，详细请参见表14。 创建或者更新成功的IPv6 OSPF路由信息。 - fail ARRAY_REFERENCE 0-8个列表项，详细请参见表24。 创建或者更新失败的IPv6 OSPF路由信息。 - 表14 IPv6OspfRouteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 对应站点ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId uuid - - 设备ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId uuid - - 所在VPN ID。格式是uuid，创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId uuid - - 所在TNP ID。格式是uuid，创建underlay ospf路由时必填。当前不支持。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" routerId string - - 用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。 "192.168.1.1" processId int32 [1-65535] - 进程号。创建时必填。EVPN隧道模式下，Underlay场景，当前不支持；Overlay场景，取值范围：1-20000。 501 defaultRouteAdvertisement boolean true false false 是否开启通告默认路由。创建时必填。 false defaultRouteCost int32 [1-16777214] 1 默认路由开销。开启通告默认路由时必填。 1 internalPreference int32 [1-255] 10 内部优先级。创建时必填。 10 asePreference int32 [1-255] 150 ASE优先级。创建时必填。 150 routeRedistribute ARRAY_REFERENCE 0-64个列表项，详细请参见表15。 路由引入。 - exportRoutePolicy REFERENCE 详细请参见表16。 IPV6发布路由策略。 - importRoutePolicy REFERENCE 详细请参见表16。 IPV6接收路由策略。 - ipSubnets ARRAY_REFERENCE 0-64个列表项，详细请参见表23。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts ARRAY_REFERENCE 0-64个列表项，详细请参见表23。 TNP接口参数。创建underlay ospf时必填。当前不支持。 - configSource string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan" 表15 IPv6RouteRedistributeInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 type string 0~16个字符。 - 取值范围：OSPFv3、DIRECT、STATIC、BGP。 "DIRECT" processId int32 [1-65535] - 引用的OSPFv3进程号，引入路由类型为OSPFv3时必填。EVPN隧道模式下，Underlay场景，当前不支持；Overlay场景，取值范围：1-20000。 501 cost int32 [1-16777214] 1 开销。 1 表16 IPv6OspfRoutePolicy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nodes ARRAY_REFERENCE 0-100个列表项，详细请参见表17。 export方向permit节点支持多个，import方向最多只有一个。更新ospf时，如果node长度为0，则代表删除对应的路由策略。 - 表17 IPv6OspfPolicyNode对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mode string 0~16个字符。 - 节点匹配模式，取值为permit或deny。 "permit" matchCondition REFERENCE 详细请参见表18。 路由策略匹配条件，至少填写一个匹配条件。 - applyAction REFERENCE 详细请参见表21。 路由策略应用的行为。 - 表18 IPv6OspfPolicyNodeMatchCondition对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipPrefix REFERENCE 详细请参见表19。 IP前缀。 - tag int64 [0-4294967295] - 指定路由信息标记值。 100 表19 IPv6OspfIpPrefixList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 prefixFilters ARRAY_REFERENCE 0-100个列表项，详细请参见表20。 前缀过滤器。 - 表20 IPv6OspfPrefixFilter对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipv6Address string - - IP地址。必填。 "FC00:3::1" maskLength int8 [0-128] - 掩码。必填。 24 greaterEqual int8 [0-128] - 掩码范围下限。 24 lessEqual int8 [0-128] - 掩码范围上限。 24 表21 IPv6OspfPolicyNodeApplyAction对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 applyMetric REFERENCE 详细请参见表22。 路由策略应用Metric值。 - localPreference int64 [0-4294967295] - 本地优先级。 100 preferredValue int64 [0-65535] - 首选值。 100 applyTag int64 [0-4294967295] - 指定路由信息标记值。 100 表22 IPv6OspfApplyMetric对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 cost string - - 路由开销值，取值范围0-4294967295。只在underlay ospf发布策略的白名单生效。 "24" sign string - - add表示增加开销值，sub表示减小开销值。该字段暂未实现。 "add" 表23 IPv6InterfaceParameterInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceType string 0~64个字符。 - 接口类型，非必填，默认IPSUBNET口 "tunnel" interfaceId uuid - - IP Subnet ID。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" areaId string - - 区域ID，取值范围0-4294967295。 "0" areaType string 0~10个字符。 - 区域类型。取值：normal（缺省情况下，OSPF区域被定义为普通区域）、stub（不允许发布自治系统外部路由，只允许发布区域内路由和区域间的路由）、nssa（NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中）。 "normal" authMode string 0~16个字符。 none 认证方式。取值：none、cryptographic。 "none" cryptographicSuit string 0~16个字符。 hmac-sha256 加密算法。取值：hmac-sha256。认证方式为cryptographic时必填。 "hmac-sha256" key int32 [1-255] 1 key。认证方式为cryptographic时必填。 1 cryptographicPwd string 1~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 密码必须包含如下规则：密码长度必须在1～255位。密码只支持特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）和数字（0~9）。为提高安全性，建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种，同时密码长度不小于6个字符。 "1" helloTimer int32 [1-65535] 10 Hello报文时间间隔。建议Hello报文时间间隔取值不小于5，否则可能会造成邻接关系的中断。缺省情况下，P2P、Broadcast类型接口发送Hello报文的时间间隔的值为10秒；P2MP、NBMA类型接口发送Hello报文的时间间隔的值为30秒。 1 timerDead int32 [1-65535] - OSPFv3的邻居失效时间，必须大于Hello报文的时间间隔。 1 networkType string 0~16个字符。 - 网络类型。取值：broadcast（将接口的网络类型更改为广播）、nbma（将接口的网络类型更改为NBMA）、p2mp（将接口的网络类型更改为点到多点）、p2p（将接口的网络类型更改为点到点）。 "broadcast" cost int32 [1-65535] - 开销。 1 drPriority int32 [0-255] 1 DR优先级。 1 表24 FailIPv6OspfRouteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表14。 OSPF路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ipv6ospf 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 { "routes" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "routerId" : "192.168.1.1", "processId" : 501, "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "DIRECT", "processId" : 501, "cost" : 1 } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "importRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "configSource" : "Wan" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6OspfRouteInfos 是 REFERENCE 详细请参见表2。 IPv6 OSPF路由信息。 - 表2 IPv6OspfRouteInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 routes 否 ARRAY_REFERENCE 1-8个列表项，详细请参见表3。 IPv6 OSPF路由信息。 - 表3 IPv6OspfRouteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 对应站点ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 是 uuid - - 设备ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - 所在VPN ID。格式是uuid，创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - 所在TNP ID。格式是uuid，创建underlay ospf路由时必填。当前不支持。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" routerId 否 string - - 用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。 "192.168.1.1" processId 是 int32 [1-65535] - 进程号。创建时必填。EVPN隧道模式下，Underlay场景，当前不支持；Overlay场景，取值范围：1-20000。 501 defaultRouteAdvertisement 否 boolean true false false 是否开启通告默认路由。创建时必填。 false defaultRouteCost 否 int32 [1-16777214] 1 默认路由开销。开启通告默认路由时必填。 1 internalPreference 否 int32 [1-255] 10 内部优先级。创建时必填。 10 asePreference 否 int32 [1-255] 150 ASE优先级。创建时必填。 150 routeRedistribute 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表4。 路由引入。 - exportRoutePolicy 否 REFERENCE 详细请参见表5。 IPV6发布路由策略。 - importRoutePolicy 否 REFERENCE 详细请参见表5。 IPV6接收路由策略。 - ipSubnets 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表12。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表12。 TNP接口参数。创建underlay ospf时必填。当前不支持。 - configSource 否 string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan" 表4 IPv6RouteRedistributeInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 type 是 string 0~16个字符。 - 取值范围：OSPFv3、DIRECT、STATIC、BGP。 "DIRECT" processId 否 int32 [1-65535] - 引用的OSPFv3进程号，引入路由类型为OSPFv3时必填。EVPN隧道模式下，Underlay场景，当前不支持；Overlay场景，取值范围：1-20000。 501 cost 否 int32 [1-16777214] 1 开销。 1 表5 IPv6OspfRoutePolicy对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nodes 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 export方向permit节点支持多个，import方向最多只有一个。更新ospf时，如果node长度为0，则代表删除对应的路由策略。 - 表6 IPv6OspfPolicyNode对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 是 string 0~16个字符。 - 节点匹配模式，取值为permit或deny。 "permit" matchCondition 否 REFERENCE 详细请参见表7。 路由策略匹配条件，至少填写一个匹配条件。 - applyAction 否 REFERENCE 详细请参见表10。 路由策略应用的行为。 - 表7 IPv6OspfPolicyNodeMatchCondition对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipPrefix 否 REFERENCE 详细请参见表8。 IP前缀。 - tag 否 int64 [0-4294967295] - 指定路由信息标记值。 100 表8 IPv6OspfIpPrefixList对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 prefixFilters 是 ARRAY_REFERENCE 0-100个列表项，详细请参见表9。 前缀过滤器。 - 表9 IPv6OspfPrefixFilter对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6Address 是 string - - IP地址。必填。 "FC00:3::1" maskLength 是 int8 [0-128] - 掩码。必填。 24 greaterEqual 否 int8 [0-128] - 掩码范围下限。 24 lessEqual 否 int8 [0-128] - 掩码范围上限。 24 表10 IPv6OspfPolicyNodeApplyAction对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 applyMetric 否 REFERENCE 详细请参见表11。 路由策略应用Metric值。 - localPreference 否 int64 [0-4294967295] - 本地优先级。 100 preferredValue 否 int64 [0-65535] - 首选值。 100 applyTag 否 int64 [0-4294967295] - 指定路由信息标记值。 100 表11 IPv6OspfApplyMetric对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 cost 否 string - - 路由开销值，取值范围0-4294967295。只在underlay ospf发布策略的白名单生效。 "24" sign 否 string - - add表示增加开销值，sub表示减小开销值。该字段暂未实现。 "add" 表12 IPv6InterfaceParameterInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceType 否 string 0~64个字符。 - 接口类型，非必填，默认IPSUBNET口 "tunnel" interfaceId 是 uuid - - IP Subnet ID。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" areaId 是 string - - 区域ID，取值范围0-4294967295。 "0" areaType 否 string 0~10个字符。 - 区域类型。取值：normal（缺省情况下，OSPF区域被定义为普通区域）、stub（不允许发布自治系统外部路由，只允许发布区域内路由和区域间的路由）、nssa（NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中）。 "normal" authMode 是 string 0~16个字符。 none 认证方式。取值：none、cryptographic。 "none" cryptographicSuit 否 string 0~16个字符。 hmac-sha256 加密算法。取值：hmac-sha256。认证方式为cryptographic时必填。 "hmac-sha256" key 否 int32 [1-255] 1 key。认证方式为cryptographic时必填。 1 cryptographicPwd 否 string 1~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 密码必须包含如下规则：密码长度必须在1～255位。密码只支持特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）和数字（0~9）。为提高安全性，建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种，同时密码长度不小于6个字符。 "1" helloTimer 是 int32 [1-65535] 10 Hello报文时间间隔。建议Hello报文时间间隔取值不小于5，否则可能会造成邻接关系的中断。缺省情况下，P2P、Broadcast类型接口发送Hello报文的时间间隔的值为10秒；P2MP、NBMA类型接口发送Hello报文的时间间隔的值为30秒。 1 timerDead 否 int32 [1-65535] - OSPFv3的邻居失效时间，必须大于Hello报文的时间间隔。 1 networkType 否 string 0~16个字符。 - 网络类型。取值：broadcast（将接口的网络类型更改为广播）、nbma（将接口的网络类型更改为NBMA）、p2mp（将接口的网络类型更改为点到多点）、p2p（将接口的网络类型更改为点到点）。 "broadcast" cost 否 int32 [1-65535] - 开销。 1 drPriority 是 int32 [0-255] 1 DR优先级。 1

响应示例 返回状态码为200：删除成功，响应体参考NatServerResponse。 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" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "test name", "globalStartAddress" : "192.168.1.1", "globalEndAddress" : "192.168.1.2", "insideStartAddress" : "192.168.1.1", "insideEndAddress" : "192.168.1.2", "globalSourcePort" : "1", "globalEndPort" : "2", "insideSourcePort" : "1", "insideEndPort" : "2", "protocol" : "6", "reverse" : true, "interfaceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "errparam" : "["policyName"]", "data" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "test name", "globalStartAddress" : "192.168.1.1", "globalEndAddress" : "192.168.1.2", "insideStartAddress" : "192.168.1.1", "insideEndAddress" : "192.168.1.2", "globalSourcePort" : "1", "globalEndPort" : "2", "insideSourcePort" : "1", "insideEndPort" : "2", "protocol" : "6", "reverse" : true, "interfaceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0" } } ] } 返回状态码为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/v1/sdwan/policy/traffic/nat/natserver/batch-delete 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 { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "policyIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"] }