华为云用户手册

响应示例 返回状态码为200：查询成功，响应体参考QueryLocalInterworkingPolicyResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "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 } ] } ] } 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：查询拓扑节点成功，响应体参考TopoNodeInfoDto。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "", "errmsg" : "", "nodeData" : { "nodeData" : [ { "label" : "AP1", "resId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0", "nativeId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0", "nodeSize" : 64, "ownerId" : 654321, "parentResId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0", "posX" : "103.28", "posY" : "37.66" } ], "hasNext" : false, "marker" : "1009" }, "linkData" : { "linkData" : [ { "label" : "21980109442SL4600519_GigabitEthernet0/0/1_DHCPSW_85.7.22.2:10031_GigabitEthernet0/0/7", "resId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0", "topoId" : 5000, "typeId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0", "leftId" : 0, "rightId" : 0, "leftFdn" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0", "rightFdn" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0", "leftObjType" : 0, "rightObjType" : 0, "linkClass" : 0, "className" : "EntNetworkElement", "isLinkSet" : 0, "lineType" : 0, "lineWidth" : 0, "direction" : 0, "aPortName" : "GigabitEthernet0/0/24", "zPortName" : "GigabitEthernet0/0/24", "linkStatus" : 0 } ], "hasNext" : false, "marker" : "1009" } }

响应参数 返回状态码为200：查询拓扑节点成功，响应体参考TopoNodeInfoDto。 表2 TopoNodeInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码，成功返回null。 - errmsg string - - 错误描述，成功返回null。 - nodeData REFERENCE 详细请参见表3。 - - linkData REFERENCE 详细请参见表5。 - - 表3 TopoNodeDtos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nodeData ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 拓扑节点信息。 - hasNext boolean true false - 是否还有数据，默认为false。 false marker string - - 下一页查询条件。 "1009" 表4 TopoNodeDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 label string - - 资源名称。 "AP1" resId string - - 资源ID，包含组织、站点、设备。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" nativeId string - - 资源的原生标识。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" nodeSize integer - - 节点大小。 64 ownerId int64 - - 拥有者。 654321 parentResId string - - 上层resId。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" posX string 0~64个字符。 - 物理视图横坐标。 "103.28" posY string 0~64个字符。 - 物理视图纵坐标。 "37.66" 表5 TopoLinkDtos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkData ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。 链路数据。 - hasNext boolean true false - 是否有下一页,默认为false。 false marker string - - 下一页查询条件。 "1009" 表6 TopoLinkDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 label string - - 资源名称。 "21980109442SL4600519_GigabitEthernet0/0/1_DHCPSW_85.7.22.2:10031_GigabitEthernet0/0/7" resId string - - 资源ID，包含组织、站点、设备。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" topoId integer - - 拓扑ID。 5000 typeId string - - 链路类型ID。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" leftId integer - - 左节点拓扑ID。 0 rightId integer - - 右节点拓扑ID。 0 leftFdn string - - 左节点resId。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" rightFdn string - - 右节点resId。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" leftObjType integer - - 左节点类型。 0 rightObjType integer - - 右节点类型。 0 linkClass integer - - 链路类型。 0 className string - - 对象类名。 "EntNetworkElement" isLinkSet integer - - 是否为链路集，对应传统Topo字段Category。 0 lineType integer - - 链路线型。 0 lineWidth integer - - 链路线宽。 0 direction integer - - 链路方向。 0 aPortName string - - A端的端口信息,对应leftFdn。 "GigabitEthernet0/0/24" zPortName string - - Z端的端口信息，对应rightFdn。 "GigabitEthernet0/0/24" linkStatus integer - - 链路状态，包含：正常(0)、未知(1)、重要故障(2)、紧急故障(3)、离线(4)、不管理(5) 0

URI /controller/campus/v1/networkresource/topomanager/device/node 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentResId 否 string 0~36个字符。 - 组织/站点ID，UUID格式。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" limit 否 integer [0-1000] - 最大返回数量，最大查询1000条。 100 marker 否 string - - 剩余数据查询条件。 "1009"

