华为云用户手册

响应参数 返回状态码为200：查询成功。 表2 LldpResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码：当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 LLDP配置参数体 - 表3 LldpDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 lldpEnable boolean true false false LLDP配置开关状态。默认值为false。 true taggedVlanId string 0~256个字符。 - Tagged VLAN，填写1~4094范围内的数字或段（NULL或空字符串表示不设置值），如10,12-16。仅交换机设备支持该参数。 "10" untaggedVlanId string 0~256个字符。 - Untagged VLAN，填写1~4094内的整数（NULL或空字符串表示不设置值），Tagged VLAN和Untagged VLAN中不能有相同的VLAN。仅交换机设备支持该参数。 "11"

响应示例 返回状态码为200：调用创建堆叠成功，响应体参考CreateStackOutDto。 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" : [ { "stackId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "stackName" : "stack1", "stackMember" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "esn" : "AP5008293500000001", "stackMemberId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359xa", "slotId" : 0, "priority" : 100 } ] } ], "fail" : [ { "stackName" : "site1", "stackMember" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "esn" : "AP5008293500000001", "stackMemberId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359xa", "slotId" : 0, "priority" : 100 } ] } ] }

响应参数 返回状态码为200：调用创建堆叠成功，响应体参考CreateStackOutDto。 表5 CreateStackOutDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 成功的堆叠设备列表。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表8。 失败的堆叠设备列表。 - 表6 createStackSuccess对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 stackId string 1~64个字符。 - 堆叠ID，UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" stackName string 1~64个字符。 - 堆叠名称。 该字段对应UI页面上是：UI【堆叠名称】 "stack1" stackMember ARRAY_REFERENCE 1-9个列表项，详细请参见表7。 堆叠成员。 - 表7 StackMemberOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" deviceId string - - 设备ID，UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" esn string - - 设备ESN。 该字段对应UI页面上是：UI【ESN】 "AP5008293500000001" stackMemberId string - - 堆叠成员ID，UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359xa" slotId int32 - - 设备堆叠编号。 该字段对应UI页面上是：UI【槽位号】 0 priority int32 - - 设备堆叠优先级。 该字段对应UI页面上是：UI【优先级】 100 表8 createStackFail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 stackName string 1~64个字符。 - 堆叠名称。 该字段对应UI页面上是：UI【堆叠名称】 "site1" stackMember ARRAY_REFERENCE 1-9个列表项，详细请参见表7。 堆叠成员 -

