华为云用户手册

请求示例 HTTP的示例 PUT /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-AC CES S-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" } ] }

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-if/GE0%2F0%2F2 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"

响应示例 返回状态码为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 { "huawei-nce-e-dhcpv4:dhcpv4-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/2", "dhcp-type" : "server", "encapsulation" : { "suboption" : "circuit-id remote-id subscriber-id vendor-specific-id" }, "option82-formats" : { "option82-format" : [ { "sub-option-type" : "remote-id", "option82-format" : "user-defined", "user-define-text" : "definedtext" } ] }, "option82-insert-setting" : { "insert" : "", "rebuild" : "" }, "dhcp-relay" : { "enable" : true, "information" : true, "information-strategy" : "drop", "option82" : { "link-selection-enable" : false, "link-selection-address" : "10.1.1.4" }, "relay-source-address" : { "source-address" : "10.1.1.1" }, "server-addresses" : [ { "server-address" : "10.1.1.1" } ], "gateway-addresses" : [ { "gateway-address" : "10.1.1.1" } ] }, "dhcp-server" : { "gateway-list" : [ { "gateway-ip" : "10.1.1.1", "mask" : 16 } ], "dns-list" : [ { "dns-ip" : "10.1.1.1" } ], "excluded-ip-address" : [ { "start-ip-address" : "10.1.1.1", "end-ip-address" : "10.1.1.1" } ], "static-bind" : [ { "static-bind-ip" : "10.1.1.1", "static-bind-mac" : "xxxx-xxxx-xxxx" } ], "option" : [ { "option-code" : 56, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "wevweq", "hex-string" : "4", "cipher-string" : "********", "sub-options" : { "sub-option" : [ { "sub-option-code" : 233, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "asciistring" } ] } } ], "ip-range" : { "start-ip-address" : "10.1.1.1", "end-ip-address" : "10.1.1.1" }, "server-enable" : false, "domain-name" : "domainname", "masklen" : 24 } } ] } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:dhcpv4-if/{if-name} 表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" if-name 是 string 1~63个字符。 - interface name "GE0/0/2"

响应示例 返回状态码为200：查询成功，响应体参考VpnInfoResponse。 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" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] } 返回状态码为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的示例 GET /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup/vpn?id=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：查询成功，响应体参考VpnInfoResponse。 表2 VpnInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 vpnList ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。 VPN QoS组信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/redirect-policy/sites/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 { "vpnId" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] }

响应示例 返回状态码为200：修改成功，响应体参考RedirectPolicyResponse。 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", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] }, "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] } } ] } 返回状态码为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的示例 GET /controller/campus/api/v1/organization/path?path=/org1/org2 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：查询组织成功，响应体参考GetOrgOut。 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" : "", "orgId" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "path" : "/org1/org2", "level" : "2" }

响应参数 返回状态码为200：查询组织成功，响应体参考GetOrgOut。 表2 GetOrgOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - 0 错误码。当没有错误时返回0。 "0" errmsg string - 错误信息。当没有错误时返回空。 "" orgId string - - 组织ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" path string - - 组织路径。 "/org1/org2" level int32 - - 组织所在层级。 "2"

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-vpn:vpn 是 REFERENCE 详细请参见表4。 VPN配置参数。 -

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-vpn:vpn/{instance-name} 表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" instance-name 是 string 1~31个字符。 - VPN实例名，单一主键字段。 "vpn1"

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-vpn:vpn/vpn1 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-vpn:vpn" : { "instance-name" : "vpn1", "af" : [ { "type" : "ipv4-unicast", "route-distinguisher" : "1:1", "vpn-target" : [ { "value" : "1:1", "vpn-target-type" : "export-extcommunity" } ], "import-policy" : "policy1", "export-policy" : "policy2" } ] } }

响应示例 返回状态码为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

