华为云用户手册

响应参数 返回状态码为200：站点绑定AP VLAN POOL成功，响应体参考VlanPoolTemplateResponse。 表4 VlanPoolTemplateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~32个字符。 0 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" siteTemplateId string 36个字符。 - 站点模板ID。 "00000000-0000-0000-0000-000000000000" data ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 配置成功的VLAN POOL信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /v1/networkconfig/wlan/site-templates/00000000-0000-0000-0000-000000000000/ap/vlanpools/bind 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 { "templateIds" : ["00000000-0000-0000-0000-0000000"] }

URI /v1/networkconfig/wlan/site-templates/{siteTemplateId}/ap/vlanpools/bind 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板ID, UUID格式，通过站点模板管理三方接口下的查询站点模板接口获取。 "00000000-0000-0000-0000-000000000000"

URI /controller/campus/v1/networkservice/networkconfig/net/cli/sites/{siteId}/type/{deviceType}/cli/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceType 是 string - - 设备类型，取值范围：AP、LSW、FW、AR。 "AP"

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/cli/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/type/AP/cli/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 { "ids" : [ "fbb684c80d37496fbafa4b06db151e2a" ] }

响应示例 返回状态码为200：成功删除CLI配置信息，返回结构体参见DeleteCLIResponseDto。 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" : [ "fbb684c80d37496fbafa4b06db151e2a" ] } 返回状态码为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：接口调用成功，响应体参考QueryIPv6StaticRouteResponse。 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" : 10, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "FC00::1D4F/128", "nextHopType" : "ipv6-address", "ipv6Address" : "FC00::1D4F", "nextHopInterface" : "Tunnel0/0/400", "track" : true, "target" : "FC00::1D4F", "configSource" : "Wan", "isDefaultVpn" : false } ] } 返回状态码为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

URI /controller/campus/v1/sdwan/routing-protocol/ipv6static 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - 0 当前页，默认值为0。小于等于0时，取所有数据。 0 pageSize 否 int32 - 20 每页大小，默认值为20。当前页的值小于等于0时，该值不予使用。 20 sort 否 string 0~255个字符。 - 排序字段，默认按ID降序排序。 "id" vpnId 否 uuid - - VPN ID，UUID格式。vpnId与tnpId二者必填其一。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - 传输网络端口ID，UUID格式。vpnId与tnpId二者必填其一。 "a99f794e-b510-438c-a75d-de59f02347eb" isDefaultVpn 否 boolean true false - 是否查询公网VPN的路由，为null表示查询条件不生效。 false deviceId 否 uuid - - 设备ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" keyword 否 string 0~64个字符。 - 查询关键字，如目的网段或下一跳IP地址，支持模糊查询。 "FC00::/24"

响应参数 返回状态码为200：接口调用成功，响应体参考QueryIPv6StaticRouteResponse。 表2 QueryIPv6StaticRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords integer - - 总数据条数。 10 pageSize integer - 20 每页大小，默认20。 20 pageIndex integer - - 当前页，从1开始。 1 data ARRAY_REFERENCE 0-2000个列表项，详细请参见表5。 静态路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/ipv6static?pageIndex=0&pageSize=20&sort=id&vpnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&isDefaultVpn=false&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&keyword=FC00::/24 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/site-template-binding-relationship/fbde1c5d-5b94-49e3-a912-48641015e451 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 { "siteIds" : [ "4f350825-919c-47b7-b853-f51f15912396" ] }

响应示例 返回状态码为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 { "errcode" : "0", "errmsg" : "", "success" : [ "4f350825-919c-47b7-b853-f51f15912396" ], "fail" : [ { "errcode" : "0x00c80035", "errmsg" : "Invalid parameter.", "data" : "4f350825-919c-47b7-b853-f51f15912396" } ] } 返回状态码为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

