华为云用户手册

响应示例 返回状态码为200：查询成功，响应体参考QueryClassificationProfilesResponse。 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", "name" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } ] } 返回状态码为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的示例 GET /controller/campus/v1/sdwan/policy/traffic/classification-profiles 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：查询成功，响应体参考QueryClassificationProfilesResponse。 表2 QueryClassificationProfilesResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：errcode取值0代表成功，非0代表失败。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表9。 流量过滤策略信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /v1/devicemgr/access-approvals 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 { "siteId" : "00000000-0000-0000-0000-000000000001", "role" : "ACC", "devices" : ["00000000-0000-0000-0000-000000000001"] }

响应参数 返回状态码为200：修改成功，响应体参考BatchUpdateResult。 表3 BatchUpdateResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string 1~128个字符。 - 错误码 "0x00c80035" errorMessage string 1~128个字符。 - 错误原因 "参数非法" 返回状态码为400：设备ID格式错误时返回，响应体参考ErrorResponse。 ErrorResponse对象的参数列表，详细请参见表5。 返回状态码为500：服务内部异常时返回，响应体参考ErrorResponse。 ErrorResponse对象的参数列表，详细请参见表5。

响应示例 返回状态码为200：修改成功，响应体参考BatchUpdateResult。 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 { "errorCode" : "0x00c80035", "errorMessage" : "参数非法" } 返回状态码为400：设备ID格式错误时返回，响应体参考ErrorResponse。 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" : "0x00c80035", "errorMessage" : "参数非法" } 返回状态码为500：服务内部异常时返回，响应体参考ErrorResponse。 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 { "errorCode" : "0x00c80035", "errorMessage" : "参数非法" }

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/snmp/trap/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：配置成功，响应体参考SnmpResponse。 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" : { "config-status" : "reserved", "errorInfo" : "", "trapSwitch" : true, "trapQueueSize" : 1000, "trapSourceInterfaceName" : "GE0/0/0", "serverSource" : "192.168.1.1", "targetHosts" : { "targetHost" : [ { "name" : "hostName", "address" : "192.168.2.1", "isPublicNet" : false, "notifyType" : "trap", "portNumber" : 162, "vpnInstanceName" : "underlay_1", "interfaceName" : "GE0/0/1", "userName" : "user", "securityLevel" : "privacy" } ] }, "traps" : { "trap" : [ { "featureName" : "IFNET", "trapName" : "linkdown" } ] } } } 返回状态码为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/campus/v1/sdwan/net/sites 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 { "sites" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } ] }

响应示例 返回状态码为201：创建站点成功，响应体参考SiteResponse。 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" : "", "success" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : false } } ], "processInstanceId" : "" } 返回状态码为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：删除拓扑成功，响应体参考TopologyResponse。 TopologyResponse对象的参数列表，详细请参见表9。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除拓扑成功，响应体参考TopologyResponse。 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" : "", "topology" : { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }, "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 HTTP/1.1 202 Accepted 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 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology?areaId=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

接口约束 1、该接口支持msp视图、租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、删除的拓扑中若存在角色为gateway的站点，并且该gateway之前已经配置了vpn路由策略，则删除拓扑后，该站点的vpn路由策略会自动删除。 3、Topology中存在站点时，直接删除Topology请求耗时长，建议删除Topology前先移除Topology中的站点。 该API可能会直接或间接影响现网业务运行，导致业务中断、关键数据丢失等，请谨慎操作！

URI /controller/campus/v1/sdwan/overlay-network/{vpnId}/topology 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID，UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 areaId 否 uuid - - 指定区域ID，UUID格式。EVPN模式下，如果不填，表明删指定vpn下的所有area。 "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 GET /controller/campus/ui/v1/sdwan/lan/static-arps?pageIndex=0&pageSize=20&sort=name&vpnId=00000000-0000-0000-0000-00000000&siteId=00000000-0000-0000-0000-00000000&id=00000000-0000-0000-0000-00000000&keyType=IP&keyWord=192.168.1.1 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

URI /controller/campus/ui/v1/sdwan/lan/static-arps 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-400] 0 当前页数，默认是0，当不填时表示查询所有页。 0 pageSize 否 int32 [0-1000] 20 页大小，默认是20。 20 sort 否 string 0~255个字符。 - 排序字段，默认情况下不排序。 "name" vpnId 否 uuid - - 所在VPN ID。当不填ID时，vpnid和siteid必须一起填写。 "00000000-0000-0000-0000-00000000" siteId 否 uuid - - 所在站点ID。当不填ID时，vpnid和siteid必须一起填写。 "00000000-0000-0000-0000-00000000" id 否 uuid - - IP Subnet ID。 "00000000-0000-0000-0000-00000000" keyType 否 string 0~16个字符。 - 关键字类型：IP或MAC。 "IP" keyWord 否 string 0~128个字符。 - 关键字。 "192.168.1.1"