请求示例 HTTP的示例 GET /controller/campus/v1/networkresource/topomanager/device/node?parentResId=d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0&limit=100&marker=1009 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

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/lag-ports HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "lags" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "lagId" : 0, "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceName" : "Device1", "isMemberWanLink" : true, "ports" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "portSwitch" : "layer2-port", "workMode" : "lacp-static", "pnpAggregationEnable" : false, "trustEnable" : false, "trust" : "dscp", "lacpInfo" : { "preemptEnable" : false, "timeoutType" : "slow", "fastTimeout" : "" } } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考QueryLagResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "lagId" : 0, "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceName" : "Device1", "isMemberWanLink" : true, "ports" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "portSwitch" : "layer2-port", "workMode" : "lacp-static", "pnpAggregationEnable" : false, "trustEnable" : false, "trust" : "dscp", "lacpInfo" : { "preemptEnable" : false, "timeoutType" : "slow", "fastTimeout" : "" } } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/lanwan/interconnection/route/ospf HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreProcessId" : 10, "gatewayProcessId" : 10, "gatewayRouterId" : "192.168.1.1", "coreOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ], "gatewayOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ] }

响应示例 返回状态码为200：更新OSPF邻居参数返回信息。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreProcessId" : 10, "gatewayProcessId" : 10, "gatewayRouterId" : "192.168.1.1", "coreOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ], "gatewayOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ] }, "fail" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreFailOspfIntfInfo" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 }, "errcode" : "0", "errmsg" : "" } ], "gatewayFailOspfIntfInfo" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 }, "errcode" : "0", "errmsg" : "" } ], "errcode" : "0", "errmsg" : "", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreFailInfo" : { "errcode" : "0", "errmsg" : "", "processId" : 10 }, "gatewayFailInfo" : { "errcode" : "0", "errmsg" : "", "processId" : 10 } } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：创建成功，响应体参考RadiusCreateOrUpdateResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "id" : "c6c76e11-6f75-41fb-8d90-594323c9f811", "templateInfo" : { "name" : "RadiusServer1", "desc" : "RADIUS服务器", "isContainDomainName" : true, "sharedKey" : "Example@123", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 } } } } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：创建成功，响应体参考RadiusCreateOrUpdateResponse。 表4 RadiusCreateOrUpdateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 RadiusServerTemplateInfoWithId对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~36个字符。 - RADIUS服务器模板ID "c6c76e11-6f75-41fb-8d90-594323c9f811" templateInfo REFERENCE 详细请参见表6。 - - 表6 RadiusServerTemplateInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~32个字符。 - RADIUS服务器名称。 字符串形式，区分大小写，长度范围是1～32。字符包括大写字母、小写字母、数字、点号“.”、下划线“_”和中划线“-”。不能配置为“-”或“--”。 "RadiusServer1" desc string 0~128个字符。 - RADIUS服务器描述。 "RADIUS服务器" isContainDomainName boolean true false false 是否包含 域名 ，默认false。 true sharedKey password 1~128个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 共享密钥。 "Example@123" primaryAuthenServerInfo REFERENCE 详细请参见表7。 - - secondAuthenServerInfo REFERENCE 详细请参见表7。 - - primaryAccountServerInfo REFERENCE 详细请参见表7。 - - secondAccountServerInfo REFERENCE 详细请参见表7。 - - 表7 ServerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 serverIP string 0~64个字符。 - 服务器IP地址，支持IPV4。 "10.134.6.5" serverPort int32 [1-65535] - 服务器端口号, 范围1~65535。 10 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/rest/sdwan/v2/radius/template 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 { "name" : "RadiusServer1", "desc" : "RADIUS服务器", "isContainDomainName" : true, "sharedKey" : "Example@123", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 } }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 RequestBody 是 REFERENCE 详细请参见表2。 RADIUS服务器模板信息。 - 表2 RadiusServerTemplateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - RADIUS服务器名称。 字符串形式，区分大小写，长度范围是1～32。字符包括大写字母、小写字母、数字、点号“.”、下划线“_”和中划线“-”。不能配置为“-”或“--”。 "RadiusServer1" desc 否 string 0~128个字符。 - RADIUS服务器描述。 "RADIUS服务器" isContainDomainName 否 boolean true false false 是否包含域名，默认false。 true sharedKey 是 password 1~128个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 共享密钥。 "Example@123" primaryAuthenServerInfo 是 REFERENCE 详细请参见表3。 - - secondAuthenServerInfo 否 REFERENCE 详细请参见表3。 - - primaryAccountServerInfo 否 REFERENCE 详细请参见表3。 - - secondAccountServerInfo 否 REFERENCE 详细请参见表3。 - - 表3 ServerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 serverIP 是 string 0~64个字符。 - 服务器IP地址，支持IPV4。 "10.134.6.5" serverPort 是 int32 [1-65535] - 服务器端口号, 范围1~65535。 10