URI /controller/campus/v1/networkservice/networkconfig/site-template-binding-relationship/{siteTemplateId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板ID，UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e451"

响应示例 返回状态码为200：查询站点成功，响应体参考QuerySiteTimeZoneRespons。 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" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : false, "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 } } } ] } 返回状态码为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：查询成功，响应体参考QueryDevicesOutputDto。 HTTPS 200 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "data": [ { "devIsBound": false, "id": "d3e43f5a-a654-4ec9-a2bc-34abb43ffa75", "name": "devcie01", "esn": "1019A0055991", "deviceModel": "LSW", "deviceRole": "ACC", "manageType": 0, "siteId": "104d216d-99f9-62ff-f7fa-f1e50024d8d5", "siteName": "site01", "mac"："11-11-11-11-11" } ] } 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80014", "errmsg":"data not exist", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" } 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80018", "errmsg":"internal error", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" }

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/site/timezone?pageIndex=1&pageSize=20&sort=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb 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：查询站点成功，响应体参考QuerySiteTimeZoneRespons。 表2 QuerySiteTimeZoneRespons对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 每页显示数量。 20 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 Site信息。 - 表3 SiteTimeZone对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 站点ID，格式为uuid。修改时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" timeZone string 0~255个字符。 - 时区信息。 "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi" enableSummerConfig boolean true false - 是否开启夏令时。默认值为false。 false enableAutoConfig boolean true false - 是否自动给设备下发夏令时时间，当enableAutoConfig为true时，daylightSavingTime必须为空，控制器会根据时区自动获取夏令时时间并下发给站点内的设备，否则daylightSavingTime必填。默认值为true。 true daylightSavingTime REFERENCE 详细请参见表4。 - - 表4 DaylightSavingTime对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~32个字符。 - 时区名称。可配置为英文，数字，特殊字符，其中特殊字符包含：_-/。 "Atlantic/Canary" offset string 1~5个字符。 - 相对零时区间隔，格式为HH:MM，取值范围00:01-02:00。 "01:00" enableWeekDay boolean true false - 夏令时使能周期。当enableWeekDay为true时，startTime和stopTime中week和weekday必填；当enableWeekDay为false时，startTime和stopTime中day必填。默认值为false。 false startTime REFERENCE 详细请参见表5。 夏令时开始时间。 {"month":"Jan","time":"05:00"} stopTime REFERENCE 详细请参见表5。 夏令时结束时间。 {"month":"Jan","time":"05:00"} 表5 DaylightTime对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 month string Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec - 指定月份，取值范围为Jan（一月），Feb（二月），Mar（三月），Apr（四月），May（五月），Jun（六月），Jul（七月），Aug（八月），Sep（九月），Oct（十月），Nov（十一月），Dec（十二月）。 "Jan" time string 5个字符。 - 指定时间，24小时制时间，格式为HH:MM。 "23:59" week string 0~64个字符。 - 指定周，取值范围为first（月份起始的第一周），second（月份起始的第二周），third（月份起始的第三周），fourth（月份起始的第四周），fifth（月份起始的第五周），last（月份起始的最后一周）。 "first" weekday string Mon Tue Wed Thu Fri Sat Sun - 指定工作日，取值范围为Mon（周一），Tue（周二），Wed（周三），Thu（周四），Fri（周五），Sat（周六），Sun（周日）。 "Mon" day int16 [1-31] - 指定天，取值范围是1-31，2月只到28号。 21 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应参数 返回状态码为200：查询成功，响应体参考QueryDevicesOutputDto。 表3 QueryDevicesOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~20个字符。 - 状态码，0：请求成功。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 查询的设备信息。 - 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。

请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule/devices/action/batch-query HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "deviceIds": ['f0039bfc-5cf0-1f24-2865-86016a8a83c0', 'e555c570-2247-a16e-03e4-033e142474da'] }

请求示例 HTTP的示例 DELETE /controller/campus/v1/networkservice/networkconfig/net/localuser/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/users/test 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：修改成功，返回信息，结构体参见deleteLocalUserInfoResponse。 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" : "" }

URI /controller/campus/v1/networkservice/networkconfig/net/localuser/sites/{siteId}/users/{username} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" username 是 string 0~64个字符。 - 本地用户名，在URL中拼接用户名时，要对特殊字符转义。 "test"

响应示例 返回状态码为201：创建成功，响应体参考EffectiveTimeResponse。 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" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "Weekly", "weeklyDay" : "1111100", "startTime" : "00:00:00Z", "endTime" : "23:01:40Z" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "Weekly", "weeklyDay" : "1111100", "startTime" : "00:00:00Z", "endTime" : "23:01:40Z" } } ] } 返回状态码为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/policy/traffic/effective-times 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 { "effectiveTimes" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "Weekly", "weeklyDay" : "1111100", "startTime" : "00:00:00Z", "endTime" : "23:01:40Z" } ] }

