华为云用户手册

请求示例 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"] }

响应示例 返回状态码为200：站点绑定AP VLAN POOL成功，响应体参考VlanPoolTemplateResponse。 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" : "", "siteTemplateId" : "00000000-0000-0000-0000-000000000000", "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "template1", "range" : "2,4-10", "type" : "even" } ] } 返回状态码为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 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-static-routing-ipv4:static-routing-ipv4/{destination-prefix}/{vpn-instance}/{next-hop-type} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" destination-prefix 是 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/(([0-9])|([1-2][0-9])|(3[0-2]))。 - IPv4目的网段/掩码，联合主键字段。 "10.1.1.0/24" vpn-instance 是 string 1~31个字符。 - VPN，联合主键字段。 "vpn1" next-hop-type 是 string Ip Interface IpInterface black_hole - 下一跳类型，联合主键字段。 "Ip"

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-static-routing-ipv4:static-routing-ipv4/10.1.1.0%2F24/vpn1/Ip 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

接口约束 该接口支持msp视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V和AR6700V子设备； 或者支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V-L款型。 该API可能会直接或间接影响现网业务运行，导致业务中断、关键数据丢失等，请谨慎操作！

响应示例 返回状态码为200：接口调用成功，响应体参考QueryIPv6StaticRouteResponse。 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" : 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,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/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

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的示例 POST /controller/campus/v1/sdwan/policy/traffic/nat/staticnat 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 { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "isUserDefined" : true, "externalIp" : "10.2.0.1", "internalIp" : "10.1.0.1", "translationType" : 1, "protocol" : "1", "externalPort" : 90, "internalPort" : 90, "addressMask" : 30, "advanceSetEnable" : false, "direction" : 1, "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] }

响应示例 返回状态码为200：创建成功，响应体参考NatResponse。 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" : { "dynamicNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "natMode" : "EASY_IP", "startAddress" : "192.168.1.1", "endAddress" : "192.168.1.2", "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ], "staticNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "isUserDefined" : true, "externalIp" : "10.2.0.1", "internalIp" : "10.1.0.1", "translationType" : 1, "protocol" : "1", "externalPort" : 90, "internalPort" : 90, "addressMask" : 30, "advanceSetEnable" : false, "direction" : 1, "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ] } }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 静态NAT策略信息。 - 表2 StaticNatDetailModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyId 否 string 0~64个字符。 - 策略id。 创建时不需要填写。 "00000000-0000-0000-0000-000000000000" isOverlay 是 boolean true false - 是否Overlay NAT。 true：Overlay NAT； false，Underlay NAT。 true vpnId 是 string 0~64个字符。 - VPN业务ID。 Overlay NAT，填写WAN虚拟网络ID； Underlay NAT，填写“UnderlayId”。 "00000000-0000-0000-0000-000000000000" siteId 是 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 string 0~64个字符。 - 部署静态NAT策略的CPE设备的ID。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 静态NAT策略的名称，创建时必填。 "policyName" linkId 是 string 0~64个字符。 - 使能NAT策略的接口ID。 Overlay NAT，填写LAN侧接口ip-subnet ID，如果在所有的Tunnel口上做NAT转换，填写"Overlay Tunnel"。 Underlay NAT，填写设备WAN链路的tnpId。 "00000000-0000-0000-0000-000000000000" interfaceName 否 string 0~64个字符。 - 接口名称，创建修改不需要填写，查询返回。 "GE0/0/8" isUserDefined 是 boolean true false - 是否用户自定义外部IP。 true，用户自定义； false，使用当前接口IP。 true externalIp 是 string 0~20个字符。 - 外部IP，NAT转换后的IP，一般是公网IP。 "10.2.0.1" internalIp 是 string 0~20个字符。 - 内部IP，NAT转换前的IP，一般是私网IP。 "10.1.0.1" translationType 是 int32 [0-1] - 转换类型，该字段可以设置为以下几种： a) 0：地址转换 b) 1：协议转换 当isUserDefined为false时，只能填写1。 1 protocol 否 string 0~10个字符。 - 协议，该字段可以设置为以下几种： a) 0：TCP b) 1：UDP c) 2：ICMP "1" externalPort 否 int32 [0-65535] - 外部端口，NAT转换后的端口号。 90 internalPort 否 int32 [0-65535] - 内部端口，NAT转换前的端口号。 90 addressMask 否 int32 [24-32] - addressMask，用户自定义时填写，范围24-32。 30 advanceSetEnable 是 boolean true false - 高级设置开关。 true:开启，方向和匹配规则设置生效； false：关闭。 false direction 否 int32 [0-2] - 方向，该字段可以设置为以下几种： a) 0：双向 b) 1：外部访问内部 c) 2：内部访问外部 1 natRuleInfos 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 规则信息。 -

响应示例 返回状态码为200：查询站点成功，响应体参考QuerySiteTimeZoneRespons。 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" : 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,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：查询站点成功，响应体参考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：内部错误。 详细信息请参见实际响应消息体。

请求示例 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

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sessionWhitelistDeleteInfo 是 REFERENCE 详细请参见表3。 待删除站点的请求数据。 - 表3 SessionWhitelistDeleteInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policies 否 ARRAY_REFERENCE 1-2个列表项，详细请参见表4。 待删除策略信息列表。 - 表4 SessionWhitelistDeleteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyId 是 uuid 1~36个字符。 - 策略id，必填。 "00000000-0000-0000-0000-000000000000" policyName 是 string 1~64个字符。 - 策略名称，必填。 "policy"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/session-whitelist/00000000-0000-0000-0000-000000000000/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 { "policies" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy" } ] }

响应示例 返回状态码为200：删除成功，响应体参考SessionWhitelistResponse。 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" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "ruleCount" : 1, "sessionWhitelistType" : "spr,firewall", "aclRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocolNum" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePortStart" : 1, "sourcePortEnd" : 1, "destinationPortStart" : 1, "destinationPortEnd" : 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

响应示例 返回状态码为201：创建成功，响应体参考EffectiveTimeResponse。 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" : "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,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/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：接口调用成功，响应体参考WanLinkQualityResponse。 表3 WanLinkQualityResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" pageIndex int32 [1-10000] - 页数。 10 pageSize int32 [1-50] - 每一页显示的条数。 10 total int32 [0-2208959999] - 总记录数。 10 data ARRAY_REFERENCE 0-50个列表项，详细请参见表4。 数据。 - 表4 FwWanLinkDevice对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~64个字符。 - 接入设备所在站点id。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" siteName string 0~256个字符。 - 接入设备所在站点名称。 "FWSite" deviceId string 0~64个字符。 - 接入设备id。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" deviceName string 0~256个字符。 - 接入设备名称。 "FWDevice" wanLink ARRAY_REFERENCE 0-50个列表项，详细请参见表5。 链路质量数据。 - 表5 FwWanLink对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceName string 0~256个字符。 - WAN口名称。 "WanInterface" wanLinkQuality ARRAY_REFERENCE 0-300个列表项，详细请参见表6。 链路质量数据。 - 表6 FwWanLinkQuality对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp int64 [0-2208959999] - 数据上报的格林威治时间（时间精度对应到秒）。 1537408636 upwardRate int64 [0-2208959999] - 接口上行速率，单位bps。 1537408636 downwardRate int64 [0-2208959999] - 接口下行速率，单位bps。 1537408636 packetLoss int64 [0-100] - 接口丢包率，百分比。 50 delay int64 [0-2208959999] - 接口时延时间，单位ms。 1537408636 jitter int64 [0-2208959999] - 接口抖动时间，单位ms。 1537408636 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考WanLinkQualityResponse。 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" : "", "pageIndex" : 10, "pageSize" : 10, "total" : 10, "data" : [ { "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "siteName" : "FWSite", "deviceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "deviceName" : "FWDevice", "wanLink" : [ { "interfaceName" : "WanInterface", "wanLinkQuality" : [ { "timestamp" : 1537408636, "upwardRate" : 1537408636, "downwardRate" : 1537408636, "packetLoss" : 50, "delay" : 1537408636, "jitter" : 1537408636 } ] } ] } ] } 返回状态码为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/api/v1/performance/interface/fw/wanlink/quality 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 { "mode" : "tenant", "id" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "pageIndex" : 10, "pageSize" : 10, "startTime" : 1537408636, "endTime" : 1537408636 }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryParam 是 REFERENCE 详细请参见表2。 查询参数。 - 表2 WanLinkQualityRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 否 string - tenant 查询维度，tenant---租户、site---站点、device---设备。 "tenant" id 否 string 0~64个字符。 - mode为device时该ID为设备ID,UUID格式;mode为site时，该ID为站点ID,UUID格式;mode为tenant时，该ID为空。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" pageIndex 否 int32 [1-10000] 1 页数。 10 pageSize 否 int32 [1-50] 10 每一页显示的条数。 10 startTime 否 int64 [0-2208959999] - 起始格林威治时间（时间精度对应到秒）。 startTime 与 endTime 约束规则如下： 租户维度支持查询15分钟内数据、站点维度支持查询1小时内数据、设备维度支持查询1天内数据 1537408636 endTime 否 int64 [0-2208959999] - 起始格林威治时间（时间精度对应到秒）。 startTime 与 endTime 约束规则如下： 租户维度支持查询15分钟内数据、站点维度支持查询1小时内数据、设备维度支持查询1天内数据 1537408636

响应示例 返回状态码为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 { "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,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/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：内部错误。 详细信息请参见实际响应消息体。