华为云用户手册

请求示例 HTTP的示例 GET /controller/campus/v2/banner/banner/be6e6d19-815a-4959-93ea-0e369ce3be0f/sites 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：接口调用成功，响应体参考BannerSiteResponse。 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" : "", "applySite" : ["be6e6d19-815a-4959-93ea-0e369ce3be0f"] } 返回状态码为400：Invalid tag value 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

响应参数 返回状态码为200：设置随流检测配置成功后的状态返回码。 表1 FlowGlobalOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" global REFERENCE 详细请参见表2。 全局配置 - 表2 FlowGlobalInput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 period int32 [1-600] 10 排障统计周期，默认10s,支持1s/10s/60s/600s 10 measure REFERENCE 详细请参见表3。 染色位 - 表3 MeasureData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 tosBit int32 [3-7] - Tos染色位 3 flagBit int32 [0-0] - Flag染色位 0 返回状态码为400：接口更新失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : "Success", "global" : { "period" : 10, "measure" : { "tosBit" : 3, "flagBit" : 0 } } } 返回状态码为400：接口更新失败后的状态返回码。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：接口发生内部错误后的状态返回码。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：创建LLDP发现任务响应成功，响应体参考CreateLldpTaskResp。 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" : "", "taskId" : "ee4d21b7-27cf-4b2e-af7a-8231a31152c0", "devices" : [ "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" ] } 返回状态码为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/api/v1/devices/lldp/scan/task 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 { "devices" : [ "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" ] }

响应示例 返回状态码为200：修改成功，响应体参考CommonRestResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errCode" : "0", "errMsg" : "", "data" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] } } 返回状态码为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/acl/basic 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-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] }

响应示例 返回状态码为200：查询成功，响应体参考PingTaskResponse。 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 { "errorCode" : 0, "errorMsg" : "", "data" : [ { "taskId" : "00000000-0000-0000-0000-000000000000", "taskName" : "task", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device", "networkType" : 0, "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link", "virtualNetworkId" : "00000000-0000-0000-0000-000000000000", "virtualNetworkName" : "vpn1", "vpnName" : "vpn", "ipType" : "IPv4", "sourceIp" : "192.168.1.1", "target" : "192.168.1.1", "packetSize" : 100, "parketNumber" : 10, "status" : 1, "packetLossRate" : 20, "avgDelay" : 20 } ] } 返回状态码为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/v2/sdwan/diagnose/ping/task/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：查询成功，响应体参考PingTaskResponse。 表2 PingTaskResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 错误码。 0 errorMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表3。 - - 表3 PingTaskInfoOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 taskId string - - 任务ID，创建ping任务时自动生成。 "00000000-0000-0000-0000-000000000000" taskName string - - 任务名称。 "task" siteId string - - 站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site" deviceId string - - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device" networkType Int2 - 0 网络类型：0 表示物理网络，1 表示虚拟网络。默认值0（物理网络）。 0 linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link" virtualNetworkId string - - 虚拟网络ID。 "00000000-0000-0000-0000-000000000000" virtualNetworkName string - - 虚拟网络实例名称。 "vpn1" vpnName string - - 虚拟网络名称。 "vpn" ipType string - - IP类型，值为IPv4或者IPv6。 "IPv4" sourceIp string - - 源IP。 "192.168.1.1" target string - - 目的IP。 "192.168.1.1" packetSize Int4 - 56 包大小。默认值56。 100 parketNumber Int2 - 5 请求包个数。默认值5。 10 status Int2 - - 任务状态。0表示成功，1表示进行中，2表示超时。 1 packetLossRate int4 - - 丢包率(%)。 20 avgDelay int8 - - 平均时延(ms)。 20 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为201：接口调用成功，响应体参考IwgPolicyResponse。 HTTP/1.1 201 Created Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/overlay-network/iwg-interworking HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "iwgPolicyInfos" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } ] }

请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/timetemplate 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 { "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": "09:00", "endTime": "17:00", "onOff": true }, { "switchDay": 7, "startTime": "08:00", "endTime": "18:00", "onOff": true }] }

响应示例 返回状态码为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": "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": "09:00", "endTime": "17: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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 modifyDto 是 REFERENCE 详细请参见表2。 修改时间段模板入参。 - 表2 TimeTemplateDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateName 是 string 1~32个字符。 - 模板名称。 "eee" dayContentDtoList 是 ARRAY_REFERENCE 7个列表项，详细请参见表3。 时间段列表，列表必须分别为周一至周日7天时间段数据。 - id 是 string 36个字符。 - 模板标识，UUID格式。 "d8b568f4-9918-4c09-a49f-c35e3bf7086b"

