华为云用户手册

请求示例 HTTP的示例 GET /controller/campus/v1/indoormapservice/devices/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2/location-info 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/overlay-network/00000000-0000-0000-0000-000000000000/topology/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 { "customPolicys" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "partialMeshPolicy", "priority" : 1, "rules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "matchCondition" : { "ipAddressPrefix" : { "prefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ], "ipv6PrefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "siteIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "siteNames" : ["siteName1","siteName2"] }, "applyAction" : { "siteSource" : "tenant", "nextHops" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "preference" : 2 } ], "applyMode" : "additive", "mode" : "permit" } } ], "applyToSites" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "applyToSiteNames" : ["siteName1","siteName2"] } ] }

响应示例 返回状态码为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" : "", "customPolicys" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "partialMeshPolicy", "priority" : 1, "rules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "matchCondition" : { "ipAddressPrefix" : { "prefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ], "ipv6PrefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "siteIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "siteNames" : ["siteName1","siteName2"] }, "applyAction" : { "siteSource" : "tenant", "nextHops" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "preference" : 2 } ], "applyMode" : "additive", "mode" : "permit" } } ], "applyToSites" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "applyToSiteNames" : ["siteName1","siteName2"] } ] } 返回状态码为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/aaa/domain?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&domainName=name 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：查询成功，响应体参考QueryDomainResponse。 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" : [ { "domainId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainName" : "name", "domainSates" : { "state" : true }, "authenticationSchemaId" : "00000000-0000-0000-0000-000000000000", "enableAuthorizationSchema" : true, "authorizationSchemaId" : "00000000-0000-0000-0000-000000000000", "enableTacasServerTemplate" : true, "tacasServerTemplateId" : "00000000-0000-0000-0000-000000000000", "radiusServerTemplateName" : "radius1" } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /controller/campus/v1/sdwan/aaa/domain 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - - 起始页，默认值1 1 pageSize 否 int32 [1-1000] - 页行记录数，默认值10 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" domainName 否 string - - 域名 模糊查询。 "name"

响应参数 返回状态码为200：查询成功，响应体参考QueryDomainResponse。 表2 QueryDomainResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 域信息列表 - pageIndex int32 - - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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 { "id" : "3814d9aa-8d46-42ee-9194-dc17d0c21888", "account" : "support_e@huawei.com" } 返回状态码为400：参数格式错误。如：参数类型错误或者范围错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为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 /v1/runbook/external-systems/3814d9aa-8d46-42ee-9194-dc17d0c21888 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 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 observePortInfos 是 REFERENCE 详细请参见表2。 更新端口镜像观察口。 - 表2 UpdateObservePortRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 observePorts 是 ARRAY_REFERENCE 1-10个列表项，详细请参见表3。 观察端口。 - 表3 UpdateObservePortInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceId 是 string 36个字符。 - 设备标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" portId 是 string 36个字符。 - 端口标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" portName 是 string 0~128个字符。 - 观察口名称。GRE隧道模式下，需要先创建物理接口。 "GE0/0/1"

响应示例 返回状态码为201：创建成功，返回体参考ConfigPortResponse。 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" : [ { "portId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portName" : "GE0/0/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的示例 PUT /controller/campus/v1/lanwan/mirror/observeport 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 { "observePorts" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portName" : "GE0/0/1" } ] }

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/site/inter/connect/ipsec/tunnel 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 { "ipsecTunnelInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "securityZone" : "underlay_untrust" } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考IpsecTunnelResponse。 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "securityZone" : "underlay_untrust" } ] } 返回状态码为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 /v1/networkservice/hierarchy-template/template-groups/templates/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：操作成功。 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 { "type" : "copy", "originTemplateId" : "00000000-0000-0000-0000-000000000000", "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1", "rootTemplateId" : "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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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：接口调用成功，响应体参考TopNSS IDT rafficListDto。 表3 TopNSSIDTrafficListDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-20个列表项，详细请参见表4。 TopN SSID流量列表。 - 表4 TopNSSIDTrafficDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ssidName string 0~256个字符。 - SSID名称。 "Fujian_CloudVR" ssidTraffic string 0~256个字符。 - SSID流量。 "69.79GB" onlineUsers string 0~256个字符。 - 在线用户数。 "100" 返回状态码为400：参数非法，查询失败。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考TopNSSIDTrafficListDto。 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" : [ { "ssidName" : "Fujian_CloudVR", "ssidTraffic" : "69.79GB", "onlineUsers" : "100" } ] } 返回状态码为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的示例 GET /controller/campus/v1/performanceservice/basicperformance/topnssidtraffic/5cd2d350-b530-4469-8df6-4e5b6c70ff6d?beginTime=1568044800561&endTime=1568044800561&timeGranularity=day&top=5&deviceType=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/v1/performanceservice/basicperformance/topnssidtraffic/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，UUID格式。 "5cd2d350-b530-4469-8df6-4e5b6c70ff6d" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 beginTime 是 int64 [0-9223372036854775807] - 起始格林威治时间(毫秒)。 1568044800561 endTime 是 int64 [0-9223372036854775807] - 结束格林威治时间(毫秒)。 1568044800561 timeGranularity 是 string day week month year - 统计周期，day---天、week---周、month---月、year---年。 "day" top 是 string 5 10 15 20 - top数据个数，取值范围：5、10、15、20。5 - 代表TOP 5、10 - 代表TOP 10、15 - 代表TOP 15、20 - 代表TOP 20。 "5" deviceType 是 string 0 1 6 - 设备类型，取值范围：0、1、6。0-代表全部设备，1-代表AP，6-代表WAC。 "1"

响应示例 返回状态码为200：当前站点的射频配置信息，返回结构体参见GroupRadioConfigResponsesDto。 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" : { "countryCode" : "CN", "scanSwitch" : true, "scanSwitch5g" : true, "scanDuration" : "60", "scanInterval" : "10000", "scanChannel" : "country-channel", "dca2gChannelSet" : "1,6,11", "dcaBandwidth" : "20mhz", "dca5gChannelSet" : "44,56,36,48,161,153,165,157,149,60,40,52,64", "calibrate" : "auto", "dcaStartTime" : "03:00:00", "dcaInterval" : 1440, "dcaScheduleTime" : "03:00:00", "tpcMaxTxPwr" : 127, "tpcMinTxPwr" : 1, "tpcCoverageThreshold" : -60, "radio2Dot4GuardIntervalMode" : "short", "radio5GuardIntervalMode" : "short", "radio11ax2Dot4GuardIntervalMode" : "dot8", "radio11ax5GuardIntervalMode" : "1dot6", "referenceDataAnalysis" : true, "selfCalibrate" : false, "radio2gMulticastRate" : "5.5", "radio5gMulticastRate" : "6", "radio5gVhtAMsduEnable" : false, "radio5gMaxFrameNum" : 2, "wmmMode" : true, "edcaClient" : [ { "ac" : "acVo", "aifsn" : 3, "ecwMin" : 4, "ecwMax" : 6, "txoplimit" : 0, "ackPolicy" : "normal" } ], "spectrumAnalysis" : false, "channelMonitor" : false, "antennaMode" : "omnidirection", "beaconCycle" : 60, "rtsCtsMode" : "cts-to-self", "rtsCtsThreshold" : 1400, "autoEnable" : true, "timeTemplateId" : "94386ba0-9976-4f92-b699-f3ca00de56e5", "airTimeFairSchedule" : true, "powerAutoAdjust" : true, "beamforming" : true, "dynamicSwitch" : false, "deauthFailTimes" : 0, "smartRoam" : false, "smartRoamThresholdSnr" : 20, "uca2gClientEnable" : false, "access2gThrehold" : 64, "reachthresHold2G" : 1, "uca5gClientEnable" : false, "access5gThrehold" : 64, "reachthresHold5G" : 1, "calibratePolicy" : "rogueAp,noise", "radio2gBaseRate" : "6,9,11", "radio2gSupportRate" : "6,9,11", "radio5gBaseRate" : "6,9,12", "radio5gSupportRate" : "6,9,12", "radio2gType" : "dot11ax", "radio5gType" : "dot11ax", "tpc5gMinTxPwr" : 9, "tpc5gMaxTxPwr" : 127, "tpc5gCoverageThreshold" : -60, "enableFlag2g" : false, "enableFlag5g" : false, "smartRoamScene2g" : "general", "smartRoamScene5g" : "general", "snr2g" : 5, "checkInterval2g" : 300, "snr5g" : 5, "checkInterval5g" : 300, "beEdcaMode" : true, "beEdcaThreshold" : 30, "mediaEdcaMode" : true, "mediaVoiceThreshold" : 30, "mediaVideoThreshold" : 30, "tcpWindowTuningSwitch" : true, "mediaVoiceDelay" : 2, "mediaVideoDelay" : 2, "mediaVoiceRatio" : 2, "mediaVideoRatio" : 2, "wmmScene" : "default", "flexibleRadio" : 2, "utmostPower2g" : 2, "utmostPower5g" : 1, "vipUser2dot4ModeUserDefine" : 20, "vipUser5ModeUserDefine" : 20, "mode" : "default", "radio5gSliceEnable" : false, "radio5gSliceRtt" : 20, "radio5gSliceRatio" : 80, "radio5gSliceFrerEnhance" : false, "coSrEnable" : true, "6gRadioConfig" : { "dca6gChannelSet" : "1,5,9,13,17,21,25,29", "dca6gBandwidth" : "20mhz", "scanSwitch6g" : true, "radio11ax6GuardIntervalMode" : "1dot6", "tpc6gMinTxPwr" : 9, "tpc6gMaxTxPwr" : 127, "tpc6gCoverageThreshold" : -60, "uacClientEnableFlag6g" : false, "uacAccess6gThrehold" : 64, "uacReachthresHold6G" : 1, "radio6gVhtAMsduEnable" : false, "radio6gMaxFrameNum" : 2, "radio6gMulticastRate" : "6", "smartRoamScene6g" : "general", "smartRoamSnr6g" : 5, "smartRoamCheckInterval6g" : 300, "utmostPower6g" : 1, "vipUser6gModeUserDefine" : 20, "enableFlag6g" : false, "vipUser6ModePhyProtection" : "security-priority" }, "fastpassusers2gEnable" : true, "fastpassusers2gNum" : 5, "fastpassusers2gPeriod" : "20ms", "fastpassusers2gRatio" : 25, "fastpassusers5gEnable" : true, "fastpassusers5gNum" : 5, "fastpassusers5gPeriod" : "20ms", "fastpassusers5gRatio" : 25, "fastpassusers6gEnable" : true, "fastpassusers6gNum" : 5, "fastpassusers6gPeriod" : "20ms", "fastpassusers6gRatio" : 25, "startThreshold2g" : 100, "gapThreshold2g" : 90, "snrThreshold2g" : 20, "denyThreshold2g" : 0, "clientBandExpire2g" : 35 } } 返回状态码为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：当前站点的射频配置信息，返回结构体参见GroupRadioConfigResponsesDto。 表2 GroupRadioConfigResponsesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 站点射频配置信息，结构体参见GroupRadioConfigResultApiDto。 - 表3 GroupRadioConfigResultApiDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 countryCode string - CN 国家码。支持的最大长度为2。默认为CN。对应关系参考：阿根廷：AR，亚美尼亚：AM，澳大利亚：AU，奥地利：AT，阿塞拜疆：AZ，巴林群岛：BH，孟加拉国：BD，比利时：BE，伯利兹：BZ，玻利维亚：BO，巴西：BR，文莱：BN，保加利亚：BG，加拿大：CA，智利：CL，中国：CN，哥伦比亚：CO，哥斯达黎加：CR，克罗地亚：HR，塞浦路斯：CY，捷克：CZ，丹麦：DK，多米尼加共和国：DO，萨尔瓦多：SV，厄瓜多尔：EC，埃及：EG，爱沙尼亚：EE，芬兰：FI，法国：FR，格鲁吉亚：GE，德国：DE，希腊：GR，危地马拉：GT，洪都拉斯：HN，中国香港：HK，匈牙利：HU，冰岛：IS，印度：IN，印度尼西亚：ID，爱尔兰：IE，以色列：IL，意大利：IT，日本：JP，约旦：JO，哈萨克斯坦：KZ，肯尼亚：KE，韩国：KR，科威特：KW，拉脱维亚：LV，列支敦士登：LI，立陶宛：LT，卢森堡：LU，中国澳门：MO，马其顿：MK，马来西亚：MY，马耳他：MT，墨西哥：MX，摩纳哥：MC，摩洛哥：MA，荷兰：NL，新西兰：NZ，尼日利亚：NG，挪威：NO，阿曼：OM，巴基斯坦：PK，巴拿马：PA，秘鲁：PE，菲律宾：PH，波兰：PL，葡萄牙：PT，波多黎各：PR，卡塔尔：QA，罗马尼亚：RO，俄罗斯：RU，西班牙：ES，斯里兰卡：LK，沙特阿拉伯：SA，塞尔维亚：RS，新加坡：SG，斯洛伐克：SK，斯洛文尼亚：SI，南非：ZA，瑞典：SE，瑞士：CH，泰国：TH，特立尼达和多巴哥：TT，突尼斯：TN，土耳其：TR，乌克兰：UA，阿拉伯联合酋长国：AE，大不列颠联合王国：GB，美国：US，乌拉圭：UY，乌兹别克斯坦：UZ，委内瑞拉：VE，越南：VN，也门：YE，白俄罗斯：BY，台湾：TW "CN" scanSwitch boolean true false true 空口扫描是否开启，可选值: true(默认)，false。 true scanSwitch5g boolean true false - 空口扫描是否开启，可选值: true(默认)，false。 true scanDuration string - - 扫描时长，范围60~100，单位（ms），默认值60，空口扫描开启时，扫描时长默认为60，如需修改，则必须填写。 "60" scanInterval string - - 扫描间隔，范围300~600000，单位（ms），默认值10000，空口扫描开启时，扫描间隔默认为10000，如需修改，则必须填写。 "10000" scanChannel string country-channel dca-channel work-channel - 扫描信道，默认值country-channel，空口扫描开启时，扫描信道默认为country-channel，如需修改，则必须填写。dca-channel（调优信道），work-channel（作信道）其中一种。默认值为country-channel。 "country-channel" dca2gChannelSet string - - 2.4G调优信道集。可选"1，6，11"和"1，5，9，13"两种信道集。 "1,6,11" dcaBandwidth string 20mhz 40mhz 80mhz - 5G调优频宽，只能为20mhz，40mhz，80mhz其中一种。 "20mhz" dca5gChannelSet string - - 5G调优信道集。当5G调优频宽为20MHz时，支持的信道有36，40，44，48，52，56，60，64，149，153，157，161，165； 当5G调优信道为40MHz或80MHz时，支持的信道有36，40，44，48，52，56，60，64，149，153，157，161。 为了确保校准结果，请选择至少三个选项。若可选信道少于三个，则此国家不支持配置此调优频宽。 "44,56,36,48,161,153,165,157,149,60,40,52,64" calibrate string manual auto schedule - 调优模式。 "auto" dcaStartTime hh:mm:ss - - 自动调优模式下开始时间。 "03:00:00" dcaInterval int32 [30-1440] - 自动调优模式下周期，单位（min）。 1440 dcaScheduleTime hh:mm:ss - - 定时调优模式下调优时间。 "03:00:00" tpcMaxTxPwr int32 [1-127] - 2.4G TPC上限。 127 tpcMinTxPwr int32 [1-127] - 2.4G TPC下限。 1 tpcCoverageThreshold int32 [-85--35] - 2.4G TPC阈值。 -60 radio2Dot4GuardIntervalMode string - - 2.4G射频间隔(GI)模式，可填default(默认)、short(短间隔)或normal(普通间隔)。普通间隔的时间为800ns，在802.11n和802.11ac标准中允许使用短间隔，为400ns，可以提高802.11n和802.11ac的传输率。 "short" radio5GuardIntervalMode string - - 5G射频间隔(GI)模式，可填default(默认)、short(短间隔)或normal(普通间隔)。普通间隔的时间为800ns，在802.11n和802.11ac标准中允许使用短间隔，为400ns，可以提高802.11n和802.11ac的传输率。 "short" radio11ax2Dot4GuardIntervalMode string - dot8 2.4G射频802.11ax的间隔(GI)模式，可填dot8（代表800ns）、1dot6（代表1600ns）或3dot2（代表3200ns）。间隔时间越小，传输效率越高，间隔时间越大，抗干扰能力越强。室内环境干扰因素小，建议使用小的GI，室外环境干扰因素大，建议使用大的GI，默认值为dot8。 "dot8" radio11ax5GuardIntervalMode string - dot8 5G射频802.11ax的间隔(GI)模式，可填dot8（代表800ns）、1dot6（代表1600ns）或3dot2（代表3200ns）。间隔时间越小，传输效率越高，间隔时间越大，抗干扰能力越强。室内环境干扰因素小，建议使用小的GI，室外环境干扰因素大，建议使用大的GI，默认值为dot8。 "1dot6" referenceDataAnalysis boolean true false - 基于历史数据进行射频调优，可选值: true(默认)，false。 true selfCalibrate boolean true false - 同一个站点下跨二层AP自调优，可选值: true，false(默认)。 false radio2gMulticastRate string - - 2.4G射频模板无线组播速率，缺省值为0（自适应），取值范围：1，2，5.5，6，9，11，12，18，24，36，48,54。单位Mbps。 "5.5" radio5gMulticastRate string - - 5G射频模板无线组播速率，缺省值为0（自适应），取值范围：6，9，12，18，24，36，48，54。单位Mbps。 "6" radio5gVhtAMsduEnable boolean true false false 5G射频模板A-MSDU聚合开关，默认为关闭。 false radio5gMaxFrameNum int32 [2-15] 2 5G射频模板最大聚合子帧数，取值范围2~15，默认值为2。 2 wmmMode boolean true false true 报文信道竞争开关，默认打开。 true edcaClient ARRAY_REFERENCE 0-4个列表项，详细请参见表4。 2.4G和5G射频模板的信道竞争参数，在wmmMode为true时，可选填该数组。若不填则不更改此配置，结构体参见DeviceRadioEdcaDto。 - spectrumAnalysis boolean true false false 频谱分析开关，可选值: false(默认)，true。 false channelMonitor boolean true false false 全信道扫描开关，可选值: false(默认)，true。 false antennaMode string - omnidirection 天线模式，可填omnidirection（全向天线）或direction（定向天线）。默认值为omnidirection。 "omnidirection" beaconCycle int32 [60-1000] - beacon周期(ms) 60 rtsCtsMode string cts-to-self rts-cts disable rts-cts RTS- CTS 模式，默认值为rts-cts。 "cts-to-self" rtsCtsThreshold int32 [64-2347] 1400 RTS-CTS阈值(byte)，默认值为1400。 1400 autoEnable boolean true false false 定时开启，可选值: true，false。默认值为false true timeTemplateId string 32~36个字符。 - 定时开启的时间模板id，仅autoEnable为true时可传值。 "94386ba0-9976-4f92-b699-f3ca00de56e5" airTimeFairSchedule boolean true false true 空口时间公平调度，可选值: true，false。默认值为true true powerAutoAdjust boolean true false - 逐包功控，可选值: true，false。 true beamforming boolean true false - 波束成形，可选值: true，false。 true dynamicSwitch boolean true false - 负载均衡，可选值: true，false。 false deauthFailTimes int16 [0-5] - deauth方式迁移次数。 0 smartRoam boolean true false - 智能漫游，可选值: true，false。 false smartRoamThresholdSnr int32 [15-45] 20 智能漫游信噪比阈值 20 uca2gClientEnable boolean true false - 2.4G接入用户阈值使能，可选值: true，false。 false access2gThrehold int32 [1-512] - 2.4G接入用户阈值 64 reachthresHold2G int32 [1-3] - 2.4G用户优先保障策略 范围：1：新用户禁止接入 2：用户禁止进入且隐藏 3：VIP用户优先接入 1 uca5gClientEnable boolean true false - 5G接入用户阈值使能，可选值: true，false。 false access5gThrehold int32 [1-512] - 5G接入用户阈值 64 reachthresHold5G int32 [1-3] - 5G用户优先保障策略 范围：1：新用户禁止接入 2：用户禁止进入且隐藏 3：VIP用户优先接入 1 calibratePolicy string 0~64个字符。 close 自动调优模式下射频调优策略(calibrate为auto时生效)，取值范围：close或者rogueAp,noise,nonWifi三个中选择一个或多个，英文逗号分隔。默认值为close。 "rogueAp,noise" radio2gBaseRate string 0~64个字符。 - 2.4G基础速率，取值范围：1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54中选择一个或多个(radio2gType填dot11b时，取值范围为1,2,5.5,11)，英文逗号分隔，单位Mbps。 "6,9,11" radio2gSupportRate string 0~64个字符。 - 2.4G支持速率，取值范围：1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54中选择一个或多个(radio2gType填dot11b时，取值范围为1,2,5.5,11)，英文逗号分隔，单位Mbps。 "6,9,11" radio5gBaseRate string 0~64个字符。 - 5G基础速率，取值范围：6, 9, 12, 18, 24, 36, 48, 54中选择一个或多个，英文逗号分隔，单位Mbps。 "6,9,12" radio5gSupportRate string 0~64个字符。 - 5G支持速率，取值范围：6, 9, 12, 18, 24, 36, 48, 54中选择一个或多个，英文逗号分隔，单位Mbps。 "6,9,12" radio2gType string - dot11ax 2.4G射频类型选择，可填dot11b(802.11b模式)、dot11g(802.11g模式，可向前兼容)、dot11n(802.11n模式，可向前兼容)、dot11ax(默认，802.11ax模式，可向前兼容)、dot11be(802.11be模式，可向前兼容)。当2G射频模板视图配置dot11b时，引用了此2G射频模板的AP 2GHz射频上生效的管理帧发送速率和无线报文组播发送速率均固定为1Mbps且再进行组播速率(multicast-rate)和管理帧发送速率(beacon-2g-rate)配置不生效。 "dot11ax" radio5gType string - dot11ax 5G射频类型选择，可填dot11a(802.11a模式)、dot11n(802.11n模式，可向前兼容)、dot11ac(802.11ac模式，可向前兼容)、dot11ax(默认，802.11ax模式，可向前兼容)、dot11be(802.11be模式，可向前兼容)。射频类型配置为dot11a时，禁止非HT终端接入功能失效；射频类型配置超出AP支持的能力范围时，则按照AP实际支持的能力生效；对于使能了WDS或Mesh功能的射频，如果射频类型配置为不支持802.11n/ac，则会降低空口回传性能。 "dot11ax" tpc5gMinTxPwr int32 [1-127] - 5G TPC下限。 9 tpc5gMaxTxPwr int32 [1-127] - 5G TPC上限，需不小于5G TPC下限。 127 tpc5gCoverageThreshold int32 [-85--35] - 5G TPC阈值。 -60 enableFlag2g boolean true false - 2.4G弱信号终端强制下线。 false enableFlag5g boolean true false - 5G弱信号终端强制下线。 false smartRoamScene2g string general highDensity userDefined - 2.4G弱信号终端强制下线场景，enableFlag2g为true时生效，取值范围：general, highDensity, userDefined。 "general" smartRoamScene5g string general highDensity userDefined - 5G弱信号终端强制下线场景，enableFlag2g为true时生效，取值范围：general, highDensity, userDefined。 "general" snr2g int32 [5-45] - 2.4G信噪比阈值(dB)，smartRoamScene2g为userDefined时生效。 5 checkInterval2g int32 [300-3000] - 2.4G检测周期(ms)，smartRoamScene2g为userDefined时生效。 300 snr5g int32 [5-45] - 5G信噪比阈值(dB)，smartRoamScene5g为userDefined时生效。 5 checkInterval5g int32 [300-3000] - 5G检测周期(ms)，smartRoamScene5g为userDefined时生效。 300 beEdcaMode boolean true false - BE动态优化。 true beEdcaThreshold int32 [1-1000] - BE优化阈值(包/秒)，beEdcaMode为true时生效。 30 mediaEdcaMode boolean true false - 多媒体动态优化。 true mediaVoiceThreshold int32 [10-1000] - 音频优化阈值(包/秒)，mediaEdcaMode为true时生效。 30 mediaVideoThreshold int32 [10-1000] - 视频优化阈值(包/秒)，mediaEdcaMode为true时生效。 30 tcpWindowTuningSwitch boolean true false - TCP调窗功能开关，打开后当语音视频业务时延达到阈值，且大流量上行TCP背景业务发包时长达到阈值时，即可对TCP ACK中回复的RWND（Receiver Window，接收窗口值）进行动态调整，达到降低终端实际发送上行数据量以保障语音视频业务的用户体验。 true mediaVoiceDelay integer [1-4] - 多媒体语音切片时延。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 mediaVideoDelay integer [1-4] - 多媒体视频切片时延。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 mediaVoiceRatio integer [1-4] - 多媒体语音切片占比。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 mediaVideoRatio integer [1-4] - 多媒体视频切片占比。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 wmmScene string default voice voiceAndVideo - WMM场景，beEdcaMode，mediaEdcaMode同时为false时生效，取值范围：default, voice, voiceAndVideo。 "default" flexibleRadio int32 [0-2] - 双频动态调整，0为关闭，1为冗余2.4G射频调整方式自动切换成5G，2为冗余2.4G射频调整方式自动关闭2.4G。 2 utmostPower2g int32 [0-2] - 2.4G极限功率，0 开启，1 默认，2 关闭 2 utmostPower5g int32 [0-2] - 5G极限功率，0 开启，1 默认，2 关闭 1 vipUser2dot4ModeUserDefine int32 [0-100] - 2.4GVIP用户带宽预留比例(%) 20 vipUser5ModeUserDefine int32 [0-100] - 5G VIP用户带宽预留比例(%) 20 mode string default 2RadioStandard 2Radio2gEnhanced 3Radio 2RadioIndependentScan - 射频模式，取值范围：default（默认）, 2RadioStandard（2射频标注）, 2Radio2gEnhanced（2射频增强）, 3Radio（3射频）, 2RadioIndependentScan（2射频独立扫描）。 "default" radio5gSliceEnable boolean true false - 使能5G空口切片 false radio5gSliceRtt int32 [10-1000] - 5g空口切片时延，默认20ms 20 radio5gSliceRatio int32 [0-80] - 5g空口切片时间占比，默认80% 80 radio5gSliceFrerEnhance boolean true false - 双发选收增强开关 false coSrEnable boolean true false - CO-SR 开关 true 6gRadioConfig REFERENCE 详细请参见表5。 6g射频信息，结构体参见6gRadioConfig。 - fastpassusers2gEnable boolean true false - 是否开启2G VIP超帧 true fastpassusers2gNum int32 [0-10] - 2G VIP超帧 保障用户数 5 fastpassusers2gPeriod string 4~5个字符。满足正则表达^(20|40|60|80|100)ms$。 - 2G VIP超帧 调度周期 （已废弃） "20ms" fastpassusers2gRatio int32 [5-75] - VIP超帧 调度周期超帧保障占比 （已废弃） 25 fastpassusers5gEnable boolean true false - 是否开启 VIP超帧 true fastpassusers5gNum int32 [0-10] - VIP超帧 保障用户数 5 fastpassusers5gPeriod string 4~5个字符。满足正则表达^(20|40|60|80|100)ms$。 - VIP超帧 调度周期 （已废弃） "20ms" fastpassusers5gRatio int32 [5-75] - VIP超帧 调度周期超帧保障占比 （已废弃） 25 fastpassusers6gEnable boolean true false - 是否开启 VIP超帧 true fastpassusers6gNum int32 [0-10] - VIP超帧 保障用户数 5 fastpassusers6gPeriod string 4~5个字符。满足正则表达^(20|40|60|80|100)ms$。 - VIP超帧 调度周期 （已废弃） "20ms" fastpassusers6gRatio int32 [5-75] - VIP超帧 调度周期超帧保障占比 （已废弃） 25 startThreshold2g int32 [0-100] - 双频间负载均衡负载起始阈值(终端数) 100 gapThreshold2g int32 [0-100] - 双频间负载均衡负载差值阈值(%) 90 snrThreshold2g int32 [10-35] - 双频间负载均衡SNR阈值(dB) 20 denyThreshold2g int32 [0-10] - 拒绝终端关联最大次数 0 clientBandExpire2g int64 [10-65535] - 终端支持频段信息老化probe次数 35 表4 DeviceRadioEdcaDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ac string - - 报文的4个接入类别。可取值为：acVo、acVi、acBe、acBk。WMM协议将数据报文分为4个接入类别，分别为AC_VO（Voice）、AC_VI（Video）、AC_BE（BestEffort）、AC_BK（Background）。当ac为acVo时，表示接入类别为语音流；当ac为acVi时，表示接入类别为视频流；当ac为acBe时，表示接入类别为尽力而为流；当ac为acBk时，表示接入类别为背景流。 "acVo" aifsn int32 [1-15] - 指定仲裁帧间隙数，决定了用户的空闲等待时间长短。aifsn数值越大，用户的空闲等待时间越长，优先级越低。范围为1~15。 3 ecwMin int32 [0-15] - 指定最小竞争窗口指数，此参数与ecwMax一起决定了用户的平均退避时间。这两个数值越大，用户的平均退避时间越长，优先级越低。取值范围：0~15，且须小于或等于ecwMax。 4 ecwMax int32 [0-15] - 指定最大竞争窗口指数，此参数与ecwMin一起决定了用户的平均退避时间。这两个数值越大，用户的平均退避时间越长，优先级越低。取值范围：0~15，且须大于或等于ecwMin。 6 txoplimit int32 [0-255] - 用户一次竞争信道成功后，可占用信道的最大时间，这个数值越大，用户一次能占用的信道时长越大。如果是0，则每次占用信道后，只能发送一个报文。取值范围：0~255。 0 ackPolicy string - - ACK策略类型，对于发送端发送的每个单播报文，接收端在成功接收到报文后，都需要发送ACK帧进行确认。只可在normal和noAck中选择。normal表示正常发送ACK帧，noAck表示不发送ACK帧。 "normal" 表5 6gRadioConfig对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dca6gChannelSet string - - 6G调优信道集。当5G调优频宽为20MHz时,支持的信道有1,5,9,13,17...233； 当6G调优信道为40MHz时,相邻2信道捆绑成一个信道,支持的信道有1,9,17,25...225或者5,13,21,29...229; 当6G调优信道为80MHz时,相邻4信道捆绑成一个信道,支持的信道有1,17,33,49...209； 当6G调优信道为160MHz时,相邻8信道捆绑成一个信道,支持的信道有1,33,65,97,129,161,193； 当6G调优信道为320MHz时,相邻16信道捆绑成一个信道,支持的信道有1,65,129； 为了确保校准结果,请选择至少三个选项。若可选信道少于三个,则此国家不支持配置此调优频宽。 "1,5,9,13,17,21,25,29" dca6gBandwidth string - - 6G调优频宽，只能为20mhz，40mhz，80mhz，160mhz，320mhz其中一种。 "20mhz" scanSwitch6g boolean true false - 空口扫描是否开启，可选值: true(默认)，false。当开启时，扫描时长，扫描间隔，扫描信道为必填项 true radio11ax6GuardIntervalMode string - dot8 6G射频802.11ax的间隔(GI)模式，可填dot8（代表800ns）、1dot6（代表1600ns）或3dot2（代表3200ns）。间隔时间越小，传输效率越高，间隔时间越大，抗干扰能力越强。室内环境干扰因素小，建议使用小的GI，室外环境干扰因素大，建议使用大的GI，默认值为dot8。 "1dot6" tpc6gMinTxPwr int32 [1-127] - 6G TPC下限。 9 tpc6gMaxTxPwr int32 [1-127] - 6G TPC上限，需不小于6G TPC下限。 127 tpc6gCoverageThreshold int32 [-85--35] - 6G TPC阈值。 -60 uacClientEnableFlag6g boolean true false - 6G接入用户阈值使能，可选值: true，false false uacAccess6gThrehold int32 [1-512] - 6G接入用户阈值 64 uacReachthresHold6G int32 [1-3] - 6G用户优先保障策略 范围：1：新用户禁止接入 2：用户禁止进入且隐藏 3：VIP用户优先接入 1 radio6gVhtAMsduEnable boolean true false false 6G射频模板A-MSDU聚合开关，默认为关闭。 false radio6gMaxFrameNum int32 [2-15] 2 6G射频模板最大聚合子帧数，取值范围2~15，默认值为2。 2 radio6gMulticastRate string - - 6G射频模板无线组播速率，缺省值为0（自适应），取值范围：6，9，12，18，24，36，48，54。单位Mbps。 "6" smartRoamScene6g string - - 6G弱信号终端强制下线场景，uacClientEnableFlag6g为true时生效，取值范围：general, highDensity, userDefined。 "general" smartRoamSnr6g int32 [5-45] - 6G信噪比阈值(dB)，smartRoamScene6g为userDefined时生效。 5 smartRoamCheckInterval6g int32 [300-3000] - 6G检测周期(ms)，smartRoamScene6g为userDefined时生效。 300 utmostPower6g int32 [0-2] - 6G极限功率，0 开启，1 默认，2 关闭 1 vipUser6gModeUserDefine int32 [0-100] - 6gVIP用户带宽预留比例(%) 20 enableFlag6g boolean true false - 6G弱信号终端强制下线。 false vipUser6ModePhyProtection string 满足正则表达^(security-priority|business-priority|disable)$。 disable 密盾功能。可选:security-priority 安全优先，对于不支持MU-MIMO功能的终端会拒绝接入；business-priority 业务优先只保障支持MU-MIMO功能的终端的业务安全性；disable:不使能。 "security-priority" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/site/fbde1c5d-5b94-49e3-a912-48641015e45c/apradio 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/api/campusoamservice/v1/cpe/cli HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "ids": [ "5c37d9e8-cdf6-11e8-a4fc-286ed488d001","5c37d9e8-cdf6-11e8-a4fc-286ed488d002" ], "commands": [ "reboot" ], "cliAnonymous": true }

响应示例 返回状态码为200：下发成功。 HTTPS 200 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "successList": [ "IC1-Huawei-AR502H-GW-0001" ], "failList": [ { "id": "5c37d9e8-cdf6-11e8-a4fc-286ed488d002", "serialNumber": "IC1-Huawei-AR502H-GW-0002", "errcode": "0x00c80049", "errmsg": "WAC is not online" } ] } 返回状态码为400：下发失败。 HTTPS 400 Bad Requests Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0x00c8000d", "errmsg": "The parameter ids is null." } 返回状态码为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：查询成功。 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" : { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1000, "authFreeMacs" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33", "expireTime" : 1529648614575, "ssid" : "CloudCampus_Guest", "siteName" : "site1" } ] } } 返回状态码为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 /v1/portal/authfree-macs?authType=0&userName=user1&terminalMac=aa-bb-cc-11-22-33&pageIndex=1&pageSize=20 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

响应参数 返回状态码为200：查询成功。 表2 GetResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 免认证MAC表项dto - 表3 MacDataOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [1-100000] - 页面索引。 1 pageSize int32 [20-100] - 页面大小。 20 totalRecords int32 [0-2000000] - 总数据量。 1000 authFreeMacs ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 免认证MAC表项响应dto - 表4 MacOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 userName string 1~256个字符。 - 用户名，不支持模糊匹配。 "user1" terminalMac string 12~17个字符。 - 终端MAC，大小写不敏感，支持的格式：xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33" expireTime int64 [0-35627788800000] - 免认证到期时间 时间戳单位：ms 1529648614575 ssid string 0~64个字符。 - 接入SSID。 "CloudCampus_Guest" siteName string 0~64个字符。 - 接入站点名称 "site1" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /v1/portal/authfree-macs 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 authType 否 int32 [0-1] - 免认证的类型 0：haca 1：portal2.0 0 userName 否 string 1~256个字符。 - 用户名，不支持模糊匹配。 "user1" terminalMac 否 string 12~17个字符。 - 终端MAC，大小写不敏感，支持的格式：xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33" pageIndex 否 int32 [1-100000] 1 页面索引。 1 pageSize 否 int32 [20-100] 20 每页显示记录数。 20

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