华为云用户手册

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup/list?name=VPN-Group1 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

响应示例 返回状态码为200：查询成功，响应体参考QueryVpnQosGroupInfoResponse。 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, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN-Group1", "description" : "**********", "vpnNumbers" : 10, "policyNumbers" : 10 } ] } 返回状态码为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：接口调用成功，响应体参考IPSubnetResponse。 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } } ] } 返回状态码为204：执行成功，没有数据。 HTTP/1.1 204 No Content Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/ip-subnets 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 { "IPSubnets" : [ { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } ] }

响应示例 返回状态码为200：重新升级成功的返回值。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "" } 返回状态码为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/oamservice/upgrade/reupgrade 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 { "deviceIds" : [ "57f879c7-7f6a-4d3a-88af-bf2585cb61e0" ] }

响应示例 返回状态码为200：查询成功，响应体参考QueryApplicationGroupResponse。 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" : 10, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "groupName" : "officeApp", "description" : "", "predefinedApps" : [ { "applicationId" : "2601", "applicationType" : "DPI", "applicationName" : "", "categoryName" : "", "categoryId" : "" } ], "customApps" : [ "00000000-0000-0000-0000-000000000000" ], "customApplications" : [ { "applicationName" : "", "applicationId" : "" } ], "saType" : "SA_H30071002", "shortId" : "", "experienceLevel" : "", "configId" : "00000000-0000-0000-0000-000000000000" } ] } 返回状态码为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/application/application-groups 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：查询成功，响应体参考QueryApplicationGroupResponse。 表2 QueryApplicationGroupResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 10 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-512个列表项，详细请参见表7。 自定义应用组信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/performanceservice/datamonitor/switch 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 [ { "tenantId": "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "configTenantType": [ "ap", "lsw", "fw", "ar" ], "configObjectType": 0, "sites": [ { "siteId": "00000000-0000-0000-0000-000000000001", "configType": [ "ap", "lsw", "fw", "ar" ] } ], "configObjectInfo": { "switchData": { "1001": true, "1002": false } }, "logData": [ 100, 200 ], "extDevices": [ { "switchData": { "1001": true, "1002": false }, "logData": [ 100, 200 ], "deviceIds": [ "00000000-0000-0000-0000-000000000001" ] } ] } ]

响应参数 返回状态码为200：接口调用成功，响应体参考MonitorResponse。 表6 MonitorResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" 返回状态码为400：接口更新失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考MonitorResponse。 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" } 返回状态码为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：当前时间段模板。 表2 TimeInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 - data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 时间信息列表。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：当前时间段模板。 HTTP/1.1 200 OK Date: Thu,13 Sep 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "data": [{ "id": "fbde1c5d-5b94-49e3-a912-48641015e45c", "templateName": "08:00 A.M. to 18:00 P.M.", "dayContentDtoList": [{ "switchDay": 1, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 2, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 3, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 4, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 5, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 6, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 7, "startTime": "08:00", "endTime": "18:00", "onOff": true }] }, { "id": "2c3918cb-f0bd-44e3-963b-119870bfc779", "templateName": "Workdays 08:00 to 18:00", "dayContentDtoList": [{ "switchDay": 1, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 2, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 3, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 4, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 5, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 6, "startTime": "00:00", "endTime": "00:00", "onOff": true }, { "switchDay": 7, "startTime": "00:00", "endTime": "00:00", "onOff": true }] }, { "id": "b8eafae0-d7e8-490a-a28e-c49a628de0d7", "templateName": "Weekday", "dayContentDtoList": [{ "switchDay": 1, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 2, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 3, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 4, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 5, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 6, "startTime": "00:00", "endTime": "00:00", "onOff": true }, { "switchDay": 7, "startTime": "00:00", "endTime": "00:00", "onOff": true }] }, { "id": "e86429a8-7c83-4d50-be7c-82164ab38567", "templateName": "All time", "dayContentDtoList": [{ "switchDay": 1, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 2, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 3, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 4, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 5, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 6, "startTime": "00:00", "endTime": "24:00", "onOff": true }, { "switchDay": 7, "startTime": "00:00", "endTime": "24:00", "onOff": true }] }, { "id": "94386ba0-9976-4f92-b699-f3ca00de56e5", "templateName": "tem01", "dayContentDtoList": [{ "switchDay": 1, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 2, "startTime": "08:30", "endTime": "20:30", "onOff": true }, { "switchDay": 3, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 4, "startTime": "08:30", "endTime": "20:30", "onOff": true }, { "switchDay": 5, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 6, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 7, "startTime": "08:00", "endTime": "18:00", "onOff": true }] }] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部服务错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/timetemplate?name=workday 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

响应参数 返回状态码为200：查询成功，响应体参考QueryLocalInterworkingPolicyResponse。 表2 QueryLocalInterworkingPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-10000个列表项，详细请参见表6。 站点本地互访策略信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QueryLocalInterworkingPolicyResponse。 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, "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,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/local-interworking?vpnId=000000-0000-0000-0000-000000000000&siteName=site1 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

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/lag-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 { "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，返回的链路聚合信息中仅包含对应的ID。 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-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,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：查询拓扑节点成功，响应体参考TopoNodeInfoDto。 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" : "", "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" } }

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-ACCESS-TOKEN: x-yyyyyy

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

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

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

请求示例 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,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-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,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/sdwan/routing-protocol/community-filter 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 { "communityFilters" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考CommunityFilterResponse。 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" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } } ] } 返回状态码为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