请求示例 HTTP的示例 POST /controller/campus/v3/stack 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 { "stacks" : [ { "stackName" : "stack1", "stackMember" : [ { "esn" : "AP5008293500000001", "slotId" : 0, "priority" : 100 } ], "stackRoles" : "ACC" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 createStackDto 是 REFERENCE 详细请参见表2。 创建堆叠入参。 - 表2 CreateStackDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 stacks 是 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 堆叠信息。 - 表3 CreateStackDtoData对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 stackName 是 string 1~64个字符。 - 堆叠名称。如果堆叠名称已存在，则将设备加入堆叠；否则，创建堆叠并加入设备。堆叠名称不能包含"?"或者制表符TAB。 该字段对应UI页面上是：UI【堆叠名称】 "stack1" stackMember 是 ARRAY_REFERENCE 1-9个列表项，详细请参见表4。 堆叠成员。 - stackRoles 否 string Gateway CORE Gateway+CORE Gateway+RR Firewall WAC AGG ACC Wireless Access TG ACC 堆叠角色信息。非必填，默认为ACC。 该字段对应UI页面上是：UI【堆叠角色】 "ACC" 表4 StackMemberInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 esn 是 string 10~64个字符。 - 设备ESN。 该字段对应UI页面上是：UI【ESN】 "AP5008293500000001" slotId 否 int32 [0-9] - 堆叠成员编号。(添加盒式堆叠成员时非必填，添加框式堆叠成员时必填)。 该字段对应UI页面上是：UI【槽位号】 0 priority 否 int32 [1-255] 100 堆叠成员优先级。 该字段对应UI页面上是：UI【优先级】 100

URI /controller/campus/v1/sdwan/routing-protocol/bgp-public-info 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - VPN ID。废弃字段。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - TNP ID。废弃字段。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 uuid - - 设备ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" familyType 否 string - - BGP业务类型，取值范围vpnv4，ipv4-unicast，不填默认为vpnv4。 "vpnv4"

响应示例 返回状态码为200：接口调用成功，响应体参考QueryBgpPublicPeerResponse。 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", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ] } 返回状态码为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/routing-protocol/bgp-public-info?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&familyType=vpnv4 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：接口调用成功，响应体参考QueryBgpPublicPeerResponse。 表2 QueryBgpPublicPeerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2个列表项，详细请参见表5。 BGP路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/baseservice/api/v1/filemgr/files/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 [ "addc4e07-b534-4139-888a-5d44c8c7fda3" ]

响应参数 返回状态码为200：删除文件返回结果。响应体参考DeleteFileResponse 表3 DeleteFileResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" successList ARRAY_REFERENCE 详细请参见表4。 删除成功的文件列表。 - failList ARRAY_REFERENCE 详细请参见表5。 删除失败的文件列表。 - 表4 DeleteSuccessFile对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 fileName string - - 文件名 "test.xml" fileId string - - 文件Id - 表5 DeleteFailFile对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 fileName string - - 文件Id - errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" 返回状态码为400：参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：服务内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除文件返回结果。响应体参考DeleteFileResponse 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" : "", "successList" : [ { "fileName" : "test.xml", "fileId" : "" } ], "failList" : [ { "fileName" : "", "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

响应示例 返回状态码为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" : "" }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/wactunnel/acc846c5-2fff-694d-2b2d-12dff3d1231a/unbind-relation 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 { "esns" : [ "AA02354LHM1234567890" ], "siteId" : "acc846c5-2fff-694d-2b2d-12dff3d1231a" }

URI /controller/campus/v1/networkservice/networkconfig/net/wactunnel/{wacId}/unbind-relation 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 wacId 是 string 36个字符。 - 设备ID。 "acc846c5-2fff-694d-2b2d-12dff3d1231a"

响应参数 返回状态码为200：查询成功。 表2 ApExtraServiceResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 ApExtraServiceDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mu boolean true false false 是否开启上传功能，将终端位置信息上报到指定服务器。默认值为false。 true serverIp string - - 服务器IP/ 域名 。当mu为true时，参数serverIp和serverPort必填。 "www.example.com" serverPort integer [1-65535] 10031 端口号，必须为1-65535范围内的整数，不填默认为10031。端口号跟服务器IP/域名要么都填，要么都不填。 10020 interver integer [500-60000] 20000 上报周期，单位为ms，必须是500-60000范围内的整数，不填默认为20000。 10000 rssi integer [-95-0] -75 阈值，必须为-95-0范围内的整数，不填默认为-75。 -80 enablePsk boolean true false false PSK使能。 默认值为false。 false lastUpdateTime string - - 最后一次更新时间。时间格式：UTC。 "2019-05-15 15:06" apLocationEnable boolean true false false 用于标识AP安装位置信息开关是否打开。默认值为false。 true apLocation string 1~63个字符。满足正则表达[a-zA-Z0-9\x5f\x2d\x40\x2e]{1,}。 - AP安装位置信息。当apLocationEnable为true时，apLocation必填。 "B2-5F-01"

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/apextraservice/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/apextraservices 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 { "errcode" : "0", "errmsg" : "", "data" : { "mu" : true, "serverIp" : "www.example.com", "serverPort" : 10020, "interver" : 10000, "rssi" : -80, "enablePsk" : false, "lastUpdateTime" : "2019-05-15 15:06", "apLocationEnable" : true, "apLocation" : "B2-5F-01" } }

URI /controller/campus/v1/networkservice/networkconfig/net/apextraservice/sites/{siteId}/apextraservices 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/overlay-network/external-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 { "externalPorts" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "name" : "Connect to PE", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "isSubInterface" : true, "vlanId" : 2, "isEnableMpls" : true, "ipConnection" : { "ipv4" : { "ipMode" : "Static", "customerAddress" : "192.168.0.1", "prefixLength" : 24 } }, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "" } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考ExternalPortResponse，返回的外部接口信息中仅包含对应的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" : "", "success" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "name" : "Connect to PE", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "isSubInterface" : true, "vlanId" : 2, "isEnableMpls" : true, "ipConnection" : { "ipv4" : { "ipMode" : "Static", "customerAddress" : "192.168.0.1", "prefixLength" : 24 } }, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "name" : "Connect to PE", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "isSubInterface" : true, "vlanId" : 2, "isEnableMpls" : true, "ipConnection" : { "ipv4" : { "ipMode" : "Static", "customerAddress" : "192.168.0.1", "prefixLength" : 24 } }, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "" } } ] } 返回状态码为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：接口调用成功，响应体参考FlowDistrResp。 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" : [ { "targetName" : "humanflow", "counts" : [ { "count" : "123", "stamp" : 1565049600000 } ] } ] } 返回状态码为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：接口调用成功，响应体参考FlowDistrResp。 表2 FlowDistrResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" data ARRAY_REFERENCE 0-10个列表项，详细请参见表3。 终端客流量信息数据。 - 表3 FlowDistrModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 targetName string 0~64个字符。 - "REALTIME_HOUR_FLOW": 当前1分钟内接入用户数。 "REALTIME_DAY_FLOW": 当前5分钟内接入用户数。 "capture_rate"：终端捕获率。 "passersby"：客户类型，路人。 "visitors"：客户数量，访客。 "connected"：客户数量，接入用户。 "within_one_hr"：驻留时长小于一小时的客户数量。 "one_hr_to_six_hrs"：驻留时长大于一小时小于6小时的客户数量。 "more_than_six_hrs"：驻留时长大于6小时的客户数量。 "average_staytime"：平均驻留时长的客户数量。 "first_time"：首次访问的客户数量。 "occasionally"：偶尔访问的客户数量。 "regularly"：经常访问的客户数量。 "frequently"：频繁访问的客户数量。 "repeat_rate"：重复访问率。 "humanflow"：客流量。 "humanflow" counts ARRAY_REFERENCE 0-168个列表项，详细请参见表4。 对应时间的客流量。 - 表4 Count对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 count string 0~64个字符。 - 客流量。 "123" stamp int64 [0-9223372036854775807] - 时间戳（毫秒）。 1565049600000 返回状态码为400：参数非法，查询失败。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/endpointbehavior/historyflow?siteId=9dffc44b-1824-42a4-ac48-616e3f0eaa2a&tagId=31f35021-e656-472a-8937-9c6d6da76e6e&startTime=1568563200000&endTime=1568573200000 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/endpointbehavior/historyflow 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~64个字符。 - 站点ID,UUID格式。 不传默认租户级查询 "9dffc44b-1824-42a4-ac48-616e3f0eaa2a" tagId 否 string 0~64个字符。 - 标签ID，UUID格式，非必填，若不填，则默认查询站点下所有设备。 "31f35021-e656-472a-8937-9c6d6da76e6e" startTime 是 int64 - - 时间戳（毫秒），最大时间差不超过一年。 1568563200000 endTime 是 int64 - - 时间戳（毫秒），最大时间差不超过一年。 1568573200000

响应示例 返回状态码为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 { "errmsg" : "", "errcode" : "", "successList" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ], "failList" : [ { "errmsg" : "", "errcode" : "0", "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] } 返回状态码为207：部分成功。 HTTP/1.1 207 Multi-Status 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 { "errmsg" : "", "errcode" : "", "successList" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ], "failList" : [ { "errmsg" : "", "errcode" : "0", "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] } 返回状态码为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 { "errmsg" : "", "errcode" : "", "successList" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ], "failList" : [ { "errmsg" : "", "errcode" : "0", "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] } 返回状态码为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 /v1/portal/authfree-macs/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 { "authType" : 0, "authFreeMacs" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] }

响应参数 返回状态码为200：操作成功。 表4 DelResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string 0~256个字符。 错误信息。 - errcode string 0~64个字符。 0 错误码。 - successList ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 删除成功列表。 - failList ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 删除失败列表。 - 表5 DelAuthFreeMac对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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" 表6 DeleteFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string 0~256个字符。 错误信息。 "" errcode string 0~64个字符。 0 错误码。 "0" userName string 0~256个字符。 - 用户名 "user1" terminalMac string 12~17个字符。 - 终端MAC "aa-bb-cc-11-22-33" 返回状态码为207：部分成功。 DelResponseDto对象的参数列表，详细请参见表4。 返回状态码为400：校验异常或全部失败。 DelResponseDto对象的参数列表，详细请参见表4。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 删除条件。 - 表2 DelAuthFreeMacDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 authType 否 int32 [0-1] - 认证类型： 0:haca 1:portal2.0 0 authFreeMacs 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 免认证MAC表项。 - 表3 DelAuthFreeMac对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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"

请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/endpointbehavior/dwelltime?tagId=9dffc44b-1824-42a4-ac48-616e3f0eaa2a&tagType=0&startTime=1567526400&endTime=1567527800&timeUnit=day 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