响应示例 返回状态码为200：查询成功。响应体参考QueryPortalOnlineUserInfoOutputDto。 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, "data" : [ { "id" : "2eab8922-a37d-4355-9788-33caade63b5a", "userId" : "43218922-a37d-43b2-9788-33caade63b5a", "userName" : "user1", "userGroupId" : "12345678-a37d-43b2-9788-33caade63b", "userGroupName" : "ROOT\\Guest", "siteId" : "11111111-a37d-43b2-9788-33caade63b5a", "loginTime" : 1541389780672, "deviceId" : "34567890-a37d-43b2-9788-33caade63b5a", "accessPolicy" : "policy_for_guest", "onlineuserTerminalIp" : "10.10.10.10", "terminalMac" : "XX-XX-XX-XX-XX-XX", "ssid" : "portal-guest", "authMode" : "1", "userType" : "0", "imsi" : "150000000000000", "imei" : "150000000000000", "mobileTerminalInfo" : "APN={APN},MSISDN={MSISDN},ULI={ULI},RAT={RAT}", "name" : "", "authPolicy" : "authrule01", "uclGroupName" : "uclGroup01", "terminalDeviceType" : "Mobile Phone/Huawei/Mate 30 5G", "osName" : "Google/Android/Android 4.4.X", "remoteIAEName" : "IAE01", "deviceIp" : "10.10.10.10", "devicePort" : "GigabitEthernet0/0/8", "deviceVlan" : "1", "accessResultId" : "44567890-a37d-43b2-9788-33caade63b5b", "accessResultName" : "accessResult01", "nasPortId" : "slot=0;sublot=0;port=8;vlanid=1;interfaceName=GigabitEthernet0/0/8", "telephone" : "8615000000000", "accessDeviceIp" : "10.10.10.10", "accessDevicePort" : "GigabitEthernet0/0/8", "accessDeviceVlan" : "1", "accessDeviceMac" : "XX-XX-XX-XX-XX-XX", "natTerminalIp" : "10.10.10.10", "natStartPort" : "10235", "natEndPort" : "10260", "autoAccess" : false, "hasMdmInfo" : false, "role" : "", "securityGroupId" : "", "stationId" : "", "sysName" : "", "terminalGroup" : "", "vipType" : "", "bypassScene" : "", "externalGroupName" : "/group" } ] } ] 返回状态码为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：查询成功。响应体参考QueryPortalOnlineUserInfoOutputDto。 表2 QueryPortalOnlineUserInfoOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总行数 1 data ARRAY_REFERENCE 详细请参见表3。 在线用户详情 - 表3 PortalOnlineUserInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 在线用户ID。UUID格式 "2eab8922-a37d-4355-9788-33caade63b5a" userId string - - 用户ID。UUID格式 "43218922-a37d-43b2-9788-33caade63b5a" userName string - - 用户名。 "user1" userGroupId string - - 用户组ID。UUID格式 "12345678-a37d-43b2-9788-33caade63b" userGroupName string - - 用户组名。 "ROOT\\Guest" siteId string - - 站点ID。UUID格式 "11111111-a37d-43b2-9788-33caade63b5a" loginTime int64 - - 登录时间。 1541389780672 deviceId string - - 设备id。UUID格式 "34567890-a37d-43b2-9788-33caade63b5a" accessPolicy string - - 认证策略名。 "policy_for_guest" onlineuserTerminalIp string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 认证终端IP。 "10.10.10.10" terminalMac string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 认证终端MAC。 "XX-XX-XX-XX-XX-XX" ssid string - - SSID。 "portal-guest" authMode int64 - - 认证方式。 "1" userType int64 - - 用户类型。 "0" imsi string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 imsi "150000000000000" imei string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 imei "150000000000000" mobileTerminalInfo string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 移动终端信息 "APN={APN},MSISDN={MSISDN},ULI={ULI},RAT={RAT}" name string 0~64个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 姓名 "" authPolicy string 0~128个字符。 - 认证规则名称 "authrule01" uclGroupName string 0~128个字符。 - 安全组名称 "uclGroup01" terminalDeviceType string 0~128个字符。 - 终端设备类型 "Mobile Phone/Huawei/Mate 30 5G" osName string 0~128个字符。 - 操作系统 "Google/Android/Android 4.4.X" remoteIAEName string 0~128个字符。 - 拉远组件名称 "IAE01" deviceIp string 0~32个字符。 - 设备Ip "10.10.10.10" devicePort string 0~32个字符。 - 设备端口 "GigabitEthernet0/0/8" deviceVlan string 0~8个字符。 - 设备Vlan "1" accessResultId string 32~36个字符。 - 授权结果Id "44567890-a37d-43b2-9788-33caade63b5b" accessResultName string 0~128个字符。 - 授权结果名称 "accessResult01" nasPortId string 0~256个字符。 - 认证设备端口vlan详细信息 "slot=0;sublot=0;port=8;vlanid=1;interfaceName=GigabitEthernet0/0/8" telephone string 0~32个字符。 - 电话号码 "8615000000000" accessDeviceIp string 0~32个字符。 - 接入设备Ip "10.10.10.10" accessDevicePort string 0~32个字符。 - 接入设备端口 "GigabitEthernet0/0/8" accessDeviceVlan string 0~8个字符。 - 接入设备Vlan "1" accessDeviceMac string 0~32个字符。 - 接入设备MAC "XX-XX-XX-XX-XX-XX" natTerminalIp string 0~32个字符。 - 公网Ip地址 "10.10.10.10" natStartPort string 0~8个字符。 - 公网地址起始端口 "10235" natEndPort string 0~8个字符。 - 公网地址结束端口 "10260" autoAccess boolean true false - 是否自动接入。默认值为false。 false hasMdmInfo boolean true false - 是否有mdm信息。默认值为false。 false role string 0~64个字符。 - 角色名称 - securityGroupId string 32~36个字符。 - 安全组id - stationId string 32~36个字符。 - Radius属性携带的Called-Station-Id字段，一般为认证设备标识信息 - sysName string 0~64个字符。 - 系统名称 - terminalGroup string 32~36个字符。 - 终端组id - vipType int32 [0-100] - vip类型 - bypassScene string 0~1个字符。 - 是否逃生场景 '0' 非逃生 '1' 逃生 - externalGroupName string 0~1024个字符。 - 外部组名称 "/group" 返回状态码为400：操作失败。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/accountservice/onlineusers?userType=0&authMode=1&pageIndex=1&pageSize=20&userName=user1&beginTimeLong=1541389780672&endTimeLong=1541390000000&accessPolicy=policy_for_guest&terminalIp=10.10.10.10&terminalMac=XX-XX-XX-XX-XX-XX&ssid=portal-guest&userGroupId=2eab8922-a37d-43b2-9788-33caade63b5a&siteId=2eab8922-a37d-43b2-9788-33caade63b5a&name=yonghuxingming&bypassScene=0 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/v1/accountservice/onlineusers 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 userType 否 string 0 1 2 4 5 6 7 10 11 12 13 14 20 21 22 24 27 64 - 用户类型：0：普通用户 1：短信注册用户 2：自注册用户 4：社交媒体用户 5：微信用户 6：Passcode用户 7：第三方用户 10：AD用户 11：PPSK用户 12：RADIUS Token用户 13：LDAP用户 14：SAML认证用户 20：普通访客 21：MAC帐号 22：第三方HTTP用户 24：公共二维码 27：已废弃 64：匿名用户。如果不填，查询所有类型。 "0" authMode 否 string 1 2 3 4 8 9 10 11 13 14 15 16 17 18 - 认证方式：1：Portal HACA认证。2、Mac免认证。3、第三方认证。4、PPSK。8、802.1x。9、Mac。10、云平台中继Radius认证。11、Portal2.0/CMCC认证。13、第三方HTTP认证。14、设备管理认证。15、FW SSL VPN认证。16、Portal2.0 Mac免认证。17、Radius中继认证。18、运营商网络终端认证。如果不填，查询所有类型。 "1" pageIndex 否 int32 - 1 起始页。 1 pageSize 否 int32 [20-100] 20 分页大小。 20 userName 否 string - - 用户名。用户名使用模糊查询。 "user1" beginTimeLong 否 int64 - - 查询起始时间。 1541389780672 endTimeLong 否 int64 - - 查询结束时间。 1541390000000 accessPolicy 否 string - - 认证策略名。 "policy_for_guest" terminalIp 否 string - - 认证终端IP。 "10.10.10.10" terminalMac 否 string - - 认证终端MAC，大小写敏感，MAC地址只支持一种格式：XX-XX-XX-XX-XX-XX。 "XX-XX-XX-XX-XX-XX" ssid 否 string - - SSID。 "portal-guest" userGroupId 否 string - - 用户组ID。UUID格式 "2eab8922-a37d-43b2-9788-33caade63b5a" siteId 否 string - - 站点ID。UUID格式 "2eab8922-a37d-43b2-9788-33caade63b5a" name 否 string 0~128个字符。 - 姓名 "yonghuxingming" bypassScene 否 string 0~1个字符。 - 是否逃生场景 "0"

