华为云用户手册

请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/site-templates/fbde1c5d-5b94-49e3-a912-48641015e45c/gapiot?isForceOverride=true 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 { "panelName" : "AirEngine5760-10", "iotCardDto" : { "cardName" : "card1", "cardConfigured" : "true", "portType" : "ethernet", "communicationPort" : 1026, "extCommunicationPort" : 1027, "communicationProtocol" : "tcp", "shareKey" : "", "trustedHostAddress" : "192.168.3.2/24", "iotServer2" : "192.168.3.2", "port2" : "2080", "administrativeStatus" : "false", "defaultVlan" : "200", "description" : "description", "iotServerOneConfig" : [ { "serverNum" : "2", "iotServer" : "192.168.3.2", "port" : "1080" } ], "powerSwitch" : "on" }, "cardNames" : ["card1"], "operation" : "Update" }

响应示例 返回状态码为200：站点模板全局IOT配置结果。 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" : { "panelName" : "AirEngine5760-10", "iotCardConfig" : { "cardName" : "card1", "cardConfigured" : "true", "portType" : "ethernet", "communicationPort" : 1026, "extCommunicationPort" : 1027, "communicationProtocol" : "tcp", "shareKey" : "", "trustedHostAddress" : "192.168.3.2/24", "iotServer2" : "192.168.3.2", "port2" : "2080", "administrativeStatus" : "false", "defaultVlan" : "200", "description" : "description", "iotServerOneConfig" : [ { "serverNum" : "2", "iotServer" : "192.168.3.2", "port" : "1080" } ], "powerSwitch" : "on" }, "cardNames" : ["card1"], "deviceGroupId" : "fbb684c8-0d37-496f-bafa-4b06db151e2e", "operation" : "update" } } 返回状态码为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/v3/networkconfig/site-templates/{siteTemplateId}/gapiot 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板标识，UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 isForceOverride 否 boolean true false - 是否强制覆盖 true

响应示例 返回状态码为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" : { "timezoneId" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "enableDaylight" : false, "ntpList" : ["10.0.0.2","10.0.0.5"], "enableTimeSync" : true } }

URI /controller/campus/v1/networkservice/networkconfig/net/time/site-templates/{siteTemplateId}/times 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string - - 站点模板ID，格式为UUID格式。 "fbb684c8-0d37-496f-bafa-4b06db151e2e"

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/time/site-templates/fbb684c8-0d37-496f-bafa-4b06db151e2e/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

响应示例 返回状态码为200：修改成功，响应体参考AddressSetResponse。 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" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } } ] } 返回状态码为202：请求正在处理中，请求处理详情请通过查询业务编排结果，确认是否处理成功。响应体参考SecurityZoneTimeOutResponse。 HTTP/1.1 202 Accepted 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" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } } ], "processInstanceId" : "" } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/security/zone 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 { "securityInfo" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ] }

响应参数 返回状态码为200：修改成功，响应体参考AddressSetResponse。 SecurityZoneResponse对象的参数列表，详细请参见表4。 返回状态码为202：请求正在处理中，请求处理详情请通过查询业务编排结果，确认是否处理成功。响应体参考SecurityZoneTimeOutResponse。 SecurityZoneTimeOutResponse对象的参数列表，详细请参见表7。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考OverlayTunnelResponse。 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" : "", "errmsg" : "", "success" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "mss" : 2048 } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "errparam" : "["policyName"]", "data" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "mss" : 2048 } } ], "processInstanceId" : "" } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/overlay-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 { "overlayTunnelInfos" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "mss" : 2048 } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayTunnels 是 REFERENCE 详细请参见表2。 Overlay Tunnel隧道信息。 - 表2 OverlayTunnels对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayTunnelInfos 是 ARRAY_REFERENCE 1-1000个列表项，详细请参见表3。 Overlay Tunnel mss信息。 - 表3 OverlayTunnelInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 string 1~64个字符。 - VN ID，更新时必填。 "00000000-0000-0000-0000-000000000000" siteId 是 string 1~64个字符。 - 站点ID，更新时必填。 "00000000-0000-0000-0000-000000000000" mss 否 int32 [128-2048] - mss。取值范围128-2048。 2048

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nodes 是 REFERENCE 详细请参见表4。 节点。 -

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:route-policy/policy1/nodes/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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-route-policy:nodes" : { "sequence" : 1, "match-mode" : "permit", "condition" : { "match-tag" : 1, "match-ipv4-type" : "ipv4-prefix", "match-ipv4-prefix" : "prefix1", "match-ipv6-type" : "ipv6-prefix", "match-ipv6-prefix" : "prefix1", "community-filter" : [ { "community-filter-name" : "communityFilterName1" } ], "ext-community-filter" : [ { "ext-community-filter-name" : "extCommunityFilterName1" } ] }, "action" : { "apply-tag" : 10, "apply-cost" : 10, "apply-local-preference" : 10, "apply-ext-community-color" : "100", "apply-community" : { "operation" : "replace", "set-community-type" : "inline", "communities" : [ "1:1" ] }, "apply-ext-community" : { "operation" : "replace", "ext-community-member" : [ { "value" : "1:1" } ] } } } }