响应示例 返回状态码为200：配置租户BootROM密码。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "" }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/bootrom 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 { "passwd" : "Iam@example1", "oldPasswd" : "Iam@example1" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 配置租户BootROM密码。 - 表2 BootRomDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 passwd 否 password 8~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 V200版本的LSW设备新密码必须包含如下规则： 1.密码长度必须在8-80位。 2.密码必须满足复杂度，即至少包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)、特殊字符(如！、@、#、$、%)等中的三种，不允许包含'、?和空格。 3.密码中不能包含两个以上连续的相同字符。 V600版本的LSW设备新密码必须包含如下规则： 1、长度限制 8~255 2、新旧密码不能相同 3、密码不包含空格 4、密码复杂度校验 小写字母 大写字母 数字 特殊字符至少包含两种 "Iam@example1" oldPasswd 否 password 8~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 V200版本的LSW设备不需要此字段,V600版本的LSW设备旧密码必须包含如下规则： 1、长度限制 8~255 2、新旧密码不能相同 3、密码不包含空格 4、密码复杂度校验 小写字母 大写字母 数字 特殊字符至少包含两种 "Iam@example1"

响应示例 返回状态码为200：修改的路由器设备静态路由配置。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "mask" : "22", "description" : "", "nextAddress" : "10.20.0.0", "destinationIp" : "10.20.0.0", "priority" : 5, "nextInterface" : "GigabitEthernet0/0/4", "nqaId" : "d26320b9e15a4b069576f1ebff9c9cc1", "nqaAdminName" : "adminName", "nqaTestName" : "test", "dhcp" : false, "nextLogicInterface" : "Dialer1", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } } 返回状态码为400：校验失败信息。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/arstaticroute/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/staticroute 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 { "mask" : "22", "description" : "", "nextAddress" : "10.20.0.0", "destinationIp" : "10.20.0.0", "priority" : 5, "nextInterface" : "GigabitEthernet0/0/4", "nqaId" : "d26320b9e15a4b069576f1ebff9c9cc1", "nqaAdminName" : "adminName", "nqaTestName" : "test", "dhcp" : false, "nextLogicInterface" : "Dialer1", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceArStaticrouteInfoDto 是 REFERENCE 详细请参见表3。 修改的路由器设备静态路由配置。 - 表3 DeviceArStaticrouteInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mask 是 string 0~32个字符。 - 掩码，0-32。创建后不允许修改。 "22" description 否 string 0~256个字符。 - 描述。 "" nextAddress 否 string 0~64个字符。 - 下一跳地址，必须是合法的IPv4地址，以127或者224~255开头的IP地址为非法IP地址。当nextInterface为空时，nextAddress必填。 "10.20.0.0" destinationIp 是 string 0~64个字符。 - 目的IP地址，创建后不允许修改。必须是合法的IPv4地址，以127或者224~255开头的IP地址为非法IP地址。 "10.20.0.0" priority 否 integer [1-255] - 优先级，取值越小优先级越高，为空时默认为60。 5 nextInterface 否 string 0~25个字符。 - 路由出接口。当nextAddress为空时，nextInterface必填。 "GigabitEthernet0/0/4" nqaId 否 string 0~32个字符。 - NQA的ID。 "d26320b9e15a4b069576f1ebff9c9cc1" nqaAdminName 否 string 0~32个字符。 - NQA的admin名称，待拓展字段，入参时无需填写。 "adminName" nqaTestName 否 string 0~32个字符。 - NQA的测试名称，待拓展字段，入参时无需填写。 "test" dhcp 否 boolean true false false DHCP开关使能。当nextAddress非空时，dhcp必须为false，不填时默认为false。 false nextLogicInterface 否 string 0~32个字符。 - 逻辑出接口，待拓展字段，入参时无需填写。 "Dialer1" id 是 string 0~32个字符。 - 路由器静态路由ID。 "de5813f8ff1e41f5ba9c324da70b49ed"

URI /controller/campus/v1/networkservice/networkconfig/net/arstaticroute/devices/{deviceId}/staticroute 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备标识，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为200：配置成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "vlanId" : 10, "ip" : "10.0.0.10", "mask" : "24", "gateway" : "10.0.0.254", "masterDns" : "10.10.10.10", "slaveDns" : "10.0.0.254" } }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/apstaticip/devices/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 { "vlanId" : 10, "ip" : "10.0.0.10", "mask" : "24", "gateway" : "10.0.0.254", "masterDns" : "10.10.10.10", "slaveDns" : "10.0.0.254" }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 静态IP配置参数体。 - 表3 APStaticIpDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlanId 否 integer [1-4094] - 管理VLAN。 10 ip 否 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 静态IP地址，支持配置单播IP地址。 "10.0.0.10" mask 否 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 掩码，取值范围是1~32范围内的整数。 "24" gateway 否 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 网关地址，支持配置单播IP地址。 "10.0.0.254" masterDns 否 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 主 DNS地址 ，支持配置单播IP地址。 "10.10.10.10" slaveDns 否 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 备DNS地址，支持配置单播IP地址。 "10.0.0.254"