响应示例 返回状态码为201：创建的防火墙设备NAT配置。 HTTP/1.1 201 Created Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "name" : "nat1", "description" : "", "conversionMode" : 3, "destinationMode" : "address-to-address", "sourceZones" : [ "00000000-0000-0000-0000-000000000001" ], "destinationZones" : [ "00000000-0000-0000-0000-000000000003" ], "oldSourceIp" : "10.2.0.6/24", "oldDestinationIp" : "10.1.1.10", "sourceConvert" : 1, "newSourceIpGroup" : [ "10.1.1.10" ], "newDestinationIpGroup" : [ "10.1.1.10" ], "destinationPort" : "80,82-98", "serviceList" : [ { "serviceType" : "tcp", "sourcePort" : "80", "destPort" : "80-97" } ], "id" : "de5813f8ff1e41f5ba9c324da70b49ed", "priority" : 5 } } 返回状态码为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

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

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/fwnat/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/fwnat 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" : "nat1", "description" : "", "conversionMode" : 3, "destinationMode" : "address-to-address", "sourceZones" : [ "00000000-0000-0000-0000-000000000001" ], "destinationZones" : [ "00000000-0000-0000-0000-000000000003" ], "oldSourceIp" : "10.2.0.6/24", "oldDestinationIp" : "10.1.1.10", "sourceConvert" : 1, "newSourceIpGroup" : [ "10.1.1.10" ], "newDestinationIpGroup" : [ "10.1.1.10" ], "destinationPort" : "80,82-98", "serviceList" : [ { "serviceType" : "tcp", "sourcePort" : "80", "destPort" : "80-97" } ] }