响应示例 返回状态码为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-route-policy:route-policy/{name}/nodes/{sequence} 表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" name 是 string 1~200个字符。 - 名称，单一主键字段。 "policy1" sequence 是 int64 [0-65535] - 序号，单一主键字段。 "1"

响应示例 返回状态码为200：查询PoE电源状态成功，响应体参考GetPoePowerStateResp。 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" : "error", "data" : [ { "interfaceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359cad", "interfaceName" : "GigabitEthernet0/0/0", "portLegacy" : true, "portEnable" : true, "portPower" : true, "portStatus" : "Detecting", "portClass" : 0, "portRef" : 0, "portPriority" : "Critical", "portMax" : 15400, "portCurrentMW" : 200, "portPeak" : 400, "portAverage" : 200, "portCurrentMA" : 200.0, "portVoltage" : 200.0 } ] } 返回状态码为400：校验异常，无响应体。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：查询PoE电源状态成功，响应体参考GetPoePowerStateResp。 表2 GetPoePowerStateResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "error" data ARRAY_REFERENCE 0-1024个列表项，详细请参见表3。 PoE电源状态信息。 - 表3 PoePowerStateData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceId string - - 接口ID，UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359cad" interfaceName string - - 接口名。 "GigabitEthernet0/0/0" portLegacy boolean true false - 接口是否使能兼容性检测功能(true，false)。 true portEnable boolean true false - 接口是否使能PoE供电功能(true，false)。 true portPower boolean true false - 接口是否供电(true，false)。 true portStatus string - - 接口的供电状态：Test mode(测试状态)、Detecting(检测状态)、Disabled(接口PoE功能未使能状态)、Chip fault(芯片故障状态)、Power-deny(参考功率大于接口最大输出功率)、Classification overcurrent(分级过流)、Unknown class(未知分级)、Power overcurrent(接口过流)、Power-on failed(上电失败)、Power-ready(接口供电就绪)、Powering(正在上电)、Powered(上电结束)、Over loaded(功率过载)、Time-range power-off(接口处于下电时间段)、Unstable voltage(接口电压不稳定)。 "Detecting" portClass integer - - 接口接入设备PD的分级，系统自动根据PD设备的最大功率给PD分类，分为0～4级。 0 portRef integer - - 接口的参考功率（系统会自动识别PD设备的最大功率，并给PD设备归类，定义各类别的参考功率。PD类型和参考功率的对应关系为：0-参考功率为15400mW。1-参考功率为4000mW。2-参考功率为7000mW。3-参考功率为15400mW。4-参考功率为30000mW。）。 0 portPriority string - - 接口供电的优先级，有三种取值：Critical-最高的优先级，High-次高的优先级，Low-最低的优先级。 "Critical" portMax integer - - 接口最大输出功率，如果最大输出功率为15400mW，说明此设备支持802.3af标准；如果最大输出功率为30000mW，说明此设备支持802.3at标准。 15400 portCurrentMW integer - - 接口当前的输出功率。 200 portPeak integer - - 接口的峰值输出功率。 400 portAverage integer - - 接口的平均输出功率。 200 portCurrentMA number - - 接口的输出电流。 200.0 portVoltage number - - 接口的输出电压。 200.0 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/poe/ea25fdbf-8dee-4823-bac2-5bfe8e3359cad 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：修改成功，返回成功及失败的用户ID，响应体参考UpdateUserStatusOutput。 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" : "", "successIdList" : [ "5b988058-e092-4310-a0ad-575e9b50e2db" ], "failedIdList" : [ "5b988058-e092-4310-a0ad-575e9b50e2db" ] } 返回状态码为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/v2/accountservice/accessuser/users/status 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 { "userIdList" : [ "5b988058-e092-4310-a0ad-575e9b50e2db" ], "enable" : true }

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-l3-sub-interface:l3-sub-interface 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" { "huawei-nce-e-l3-sub-interface:l3-sub-interface" : [ { "config-status" : "", "last-committed-time" : "", "related-pkg-version" : "", "edit-state" : "", "if-name" : "Vbdif20.20", "dot1q-vlans" : { "vlan-list" : "20" }, "vlan-type-dot1q" : { "vlan-type-vid" : 20 } } ] }

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

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-l3-sub-interface:l3-sub-interface 是 REFERENCE 详细请参见表4。 l3 sub interface parameters - 表4 nes-ne-l3-sub-interface-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-l3-sub-interface:l3-sub-interface 否 ARRAY_REFERENCE 详细请参见表5。 l3 sub interface parameters - 表5 nes-ne-l3-sub-interface对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved - - last-committed-time 否 string 0~255个字符。 - 最后提交时间，该特性最后提交时间；不支持编辑，仅查询返回。 - related-pkg-version 否 string 0~255个字符。 - 包版本，插件包版本；不支持编辑，仅查询返回。 - edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态，对应运行状态、候选状态、取消部署状态、未部署状态；不支持编辑，仅查询返回。 - if-name 否 string 1~63个字符。 - Interface name "Vbdif20.20" dot1q-vlans 否 REFERENCE 详细请参见表6。 Configure dot1q termination. - vlan-type-dot1q 否 REFERENCE 详细请参见表7。 Configure VLAN-type dot1q. - 表6 dot1q-vlans对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlan-list 是 string 满足正则表达((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])?(-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))?(,((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])(-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))?))*)|((([\\+|\\-](409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))|([\\+|\\-]\\((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\\)))?(,(([\\+|\\-](409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))|([\\+|\\-]\\((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\\))))*)。 - Dot1q termination VLAN ID list. The VLAN in VLAN-list can not exist in the VLAN-list of dot1q-VLANs-group. "20" 表7 vlan-type-dot1q对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlan-type-vid 是 int32 [1-4094] - VLAN ID of the VLAN sub-interface; 20

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-l3-sub-interface:l3-sub-interface 表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"

响应示例 返回状态码为200：查询成功，响应体参考QueryFirewallPolicyResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserDefaultAction" : "deny", "internetToUserFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "userToInternetDefaultAction" : "permit", "userToInternetFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "internetToUserSessionLogEnable" : false, "userToInternetSessionLogEnable" : false, "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_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的示例 GET /controller/campus/v1/sdwan/policy/security/firewall-policies?policyName=qos 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

响应参数 返回状态码为200：查询成功，响应体参考QueryFirewallPolicyResponse。 表2 QueryFirewallPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表8。 防火墙策略信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考ClientStatisticalInfoDto。 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" : { "exprWorse" : 10, "exprBad" : 10, "exprGood" : 10, "exprBetter" : 10, "speedBad" : 10, "speedGood" : 10, "speedBetter" : 10, "oneHour" : 100, "oneToTwoHour" : 100, "twoToFourHour" : 100, "fourToSixHour" : 100, "sixToEightHour" : 100, "eightHour" : 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

响应参数 返回状态码为200：接口调用成功，响应体参考ClientStatisticalInfoDto。 表2 ClientStatisticalInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" data REFERENCE 详细请参见表3。 - - 表3 QueryTerminalStatisticsOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 exprWorse int32 [0-2147483647] - 体验-差的终端个数。该字段暂未实现，始终为0。 10 exprBad int32 [0-2147483647] - 体验-一般的终端个数。体验一般的标准为，丢包率大于等于5%。 10 exprGood int32 [0-2147483647] - 体验-良好的终端个数。体验良好的标准为，丢包率大于等于3%且小于5%。 10 exprBetter int32 [0-2147483647] - 体验-优的终端个数。体验优的标准为，丢包率小于3%。 10 speedBad int32 [0-2147483647] - 速度-慢的终端个数。速度慢的标准为，速度小于11Mbps。 10 speedGood int32 [0-2147483647] - 速度-中的终端个数。速度中的标准为，速度大于等于11Mbps且小于等于54Mbps。 10 speedBetter int32 [0-2147483647] - 速度-快的终端个数。速度快的标准为，速度大于54Mbps。 10 oneHour int32 [0-2147483647] - 在线一小时的终端数。 100 oneToTwoHour int32 [0-2147483647] - 在线一至二小时的终端数。 100 twoToFourHour int32 [0-2147483647] - 在线二至四小时的终端数。 100 fourToSixHour int32 [0-2147483647] - 在线四至六小时的终端数。 100 sixToEightHour int32 [0-2147483647] - 在线六至八小时的终端数。 100 eightHour int32 [0-2147483647] - 在线八小时以上的终端数。 100 返回状态码为400：参数错误，查询失败。 详细信息请参见实际响应消息体。