华为云用户手册

响应示例 返回状态码为200：站点内修改AP无线安全配置成功后的消息返回体。 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" : { "securityLevel" : "Off", "illegalDeviceDetect" : { "illegalDeviceDetect" : false, "macWhiteList" : [ "XX:XX:XX:XX:XX:XX" ], "ouiSsidMatch" : "both", "ouiWhiteList" : [ "02:02:00" ], "ssidWhiteList" : [ "abc" ] }, "manualContainDevice" : { "manualContainDevice" : false, "manualContainDeviceList" : [ "XX:XX:XX:XX:XX:XX" ] }, "spoofAPContain" : { "spoofAPContain" : false, "spoofingSSIDRuleList" : [ "abc" ] }, "terminalProtection" : { "terminalProtection" : false, "protectTerminalMACList" : [ "XX:XX:XX:XX:XX:XX" ] }, "bruteForceAttackDetect" : { "bruteForceAttackDetect" : false, "bruteForceThreshold" : 20, "bruteForceInterval" : 60 }, "spoofAttackDetect" : false, "floodAttackDetect" : false, "weakIvDetect" : false, "dynamicBlackListDefense" : false, "adhocContain" : false, "openDeviceContain" : 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

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/security/domain-set 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 { "domainSetInfo" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.com" ] } ] }

响应示例 返回状态码为201：创建成功，响应体参考DomainSetResponse。 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" : "", "processInstanceId" : "", "success" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.com" ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.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的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dns:dns 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-dns:dns" : { "enable-dns" : false, "dnsv4" : [ { "dnsv4-ip" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "ipv4-source" : [ { "ipv4-source-addr" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "hostv4" : [ { "host" : "example.com", "address" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "dns-relay" : { "enable-relay" : false, "local-ip" : [ { "ip-address" : "10.1.0.0", "vpn-name" : "vpn1" } ] }, "dns-proxy" : { "enable-proxy" : false, "forward-any-response" : false }, "proxy-client-src-ip" : [ { "address" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "dnsv6" : [ { "dnsv6-ip" : "fc00::/7", "vpn-instance" : "vpn1", "if-name" : "GE0/0/0" } ], "ipv6-source" : [ { "ipv6-source-addr" : "fc00::/7", "vpn-instance" : "vpn1" } ] } }

响应示例 返回状态码为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-dns:dns 是 REFERENCE 详细请参见表4。 DNS配置。 - 表4 dns-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dns:dns 否 REFERENCE 详细请参见表5。 DNS配置。 - 表5 dns-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable-dns 否 boolean true false - 使能DNS。AR6700V子设备不支持。 false dnsv4 否 ARRAY_REFERENCE 0-6个列表项，详细请参见表6。 DNS服务器。AR6700V主设备不支持。 - ipv4-source 否 ARRAY_REFERENCE 详细请参见表7。 服务器互通IPv4源地址。AR6700V主设备不支持。 - hostv4 否 ARRAY_REFERENCE 详细请参见表8。 IPv4主机。AR6700V主设备不支持。 - dns-relay 否 REFERENCE 详细请参见表9。 DNS中继。AR6700V主设备和AR6700V子设备不支持。 - dns-proxy 否 REFERENCE 详细请参见表11。 DNS代理。AR6700V子设备不支持。 - proxy-client-src-ip 否 ARRAY_REFERENCE 详细请参见表12。 客户端互通IPv4源地址。AR6700V主设备不支持。 - dnsv6 否 ARRAY_REFERENCE 0-6个列表项，详细请参见表13。 DNSv6服务器。AR6700V主设备，AR6700V子设备和AR6700V-L设备不支持。 - ipv6-source 否 ARRAY_REFERENCE 详细请参见表14。 服务器互通IPv6源地址。AR6700V主设备，AR6700V子设备和AR6700V-L设备不支持。 - 表6 dns-dnsv4-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 dnsv4-ip 否 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])(%[\p{N}\p{L}]+)?。 - DNS服务器IP（最多6个），联合主键字段。 "192.168.1.1" vpn-instance 否 string 1~31个字符。 - 绑定VPN实例，联合主键字段。 "vpn1" 表7 dns-ipv4-source-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv4-source-addr 否 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])(%[\p{N}\p{L}]+)?。 - 互通IPv4源地址，单一主键字段。 "192.168.1.1" vpn-instance 否 string 1~31个字符。 - 绑定VPN实例。 "vpn1" 表8 dns-hostv4-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 host 否 string 1~255个字符。 - 主机名，联合主键字段。 "example.com" address 否 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])(%[\p{N}\p{L}]+)?。 - 主机地址。 "192.168.1.1" vpn-instance 否 string 1~31个字符。 - 绑定VPN实例，联合主键字段。 "vpn1" 表9 dns-relay-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable-relay 否 boolean true false - 使能DNS中继。 false local-ip 否 ARRAY_REFERENCE 0-10个列表项，详细请参见表10。 配置IPv4本地地址。 - 表10 dns-relay-local-ip-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ip-address 是 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])(%[\p{N}\p{L}]+)?。 - IPv4地址，联合主键字段。 "10.1.0.0" vpn-name 是 string 1~31个字符。 - VPN实例，联合主键字段。 "vpn1" 表11 dns-proxy-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable-proxy 否 boolean true false - 使能DNS代理。 false forward-any-response 否 boolean true false - 使能转发所有响应。AR6700V主设备不支持。 false 表12 dns-proxy-client-src-ip-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 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])(%[\p{N}\p{L}]+)?。 - 互通IPv4源地址，联合主键字段。 "192.168.1.1" vpn-instance 否 string 1~31个字符。 - VPN实例，联合主键字段。 "vpn1" 表13 dns-dnsv6-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 dnsv6-ip 否 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - DNSv6服务器IP（最多6个），联合主键字段。 "fc00::/7" vpn-instance 否 string 1~31个字符。 - 绑定VPN实例，联合主键字段。 "vpn1" if-name 否 string 1~63个字符。 - 绑定源接口，联合主键字段。 "GE0/0/0" 表14 dns-ipv6-source-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6-source-addr 否 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 互通IPv6源地址，单一主键字段。 "fc00::/7" vpn-instance 否 string 1~31个字符。 - 绑定VPN实例。 "vpn1"

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

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nqa:nqa/TestName 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"

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