响应示例 返回状态码为200：查询指定站点的所有LAN子网列表接口调用成功，响应体参考QueryStaticArpsResponse。 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 { "errparams" : [ "siteId" ], "errcode" : "0", "errmsg" : "", "totalRecords" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : { "vpnId" : "00000000-0000-0000-0000-00000000", "siteId" : "00000000-0000-0000-0000-00000000", "staticArp" : [ { "deviceId" : "00000000-0000-0000-0000-00000000", "id" : "00000000-0000-0000-0000-00000000", "vlanId" : "100", "ipAddress" : "192.168.1.1", "macAddress" : "0000-0000-0000", "outInterfaceName" : "GigabitEthernet0/0/0", "arpType" : "system" } ] } } 返回状态码为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：操作成功。 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 { "totalRecords" : 20, "data" : [ { "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "bindingProperties" : { "bindingName" : "binding1", "deviceRoles" : ["Gateway","CORE"], "deviceTypes" : ["AP","LSW"], "deviceModels" : ["S12700E-4","S12700E-12"], "deviceNameContains" : "device1" }, "id" : "00000000-0000-0000-0000-000000000000", "description" : "this is template group member1", "featureNum" : "", "createTime" : "1713880927744" } ] } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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的示例 GET /v1/networkservice/hierarchy-template/template-groups/fbde1c5d-5b94-49e3-a912-48641015e45c/members?pageIndex=1&pageSize=10 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

URI /v1/networkservice/hierarchy-template/template-groups/{id}/members 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。 - 模板组ID，uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keyWord 否 string 0~256个字符。 - 模糊搜索关键字。 - pageIndex 是 int32 [1-1000] 1 页码。 1 pageSize 是 int32 [1-20] 10 每页大小，最大值为20。 10

响应参数 返回状态码为200：操作成功。 表3 TemplateGroupMembersQueryResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 totalRecords int32 [0-20] - 总记录数量。 20 data ARRAY_REFERENCE 0-20个列表项，详细请参见表6。 模板组列表。 - 返回状态码为400：校验异常。 CommonDto对象的参数列表，详细请参见表4。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考VpnRoutePolicyResponse。 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" : [ { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] } } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] } } } ] } 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/overlay-network/vpn/route-policy 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] } } ]

响应示例 返回状态码为200：删除PPSK帐号成功，响应体参考PpskDeleteResponseDto。 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 { "id" : "00000000-0000-0000-0000-00000000000", "account" : "PPSK001" }

请求示例 HTTP的示例 DELETE /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

响应参数 返回状态码为200：删除PPSK帐号成功，响应体参考PpskDeleteResponseDto。 表2 PpskDeleteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - PPSK帐号ID。 "00000000-0000-0000-0000-00000000000" account string 1~64个字符。 - PPSK帐号名称。 "PPSK001"

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"

授权结果查询操作步骤 参见配套产品的Restful API参考中“授权结果查询”章节，发起HTTP请求。 HTTP请求示例： GET /controller/cloud/v2/northbound/accessuser/haca/authorizationresult/5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d?nodeIp=192.168.211.236 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 收到HTTP响应消息。 HTTP响应示例： HTTP/1.1 200 OK Date: Mon,30 Jul 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" }

强制用户下线操作步骤 参见配套产品的Restful API参考中“强制用户下线”章节，发起HTTP请求。 HTTP请求示例： POST /controller/cloud/v2/northbound/accessuser/haca/cutuser HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "thirdUserInfos" : [ { "deviceMac" : "4C-FA-CA-1F-02-00", "deviceEsn" : "21500829352SG5900059", "terminalIpV4" : "10.66.85.177", "terminalIpV6" : "1030::C9B4:FF12:48AA:1A2B", "terminalMac" : "64-80-99-CF-8A-32", "userName" : "test", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d", "nodeIp" : "192.168.211.236" } ] } 收到HTTP响应消息。 HTTP响应示例： HTTP/1.1 200 OK Date: Mon,30 Jul 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "success" : [ { "message" : "success", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" } ], "failure" : [ { "message" : "success", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" } ] }