响应示例 返回状态码为200：AP站点立即调优结果，返回结构体参见GroupRadioDcaResponsesDto。 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

请求示例 HTTP的示例 POST /controller/campus/v3/networkconfig/site/fbde1c5d-5b94-49e3-a912-48641015e45c/apradio/groupradiodca 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：AP站点立即调优结果，返回结构体参见GroupRadioDcaResponsesDto。 表2 GroupRadioDcaResponsesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 待更新的ACL模板信息。 - 表3 UpdateAclDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~32个字符。 - ACL模板名称，包括汉字、字母、数字、下划线、.、@、-不能与已有的名称重复。 "ACLTemplate1" description 否 string 0~127个字符。 - ACL模板描述。 "ACLTemplate1" ruleList 否 ARRAY_REFERENCE 1-1024个列表项，详细请参见表3。 规则列表。 - aclNumber 否 string - - ACL模板编号，必须为数字，aclType为Advanced时，aclNumber范围：3001-3999，aclType为User时，aclNumber范围：6000-6031。 "3001"

请求示例 HTTP的示例 PUT /controller/campus/v3/profile/acl/fbde1c5d-5b94-49e3-a912-48641015e45c 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" : "ACLTemplate1", "description" : "ACLTemplate1", "ruleList" : [ { "ruleId" : "1", "ip" : "", "domain" : "", "policy" : "permit", "protocol" : "tcp", "tcpFlag" : "ack,fin", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "dscp" : 2, "description" : "Rule1" } ], "aclNumber" : "3001" }

响应示例 返回状态码为200：成功更新的ACL模板信息。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "ACLTemplate1", "aclNumber" : "3001", "description" : "ACLTemplate1", "aclType" : "Advanced", "ruleList" : [ { "ruleId" : "1", "ip" : "", "domain" : "", "policy" : "permit", "protocol" : "tcp", "tcpFlag" : "ack,fin", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "dscp" : 2, "description" : "Rule1" } ], "ipType" : "ipv4" } } 返回状态码为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

响应示例 返回状态码为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" : "", "data" : { "lldpEnable" : true, "taggedVlanId" : "10", "untaggedVlanId" : "11" } }