请求示例 HTTP的示例 POST /controller/campus/api/v1/networkconfig/lswospf/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 { "routerId" : "10.0.0.1", "processUUID" : "", "processId" : "auto", "opaqueLsa" : "", "gracefulRestart" : "", "staticProtocol" : { "enable" : true, "cost" : "1" }, "directProtocol" : { "enable" : true, "cost" : "1" }, "bgpProtocol" : { "enable" : true, "cost" : "1" }, "bandwidthReference" : "23", "preference" : "10", "silentInterfaceList" : { "all" : true, "interfaceNameList" : [ "" ] } }

响应示例 返回状态码为200：LswOspfInfo Information HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "data" : { "routerId" : "10.0.0.1", "processUUID" : "", "processId" : "auto", "opaqueLsa" : "", "gracefulRestart" : "", "staticProtocol" : { "enable" : true, "cost" : "1" }, "directProtocol" : { "enable" : true, "cost" : "1" }, "bgpProtocol" : { "enable" : true, "cost" : "1" }, "bandwidthReference" : "23", "preference" : "10", "silentInterfaceList" : { "all" : true, "interfaceNameList" : [ "" ] } }, "errcode" : "0", "errmsg" : "" } 返回状态码为400：Error response HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errorCode" : "", "errorMsg" : "" }

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template 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 { "templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "templateName" : "Template1", "templateDesc" : "template desc", "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } }

响应示例 返回状态码为200：接口调用成功，响应体参考OverlayWanBgpPolicyTemplateChangeResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : "00000000-0000-0000-0000-000000000000" } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayWanBgpPolicyTemplate 是 REFERENCE 详细请参见表2。 Overlay WAN侧BGP路由信息。 - 表2 OverlayWanBgpPolicyTemplateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateId 是 string - - 模板ID。主键，必填参数。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" templateName 是 string - - 模板名称。必填参数。 "Template1" templateDesc 否 string - - 模板描述。 "template desc" importRoutePolicy 否 REFERENCE 详细请参见表3。 接收路由策略。importRoutePolicy与exportRoutePolicy不能同时为空。 - exportRoutePolicy 否 REFERENCE 详细请参见表3。 发布路由策略。importRoutePolicy与exportRoutePolicy不能同时为空。 -

响应示例 返回状态码为201：创建成功返回。 HTTP/1.1 201 Created Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "" } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/sdwan/v1/naas/device 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 { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000" }