响应参数 返回状态码为201：创建成功，响应体参考EffectiveTimeResponse。 表4 EffectiveTimeResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 成功的时效模板信息列表。 - fail ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。 失败的时效模板信息列表。 - 表5 EffectiveTimeInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 模板ID，修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" name string 0~64个字符。 - 模板名称，创建的时候必填。 "templateName" type string 5~6个字符。 - 时间类型，该字段可以设置为以下几种： a) Daily：每日 b) Weekly：每周 c) During：固定时间 创建的时候必填。 "Weekly" weeklyDay string 0~7个字符。 - 当type为Weekly类型时才存在，表示每周几生效，多选。 左起第1位为1代表周一，第2位为1代表周二，第3位为1代表周三，第4位为1代表周四，第5位为1代表周五，第6位为1代表周六，第7位为1代表周日。 "1111100" startTime string 0~64个字符。 - 开始时间，为UTC时间。 type为Daily和Weekly的时候为hh:mm:ssZ格式； type为During的时候为YYYY-MM-DDThh:mm:ssZ格式。 创建的时候必填。 "00:00:00Z" endTime string 0~64个字符。 - 结束时间，为UTC时间。 type为Daily和Weekly的时候为hh:mm:ssZ格式； type为During的时候为YYYY-MM-DDThh:mm:ssZ格式。 创建的时候必填。 "23:01:40Z" 表6 FailEffectiveTimeInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid." data REFERENCE 详细请参见表5。 - - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 classificationProfiles 是 REFERENCE 详细请参见表2。 创建时效模板请求数据。 - 表2 EffectiveTimeInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 effectiveTimes 否 ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 - - 表3 EffectiveTimeInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 模板ID，修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" name 否 string 0~64个字符。 - 模板名称，创建的时候必填。 "templateName" type 否 string 5~6个字符。 - 时间类型，该字段可以设置为以下几种： a) Daily：每日 b) Weekly：每周 c) During：固定时间 创建的时候必填。 "Weekly" weeklyDay 否 string 0~7个字符。 - 当type为Weekly类型时才存在，表示每周几生效，多选。 左起第1位为1代表周一，第2位为1代表周二，第3位为1代表周三，第4位为1代表周四，第5位为1代表周五，第6位为1代表周六，第7位为1代表周日。 "1111100" startTime 否 string 0~64个字符。 - 开始时间，为UTC时间。 type为Daily和Weekly的时候为hh:mm:ssZ格式； type为During的时候为YYYY-MM-DDThh:mm:ssZ格式。 创建的时候必填。 "00:00:00Z" endTime 否 string 0~64个字符。 - 结束时间，为UTC时间。 type为Daily和Weekly的时候为hh:mm:ssZ格式； type为During的时候为YYYY-MM-DDThh:mm:ssZ格式。 创建的时候必填。 "23:01:40Z"

响应示例 返回状态码为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 { "pageIndex" : "1", "pageSize" : "20", "totalRecords" : "50", "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "75f8ed0f-810a-4ff5-8e64-67c81312d01c", "siteId" : "351e1696-02a2-4a68-bad4-aa639359c222", "userName" : "1", "lastChargeTime" : "1545812248932", "usedFlow" : "20", "usedTime" : "20", "policyFlow" : "50", "policyTime" : "50", "remainFlow" : "30", "remainTime" : "30" } ] } 返回状态码为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/accountservice/user/timeflowstinfos?siteId=a91e1696-02a2-4a68-bad4-aa639359c8cf&pageIndex=1&pageSize=20&sort=userName&userName=zhangsan&usedTime=20&usedFlow=10&beginTime=2017-11-24 17:26:55&endTime=2017-11-25 17:26:55 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 TimeFlowStInfosOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [0-2147483647] - 当前页数。 "1" pageSize int32 [0-1000] - 每页最大显示数量。 "20" totalRecords int32 [0-2147483647] - 查询到的总结果数。 "50" errcode string - - 错误码。 "0" errmsg string - - 错误信息描述。 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 查询到的用户流量结果列表。 - 表3 TimeFlowStDetailInfosOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 流量时长ID。 "75f8ed0f-810a-4ff5-8e64-67c81312d01c" siteId string - - 站点ID。 "351e1696-02a2-4a68-bad4-aa639359c222" userName string - - 账号名。 "1" lastChargeTime string - - 最后一次计费更新时间。 "1545812248932" usedFlow string - - 已使用流量（兆）。 "20" usedTime string - - 已使用时间（分钟）。 "20" policyFlow string - - 策略流量（兆）。 "50" policyTime string - - 策略时长（分钟）。 "50" remainFlow string - - 剩余流量。 "30" remainTime string - - 剩余时长。 "30" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/accountservice/user/timeflowstinfos 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string - - 站点ID，UUID格式。若不填，则查询未加入站点场景下的流量时长。 "a91e1696-02a2-4a68-bad4-aa639359c8cf" pageIndex 否 int32 [0-2000000] - 当前页数，默认为1。 1 pageSize 否 int32 [0-1000] - 每页显示的最大数量，默认为20。 20 sort 否 string - - 排序字段，目前只支持用户名排序。userName为正序，-userName为逆序。 "userName" userName 否 string 0~128个字符。 - 用户名，最大长度为128。 "zhangsan" usedTime 否 string - - 已使用时长(分钟)大于等于当前条件值。 "20" usedFlow 否 string - - 已使用流量(兆)大于等于当前条件值。 "10" beginTime 否 string - - 最后一次计费时间起始时间。 "2017-11-24 17:26:55" endTime 否 string - - 最后一次计费时间截止时间。 "2017-11-25 17:26:55"