响应示例 返回状态码为201：创建虚拟探测任务成功，响应体参考虚拟TaskResponse。 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" : "The device does not exist.", "data" : { "interfaceName" : "interface0/0/0", "pairaStatus" : "pairaStatus", "pairbStatus" : "pairbStatus", "paircStatus" : "paircStatus", "pairdStatus" : "pairdStatus", "pairaLength" : "length", "pairbLength" : "length", "paircLength" : "length", "pairdLength" : "length" } } 返回状态码为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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vctInputModel 是 REFERENCE 详细请参见表2。 虚拟探测下发模型 - 表2 VctDiagnoseModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID，UUID格式。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" interfaceName 否 string 1~253个字符。 - 设备接口名称。注：字段interfaceName为必传参数。 "interxxx"

请求示例 HTTP的示例 POST /controller/campus/api/v1/oamservice/vct 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 { "deviceId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2", "interfaceName" : "interxxx" }

响应参数 返回状态码为201：创建虚拟探测任务成功，响应体参考虚拟TaskResponse。 表3 VctTaskResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "The device does not exist." data REFERENCE 详细请参见表4。 虚拟探测任务返回结果 - 表4 VctResponseModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceName string 1~64个字符。 - 虚拟探测任务ID，格式UUID。 "interface0/0/0" pairaStatus string 1~64个字符。 - paira状态。 "pairaStatus" pairbStatus string 1~64个字符。 - pairb状态。 "pairbStatus" paircStatus string 1~64个字符。 - pairc状态。 "paircStatus" pairdStatus string 1~64个字符。 - paird状态。 "pairdStatus" pairaLength string 1~64个字符。 - paira长度。 "length" pairbLength string 1~64个字符。 - pairb长度。 "length" paircLength string 1~64个字符。 - pairc长度。 "length" pairdLength string 1~64个字符。 - paird长度。 "length" 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误，无响应体。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 connectPortInfos 是 REFERENCE 详细请参见表2。 更新站点连接源端口 - 表2 SiteConnectPortConfigInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 connectPortInfos 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 连接源端口列表 - 表3 SiteConnectPortConfig对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string - - 站点ID，uuid格式。 "00000000-0000-0000-0000-000000000000" connectPortEnable 否 boolean true false - 连接源端口开关，默认为false。 true srcPort 否 int32 [4501-65535] - 连接源端口号动态扫描起始端口。 4501 portNum 否 int32 [0-3] - 连接源端口号动态扫描次数。 0 portStep 否 int32 [0-10] - 连接源端口号动态扫描步长。 10

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/site/connect-port 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 { "connectPortInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "connectPortEnable" : true, "srcPort" : 4501, "portNum" : 0, "portStep" : 10 } ] }

响应参数 返回状态码为200：接口调用成功，响应体参考SiteConnectPortResponse。 表4 SiteConnectPortResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码，0表示成功，非0表示失败。 "0" errmsg string 0~256个字符。 - 错误信息 - data REFERENCE 详细请参见表3。 连接源端口列表 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考SiteConnectPortResponse。 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" : { "connectPortInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "connectPortEnable" : true, "srcPort" : 4501, "portNum" : 0, "portStep" : 10 } ] } } 返回状态码为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：查询成功，响应体参考QueryCentralizedAccessPolicyResponse。 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, "data" : [ { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : 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

响应参数 返回状态码为200：查询成功，响应体参考QueryCentralizedAccessPolicyResponse。 表2 QueryCentralizedAccessPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。 站点集中地上网策略信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access/batch 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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 AlarmInfoInput 否 REFERENCE 详细请参见表2。 告警信息查询入参。 - 表2 AlarmInfoInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 alarmDefKeyList 否 ARRAY_REFERENCE 1-200个列表项，详细请参见表3。 告警定义信息关键字列表 - pageIndex 否 int32 [1-100] - 查询起始记录位置。 1 pageSize 否 int32 [1-200] - 查询数据页大小。 200

响应示例 返回状态码为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" : "error", "pageIndex" : 1, "pageSize" : 100, "total" : 100, "alarmDefList" : [ { "alarmId" : "", "alarmGroupId" : "", "alarmName" : "", "alarmLevel" : "" } ] } 返回状态码为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 /v1/perfservice/alarms/shield-alarms/alarmInfo-list 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 { "alarmDefKeyList" : [ { "alarmId" : "1345678", "alarmGroupId" : "1345678" } ], "pageIndex" : 1, "pageSize" : 200 }

响应参数 返回状态码为200：查询返回的逃生模板信息。 表2 QueryEscapeResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords integer - - 查询匹配到的逃生模板总数。 1 pageIndex integer - - 分页查询，起始值。 0 pageSize integer - - 分页查询，每页数量。 20 data ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 返回的逃生模板记录信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : "", "totalRecords" : 1, "pageIndex" : 0, "pageSize" : 20, "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "ESCAPETemplate1", "vlanId" : 1, "description" : "ESCAPETemplate1", "securityGroupId" : "4f350825-919c-47b7-b853-f51f15912396", "ipv4RuleList" : [ { "protocol" : "tcp", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "description" : "Rule1" } ], "ipv6RuleList" : [{"protocol":"tcp","dstIp":"FC00::01/7","dstPort":"24","description":"Rule1"}] } ] } 返回状态码为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/v3/profile/escape?pageIndex=10&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：创建SD-WAN Wlan子网返回体。 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 { "errparams" : [ "siteId" ], "errcode" : "0", "errmsg" : "" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 创建SD-WAN Wlan子网参数体。 - 表2 Wlans对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid 0~36个字符。 - vpn id标识，创建或修改时必填。 "00000000-0000-0000-0000-000000000000" siteId 否 uuid 0~36个字符。 - 站点id标识，创建或修改时必填。 "00000000-0000-0000-0000-000000000000" subnets 否 ARRAY_REFERENCE 0-10000个列表项，详细请参见表3。 站点Wlan子网配置基本数据。 - 表3 Wlan对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid 0~36个字符。 - 子网附着的VPN ID，创建或修改时必填。 "00000000-0000-0000-0000-000000000000" siteId 是 uuid 0~36个字符。 - 子网附着的站点ID，创建或修改时必填。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid 0~36个字符。 - 设备ID，创建或修改时必填。 "00000000-0000-0000-0000-000000000000" deviceName 否 string 0~256个字符。 - 设备名称。 "device1" id 否 uuid 0~36个字符。 - 子网ID，用来识别更新还是增加的关键元素，修改时必填。 "00000000-0000-0000-0000-000000000000" ssid 否 string 1~32个字符。 - 可输入的字符串长度为1～32字符,不能包含问号,双引号不能出现在字符甲的首尾，不支持中文字符，创建或修改时必填。 "接入描述。" effectiveRadio 否 string RADIO_2.4GHZ RADIO_5GHZ RADIO_2.4GHZ radio类型，创建或修改时必填。取值范围：RADIO_2.4GHZ、RADIO_5GHZ "RADIO_2.4GHZ" vlanId 否 string 0~32个字符。 - 子网vlan id，需提前创建vlan，创建或修改时必填。 "100" encryptionMethod 否 string WPA1 WPA2 WPA1 认证模式，创建或修改时必填。取值范围：WPA1、WPA2 "WPA1" sharedKey 否 string 0~63个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 密码，创建时必填。PSK必须包含如下规则：PSK长度必须在8-63位。PSK必须满足复杂度，即必须包含特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）、数字（0~9）中的任意两种组合。 "Example@123" hideSsid 否 boolean true false false 是否启用隐藏ssid。 false maxAccessNum 否 string 0~4个字符。 - SSID能接入的最大用户数，创建或修改时必填。 "30" downLinkTraffic 否 string 0~32个字符。 - 下行链路流量带宽限制，创建或修改时必填。 "1200" upLinkTraffic 否 string 0~32个字符。 - 上行链路流量带宽限制，创建或修改时必填。 "1400" enableRadioConfig 否 boolean true false false 是否启用dns。 false transmitPower 否 string 0~12个字符。 - 功率等级。 "1" countryCode 否 string 1~32个字符。 - 国家码。 "CN" channelBandwidth 否 string 20mhz 40mhz-minus 40mhz-plus 80mhz 160mhz 20mhz 信道带宽。取值范围：20mhz、40mhz-minus、40mhz-plus、80mhz "20mhz" channel 否 string 0~12个字符。 - 信道，根据信道带宽这个值也不一样。 "1" enableWlan 否 boolean true false true 是否开启wlan true

请求示例 HTTP的示例 POST /controller/campus/ui/v1/sdwan/lan/wlans 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 { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "subnets" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "id" : "00000000-0000-0000-0000-000000000000", "ssid" : "接入描述。", "effectiveRadio" : "RADIO_2.4GHZ", "vlanId" : "100", "encryptionMethod" : "WPA1", "sharedKey" : "Example@123", "hideSsid" : false, "maxAccessNum" : "30", "downLinkTraffic" : "1200", "upLinkTraffic" : "1400", "enableRadioConfig" : false, "transmitPower" : "1", "countryCode" : "CN", "channelBandwidth" : "20mhz", "channel" : "1", "enableWlan" : true } ] }

响应示例 返回状态码为200：查询成功，响应体参考DeviceDetailsResponse。 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" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceName" : "device1", "metricDatas" : [ { "name" : "***", "value" : [ { "timestamp" : "1985-04-12T23:20:50.52Z", "value" : 50 } ] } ] } ] } 返回状态码为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