响应示例 返回状态码为201：创建成功，响应体参考LocalInterworkingPolicyResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "igwEnable" : true, "enableUnderlayFirst" : false, "transportNetworkconfigs" : [ { "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "ApSite", "priority" : 1, "bandwidth" : 10, "enableIpv6" : true, "mtu" : 1500 } ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "igwEnable" : true, "enableUnderlayFirst" : false, "transportNetworkconfigs" : [ { "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "ApSite", "priority" : 1, "bandwidth" : 10, "enableIpv6" : true, "mtu" : 1500 } ] } } ], "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 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 返回状态码为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/local-interworking 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 { "localInterworkingPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "igwEnable" : true, "enableUnderlayFirst" : false, "transportNetworkconfigs" : [ { "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "ApSite", "priority" : 1, "bandwidth" : 10, "enableIpv6" : true, "mtu" : 1500 } ] } ] }

响应参数 返回状态码为201：创建成功，响应体参考LocalInterworkingPolicyResponse。 表5 LocalInterworkingPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-2000个列表项，详细请参见表6。 成功的本地互访策略信息列表。 - fail ARRAY_REFERENCE 0-2000个列表项，详细请参见表8。 失败的本地互访策略信息列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 - 表6 LocalInterworkingPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 策略ID，修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" vpnId uuid - - VPN ID，创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" siteId uuid - - 站点ID，创建的时候必填。 "00000000-0000-0000-0000-000000000000" siteName string 0~64个字符。 - 站点名称。 "site1" igwEnable boolean true false - 是否互访网关，创建的时候必填。 true enableUnderlayFirst boolean true false false 是否underlay优先功能，默认关闭。 false transportNetworkconfigs ARRAY_REFERENCE 0-6个列表项，详细请参见表7。 集中互访的出口链路配置。 创建的时候必填。 更新的时候，如果不传值，则保持更新前的配置内容不变；如果传值，需要填写所有已配置的链路配置，未填写的链路配置会被删除。 - 表7 LocalTransportNetworkConfig对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 transportNetworkPortId uuid - - TNP ID，创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" transportNetworkPortName string 0~64个字符。 - 传输网络端口名称。 "ApSite" priority int32 - - 链路优先级，取值范围：1、2、3，1表示最高，创建或者更新的时候必填。 1 bandwidth int32 [0-99] - 本地互访占用部门带宽比，单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 FW网关设备不支持配置。 10 enableIpv6 boolean true false - 是否开启IPv6模式，IPv6模式选择开关。 true mtu int32 [46-9216] - mtu，取值范围46-9216，默认值1500。 1500 表8 FailLocalInterworkingPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid." data REFERENCE 详细请参见表6。 失败的本地互访策略请求体 - 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 localInterworkingPolicyInfos 是 REFERENCE 详细请参见表2。 创建本地互访策略请求数据。 - 表2 LocalInterworkingPolicyInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 localInterworkingPolicies 否 ARRAY_REFERENCE 0-2000个列表项，详细请参见表3。 本地互访策略添加或者更新的请求体。 - 表3 LocalInterworkingPolicyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 策略ID，修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" vpnId 否 uuid - - VPN ID，创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" siteId 否 uuid - - 站点ID，创建的时候必填。 "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称。 "site1" igwEnable 否 boolean true false - 是否互访网关，创建的时候必填。 true enableUnderlayFirst 否 boolean true false false 是否underlay优先功能，默认关闭。 false transportNetworkconfigs 否 ARRAY_REFERENCE 0-6个列表项，详细请参见表4。 集中互访的出口链路配置。 创建的时候必填。 更新的时候，如果不传值，则保持更新前的配置内容不变；如果传值，需要填写所有已配置的链路配置，未填写的链路配置会被删除。 - 表4 LocalTransportNetworkConfig对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 transportNetworkPortId 是 uuid - - TNP ID，创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" transportNetworkPortName 否 string 0~64个字符。 - 传输网络端口名称。 "ApSite" priority 否 int32 - - 链路优先级，取值范围：1、2、3，1表示最高，创建或者更新的时候必填。 1 bandwidth 否 int32 [0-99] - 本地互访占用部门带宽比，单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 FW网关设备不支持配置。 10 enableIpv6 否 boolean true false - 是否开启IPv6模式，IPv6模式选择开关。 true mtu 否 int32 [46-9216] - mtu，取值范围46-9216，默认值1500。 1500

响应示例 返回状态码为200：接口调用成功，响应体参考QueryIpsecProfileResponse。 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" : "", "totalRecords" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "name" : "Profile1", "ikeVersion" : "V2", "authenticationMode" : 0, "authenticationAlgorithm" : "SHA2-256", "preSharedKey" : "pwd", "encryptionAlgorithm" : "AES-256", "ikePrf" : "hmac-sha2-256", "integrityAlgorithm" : "hmac-sha2-256", "ikeSaDuration" : 86400, "dhGroup" : "group14", "exchangeMode" : "main", "dpdEnable" : false, "dpdType" : "periodic", "dpdIdleTime" : 30, "dpdTransmitInterval" : 15, "enableLocalId" : false, "localType" : "ip", "localId" : "192.168.10.1", "enableRemoteId" : false, "remoteType" : "ip", "remoteId" : "192.168.10.1", "securityProtocol" : "ESP", "ahAuthenticationAlgorithm" : "SHA2-256", "espAuthenticationAlgorithm" : "SHA2-256", "espEncryptionAlgorithm" : "AES-256", "profilePfs" : "dh-group14", "trfficBasedSaDuration" : 200000, "timeBasedSaDuration" : 7200 } ] } 返回状态码为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/net/ipsecprofile/template 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 模板id，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" name 否 string - - 模板名称。 "profile1" pageIndex 否 int32 - 1 当前页数，默认是1。 1 pageSize 否 int32 - 20 页大小，默认是20。 20

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/ipsecprofile/template?id=fbb684c8-0d37-496f-bafa-4b06d5151e2e&name=profile1&pageIndex=1&pageSize=20 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：接口调用成功，响应体参考QueryIpsecProfileResponse。 表2 QueryIpsecProfileResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 分页数。 20 pageIndex int32 - - 当前页数 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 IPSEC Profile模板信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为201：创建成功返回体。 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 { "id" : "3814d9aa-8d46-42ee-9194-dc17d0c21888", "account" : "support_e@huawei.com" } 返回状态码为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

请求示例 HTTP的示例 POST /v1/runbook/external-systems 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 { "externalSystemConnections" : [ { "id" : "3814d9aa-8d46-42ee-9194-dc17d0c21888", "systemName" : "DomainController", "systemType" : "DomainController", "account" : "support_e@huawei.com", "pwd" : "passwordExample", "ip" : "10.12.1.1", "port" : "31945" } ], "totalNum" : "" }

响应示例 返回状态码为201：接口调用成功，响应体参考StaticRouteResponse。 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" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } } ] } 返回状态码为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：接口调用成功，响应体参考StaticRouteResponse。 表4 StaticRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-128个列表项，详细请参见表5。 静态路由信息。 - fail ARRAY_REFERENCE 0-128个列表项，详细请参见表6。 创建或者更新失败的静态路由信息。 - 表5 StaticRouteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 静态路由资源ID，UUID格式。更新、删除时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" vpnId uuid - - 静态路由所在VPN ID，UUID格式。创建overlay 静态路由时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId uuid - - 静态路由所在站点ID，UUID格式。创建、删除时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId uuid - - 静态路由所在设备ID，UUID格式。创建时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId uuid - - 传输网络端口ID，UUID格式。创建underlay 静态路由时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" priority int32 [1-255] - 静态路由优先级。创建时必填。 1 destinationAddressMask string 0~32个字符。 - 目的网段/掩码。创建时必填。配置后不支持修改。 "10.1.0.0/16" nextHopType string 10~18个字符。 - 下一跳类型，取值范围：ip-address、outbound-interface、black-hole。创建时必填。创建underlay 静态路由，tnp为静态模式时，下一跳类型不能配置为outbound-interface。配置后不支持修改。 "ip-address" ipAddress string 0~32个字符。 - IP地址，nextHopType为ip-address时，该字段必填。配置后不支持修改。 "10.1.1.1" track boolean true false false 是否开启NQA探测，默认false。 true target string 0~32个字符。 - 探测IP地址，track为true时，该字段必填。只有在track字段为true时，target字段才生效。 "10.1.0.0" configSource string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan" isDefaultVpn boolean true false - 是否属于公网VPN，当值为true时，VPNID和TNPID必须为空。 false outBoundInterface string - - 静态路由出接口。非公网VPN的静态路由出接口，该字段当前只支持Tunnel口。 "Tunnel0/0/400" outBoundInterfaceDisplayName string - - 静态路由出接口，用于页面显示。 "GE0/0/2" outBoundInterfaceType string - - 静态路由出接口类型，对于OVERLAY静态路由，取值范围可以为：IPSec、Interworking Link。 "IPSec" 表6 FailStaticRouteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 静态路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 staticRouteInfos 是 REFERENCE 详细请参见表2。 创建静态路由入参。一次操作只能同时操作同一个站点下面的同一类型路由，必须指定相同的siteId、vpnId；vpnId为空时表示为WAN路由，非空为LAN路由。 - 表2 StaticRouteInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 routes 否 ARRAY_REFERENCE 1-128个列表项，详细请参见表3。 静态路由信息。 - 表3 StaticRouteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 静态路由资源ID，UUID格式。更新、删除时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" vpnId 否 uuid - - 静态路由所在VPN ID，UUID格式。创建overlay 静态路由时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 否 uuid - - 静态路由所在站点ID，UUID格式。创建、删除时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 uuid - - 静态路由所在设备ID，UUID格式。创建时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - 传输网络端口ID，UUID格式。创建underlay 静态路由时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" priority 否 int32 [1-255] - 静态路由优先级。创建时必填。 1 destinationAddressMask 否 string 0~32个字符。 - 目的网段/掩码。创建时必填。配置后不支持修改。 "10.1.0.0/16" nextHopType 否 string 10~18个字符。 - 下一跳类型，取值范围：ip-address、outbound-interface、black-hole。创建时必填。创建underlay 静态路由，tnp为静态模式时，下一跳类型不能配置为outbound-interface。配置后不支持修改。 "ip-address" ipAddress 否 string 0~32个字符。 - IP地址，nextHopType为ip-address时，该字段必填。配置后不支持修改。 "10.1.1.1" track 否 boolean true false false 是否开启NQA探测，默认false。 true target 否 string 0~32个字符。 - 探测IP地址，track为true时，该字段必填。只有在track字段为true时，target字段才生效。 "10.1.0.0" configSource 否 string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan" isDefaultVpn 否 boolean true false - 是否属于公网VPN，当值为true时，VPNID和TNPID必须为空。 false outBoundInterface 否 string - - 静态路由出接口。非公网VPN的静态路由出接口，该字段当前只支持Tunnel口。 "Tunnel0/0/400" outBoundInterfaceDisplayName 否 string - - 静态路由出接口，用于页面显示。 "GE0/0/2" outBoundInterfaceType 否 string - - 静态路由出接口类型，对于OVERLAY静态路由，取值范围可以为：IPSec、Interworking Link。 "IPSec"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/static 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" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } ] }