开放接口服务-HTTPS 使用说明(环境搭建)
调用本文档中的任何接口前,需先在控制器上开启开放接口服务并完成 HTTPS 参数配置,然后在第三方平台侧按要求组装请求头与请求体。
快速索引
- 一、控制器开放接口服务-HTTPS 配置(字段说明、页面路径)
- 二、第三方平台请求配置(HTTP 头部、HTTP Body)
一、控制器开放接口服务-HTTPS 配置
1.1 各字段说明
| 字段 | 是否必填 | 说明 |
|---|---|---|
| 连接协议 | 是 | 与第三方平台对接时使用的传输协议,当前仅支持 HTTPS。HTTPS 基于 HTTP 协议并加入 SSL/TLS 加密层,可保障数据传输的安全性和完整性。 |
| 通信地址 | 否 | 允许访问本网关接口的第三方平台地址。仅支持输入单个 IPv4 地址,不支持域名、端口号以及网段范围。未填写时默认放通所有第三方平台 IP 访问;填写后仅允许该 IP 访问。 |
| 通信密钥 | 是 | 用于 HTTPS 接口请求的身份验证,防止未授权访问。支持系统自动生成:点击「生成」按钮随机生成一个密钥;点击「复制」按钮将当前密钥复制到剪贴板。 |
1.2 页面配置
配置入口:平台管理 → 开放接口服务 → https,详见下图。
开放接口服务-https 配置页面
二、第三方平台请求配置
2.1 HTTP 头部信息配置
请求头至少包含以下八个字段,下表中的值仅供参考:
| 头部字段 | 参考值 |
|---|---|
| User-Agent | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/149.0.0.0 Safari/537.36 Edg/149.0.0.0 |
| Accept | */* |
| Accept-Language | zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6 |
| Accept-Encoding | gzip, deflate, br |
| Token | t7zEvrdaQFaHq0fLvQS23lXNX9T79sDo |
| Content-Type | application/json |
| X-Requested-With | XMLHttpRequest |
| Connection | keep-alive |
配置示例如下,供参考:
HTTP 头部信息配置示例
说明:
Token字段需与控制器上配置的通信密钥保持一致;其他信息以通过浏览器 F12 实际获取的为准。
2.2 HTTP Body 信息配置
此处仅给出示例配置信息,实际使用时请根据自身需求进行配置,或通过自动化代码实现。
HTTP Body 信息配置示例
在线用户接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/sys_runstat/listapusr | 查询AP在线用户列表 |
二、接口详细说明
2.1 sys_runstat_listapusr — 查询AP在线用户列表
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 listapusr |
| data | object | 是 | 查询条件对象 |
| data.start | integer | 否 | 分页起始位置(默认0) |
| data.limit | integer | 否 | 每页数量(默认50) |
| data.filter | object | 否 | 过滤条件对象 |
| data.filter.filterType | string | 否 | 过滤类型(默认"all") |
| data.filter.id | integer | 否 | 过滤ID(默认1) |
| data.filter.gid | integer | 否 | 组ID(默认-1) |
| data.filter.type | integer | 否 | 过滤类型标识(默认888) |
| data.search | string | 否 | 搜索关键字 |
| data.sort | string | 否 | 排序字段(默认"onlineTime") |
| data.direction | string | 否 | 排序方向ASC/DESC(默认"DESC") |
| data.searchValue | string | 否 | 搜索值 |
| data.is_deposit | boolean | 否 | 是否灾备用户(默认false) |
| data.deposit_branch_id | integer | 否 | 灾备分支ID |
| data.is_central_area | boolean | 否 | 是否中心区域(默认false) |
| data.branch_id | integer | 否 | 数据分支ID |
| branch_id | integer | 否 | 分支ID(默认0) |
请求示例
{
"opr": "listapusr",
"data": {
"start": 0,
"limit": 50,
"filter": {
"filterType": "all",
"id": 1,
"gid": -1,
"type": 888
},
"search": "",
"sort": "onlineTime",
"direction": "DESC",
"searchValue": "",
"is_deposit": false,
"is_central_area": false
},
"branch_id": 0
}
响应 Body
{
"success": true,
"data": [
{
"id": "user_001",
"username": "testuser",
"mac": "00:11:22:33:44:55",
"ip": "192.168.1.100",
"ap_name": "AP-01",
"ssid": "TestSSID",
"onlineTime": "2024-01-01 10:00:00",
"duration": 3600,
"signal": -50,
"health": 95,
"upload_traffic": 1024000,
"download_traffic": 2048000,
"auth_type": "portal"
}
],
"total": 1
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
| data | array | 在线用户列表数组 |
| data[].id | string | 用户记录ID |
| data[].username | string | 用户名 |
| data[].mac | string | 终端MAC地址 |
| data[].ip | string | 终端IP地址 |
| data[].ap_name | string | 接入点名称 |
| data[].ssid | string | 接入的SSID名称 |
| data[].onlineTime | string | 上线时间 |
| data[].duration | integer | 在线时长(秒) |
| data[].signal | integer | 信号强度(dBm) |
| data[].health | integer | 健康度评分 |
| data[].upload_traffic | integer | 上传流量(字节) |
| data[].download_traffic | integer | 下载流量(字节) |
| data[].auth_type | string | 认证方式 |
| total | integer | 总记录数 |
接入点状态接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/sys_runstat/listap | 查询接入点列表 |
| /index.php/sys_runstat/listAcTree | 查询接入点树结构 |
| /index.php/sys_runstat/listrf | 查询射频列表 |
二、接口详细说明
2.1 查询接入点列表
接口名称: sys_runstat_listap
接口功能说明: 查询接入点列表,支持分页、搜索、排序和过滤
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定为 listap |
| data.start | integer | 否 | 分页起始位置,默认 0 |
| data.limit | integer | 否 | 每页记录数,默认 50 |
| data.search | string | 否 | 搜索关键字(接入点名称) |
| data.sort | string | 否 | 排序字段,如 status |
| data.filter | object | 是 | 过滤条件对象 |
| data.filter.filterType | string | 是 | 过滤类型,如 all |
| data.filter.id | integer | 是 | 过滤ID |
| data.filter.gid | integer | 是 | 组ID,-1 表示所有 |
| data.filter.type | string | 是 | 类型,如 branch |
| data.direction | string | 否 | 排序方向,ASC 或 DESC |
| data.is_central | boolean | 否 | 是否中心模式 |
| data.is_new_version | boolean | 否 | 是否新版本 |
| branch_id | integer | 是 | 分支ID |
请求示例
{
"opr": "listap",
"data": {
"start": 0,
"limit": 50,
"search": "test_ap",
"sort": "status",
"filter": {
"filterType": "all",
"id": 0,
"gid": -1,
"type": "branch"
},
"direction": "DESC",
"is_central": true,
"branch_id": 0,
"is_new_version": true
},
"branch_id": 0
}
响应 Body
{
"data": [
{
"id": "4822678189178880",
"group_id": 0,
"local_id": "0",
"name": "test_ap",
"group": "/所有区域/默认组",
"ip": "-",
"is_ipv6_tunnel": false,
"usercount": "-",
"send": "-",
"recv": "-",
"joinTime": "-",
"offlineTime": "-",
"status": 2,
"alarm_time": 0,
"workmodel": "-",
"position": "-",
"model": "RG-AP880-I",
"version": "-",
"led": "-",
"power": "-",
"type": "-",
"mac": "00:00:00:00:00:00",
"sn": "test_sn_123",
"is_cloud": false,
"is_deposit": true,
"is_central_auth": false,
"ap_pkg": null,
"port_id": null,
"is_ap_pkg": false,
"sw_stat": 0,
"switch_if_name": null,
"ap_deploy": "普通模式",
"is_gw_vap": false,
"usb_status": {
"usb_config": 0,
"usb_status_cache": 0,
"usb_status_bluetooth": 0,
"is_off_line": true,
"bt_device_connected": null,
"bt_device_name": null,
"bt_device_mac": null
},
"lora_usb": {
"usb_intfs_mode_e": 0,
"usb_intfs_mode": "不支持",
"usb_status_e": 0,
"usb_status": "-",
"iot_address": "-",
"iot_link_status": "-",
"ueth_alive": 0,
"ueth_ip": "-",
"ueth_mac": "-",
"ueth_mode": 0,
"vlan_id": "-",
"ueth_dnat_enable": false,
"ueth_dnat_port": "-"
},
"warn_reason": null,
"cpu_use": "0%",
"mem_use": "0%",
"eth_negotiation_rate": [],
"port": [],
"leaf": true
}
],
"onlineCount": 0,
"offlineCount": 1,
"depositCount": 0,
"centerAuthCount": 0,
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 接入点列表 |
| data[].id | string | 接入点ID |
| data[].name | string | 接入点名称 |
| data[].group | string | 所属组路径 |
| data[].ip | string | IP地址 |
| data[].status | integer | 状态:0-离线,1-在线,2-预存 |
| data[].mac | string | MAC地址 |
| data[].sn | string | 序列号 |
| data[].model | string | 型号 |
| data[].version | string | 版本 |
| data[].is_deposit | boolean | 是否预存 |
| data[].usercount | string | 用户数 |
| data[].cpu_use | string | CPU使用率 |
| data[].mem_use | string | 内存使用率 |
| onlineCount | integer | 在线数量 |
| offlineCount | integer | 离线数量 |
| depositCount | integer | 预存数量 |
| total | integer | 总数 |
| success | boolean | 操作是否成功 |
2.2 查询接入点树结构
接口名称: sys_runstat_listAcTree
接口功能说明: 查询接入点的树形结构,包括分支、组和接入点的层级关系
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定为 listAcTree |
| data.searchValue | string | 否 | 搜索值 |
| data.search | string | 否 | 搜索关键字 |
| data.start | integer | 否 | 分页起始位置 |
| data.limit | integer | 否 | 每页记录数 |
| data.sort | string | 否 | 排序字段 |
| data.filter | object | 是 | 过滤条件 |
| data.filter.filterType | string | 是 | 过滤类型 |
| data.filter.id | integer | 是 | 过滤ID |
| data.filter.gid | integer | 是 | 组ID |
| data.filter.type | string | 是 | 类型 |
| data.direction | string | 否 | 排序方向 |
| data.is_central | boolean | 否 | 是否中心模式 |
| branch_id | integer | 是 | 分支ID |
请求示例
{
"opr": "listAcTree",
"data": {
"searchValue": "",
"search": "",
"start": 0,
"limit": 50,
"sort": "status",
"filter": {
"filterType": "all",
"id": 0,
"gid": -1,
"type": "branch"
},
"direction": "DESC",
"is_central": true,
"branch_id": 0
},
"branch_id": 0
}
响应 Body
{
"data": {
"leaf": false,
"expanded": true,
"id": 1,
"pid": -1,
"text": "所有分支",
"name": "所有分支",
"deletable": false,
"is_default": true,
"type": "bgrp",
"children": [
{
"leaf": false,
"expanded": false,
"id": 0,
"pid": 1,
"text": "默认组",
"name": "默认组",
"deletable": false,
"is_default": true,
"type": "bgrp",
"children": [
{
"id": 0,
"gid": -1,
"text": "本机",
"type": "branch",
"leaf": false,
"parent_id": null,
"count": 0,
"online_cnt": 0,
"all_cnt": 1,
"is_deposit": null,
"is_area": true,
"expanded": true,
"apg_type": 2,
"branch_id": 0,
"branch_type": "wac",
"wac_type": 2,
"children": [
{
"id": 0,
"gid": 1,
"text": "默认组",
"type": "grp",
"leaf": true,
"parent_id": 1,
"count": 0,
"online_cnt": 0,
"all_cnt": 1,
"is_deposit": null,
"is_area": false,
"expanded": false,
"apg_type": 1,
"branch_id": 0,
"branch_type": "wac",
"wac_type": 2,
"cnt_no_dep": 1,
"poe_cnt_no_dep": 0
}
],
"is_branch": true,
"name": -1,
"cnt_no_dep": 1,
"poe_online_cnt": 0,
"poe_all_cnt": 0,
"poe_cnt_no_dep": 0,
"status": 1
}
]
}
]
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 树形结构根节点 |
| data.id | integer | 节点ID |
| data.text | string | 节点显示文本 |
| data.name | string | 节点名称 |
| data.type | string | 节点类型:bgrp-分支组,branch-分支,grp-组 |
| data.leaf | boolean | 是否叶子节点 |
| data.expanded | boolean | 是否展开 |
| data.children | array | 子节点列表 |
| data.children[].id | integer | 子节点ID |
| data.children[].text | string | 子节点文本 |
| data.children[].type | string | 子节点类型 |
| data.children[].count | integer | 接入点数量 |
| data.children[].online_cnt | integer | 在线数量 |
| data.children[].all_cnt | integer | 总数量 |
| data.children[].branch_id | integer | 分支ID |
| data.children[].status | integer | 状态 |
| success | boolean | 操作是否成功 |
2.3 查询射频列表
接口名称: sys_runstat_listrf
接口功能说明: 查询射频列表,支持分页、搜索、排序和高级过滤
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定为 listrf |
| data.start | integer | 否 | 分页起始位置,默认 0 |
| data.limit | integer | 否 | 每页记录数,默认 50 |
| data.search | string | 否 | 搜索关键字 |
| data.sort | string | 否 | 排序字段,如 name |
| data.filter | object | 否 | 过滤条件对象 |
| data.filter.filterType | string | 否 | 过滤类型,如 all |
| data.filter.id | integer | 否 | 过滤ID |
| data.filter.gid | integer | 否 | 组ID,-1 表示所有 |
| data.filter.type | string | 否 | 类型,如 branch |
| data.direction | string | 否 | 排序方向,ASC 或 DESC |
| data.filter_advance | object | 否 | 高级过滤条件 |
| data.filter_advance.radio_type | integer | 否 | 射频类型:1-2.4G,2-5G,3-全部 |
| data.is_central | boolean | 否 | 是否中心模式 |
| data.branch_id | integer | 否 | 数据对象中的分支ID |
| data.is_new_version | boolean | 否 | 是否新版本 |
| branch_id | integer | 否 | 分支ID |
请求示例
{
"opr": "listrf",
"data": {
"start": 0,
"limit": 50,
"search": "",
"sort": "name",
"filter": {
"filterType": "all",
"id": 0,
"gid": -1,
"type": "branch"
},
"direction": "DESC",
"filter_advance": {
"radio_type": 3
},
"is_central": true,
"branch_id": 0,
"is_new_version": true
},
"branch_id": 0
}
响应 Body
{
"data": [
{
"id": "1166271779105800192",
"mac": "10-2F-6E-01-01-2A",
"name": "302会议室",
"band": "2.4G",
"radio_type": 1,
"workInfoChannel": 6,
"wlan": 1,
"infoChannelRate": 98,
"noise": -72,
"radioPHY": "B/G/N/AX/BE",
"repeatRate": 0,
"errCodeRate": 0,
"retry_frames": 0,
"tx_frames": 0,
"send": 0,
"recv": 0,
"usercount": 0,
"ap_power": 8,
"workmodel": "normal",
"ip": "10.24.48.2",
"group": "3楼",
"band_width": 1
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 射频列表 |
| data[].id | string | 射频ID |
| data[].mac | string | AP MAC地址 |
| data[].name | string | AP名称 |
| data[].band | string | 频段:2.4G 或 5G |
| data[].radio_type | integer | 射频类型:1-2.4G,2-5G |
| data[].workInfoChannel | integer | 工作信道 |
| data[].wlan | integer | WLAN数量 |
| data[].infoChannelRate | integer | 信道利用率(百分比) |
| data[].noise | integer | 噪声(dBm) |
| data[].radioPHY | string | 射频协议 |
| data[].repeatRate | integer | 重传率 |
| data[].errCodeRate | integer | 错误码率 |
| data[].retry_frames | integer | 重传帧数 |
| data[].tx_frames | integer | 发送帧数 |
| data[].send | number | 发送速率(Mbps) |
| data[].recv | number | 接收速率(Mbps) |
| data[].usercount | integer | 用户数量 |
| data[].ap_power | integer | AP功率 |
| data[].workmodel | string | 工作模式 |
| data[].ip | string | AP IP地址 |
| data[].group | string | 所属组 |
| data[].band_width | integer | 带宽 |
| total | integer | 总数 |
| success | boolean | 操作是否成功 |
接入点管理接口
一、接口概览
| 序号 | 接口名称 | 接口路径 | 功能说明 |
|---|---|---|---|
| 1 | 接入点列表(list) | /index.php/wl_ap/list |
分页查询接入点列表(关键字/高级搜索:工作模式、信道、带宽、发射功率、WDS、硬件型号、USB模式、接入点类型、云发现、同步状态等) |
| 2 | 接入点详情(listDetail) | /index.php/wl_ap/listDetail |
查询单个接入点完整配置详情(基础信息、部署、射频信道功率、WDS、隧道、转发、DHCP、有线口等),供编辑页回填 |
| 3 | 新增普通接入点(add_normal_ap) | /index.php/wl_ap/add_normal_ap |
手动新增普通接入点(录入 MAC/SN/硬件型号并选择所属分组,可同时配置部署方式与射频参数) |
| 4 | 编辑接入点(modify) | /index.php/wl_ap/modify |
修改接入点配置(以 listDetail 回填的完整 data 为基础覆盖修改项) |
| 5 | 删除接入点(delete) | /index.php/wl_ap/delete |
删除选中的接入点记录(支持批量) |
| 6 | AP 型号列表查询 | /index.php/wl_apgroup/query_hm |
AP 型号列表查询(外部型号与内部型号映射) |
| 7 | AP 组树查询 | /index.php/wl_apgroup/query_apgroup_tree |
AP 组树查询 |
| 8 | AP 区域树查询 | /index.php/wl_apgroup/query_aparea_tree |
AP 区域树查询 |
| 9 | AP 组新增 | /index.php/wl_apgroup/add |
AP 组新增 |
| 10 | 区域新增 | /index.php/wl_apgroup/add_area |
区域新增 |
| 11 | AP 组编辑 | /index.php/wl_apgroup/modify |
AP 组编辑 |
| 12 | AP 组详情 | /index.php/wl_apgroup/listDetail |
AP 组详情 |
| 13 | 区域详情 | /index.php/wl_apgroup/listDetail_area |
区域详情 |
| 14 | 区域编辑 | /index.php/wl_apgroup/modify_area |
区域编辑 |
| 15 | AP 组/区域删除 | /index.php/wl_apgroup/delete |
AP 组/区域删除 |
| 16 | 集中管理分支列表 | /index.php/wl_apgroup/listBranch |
集中管理分支列表 |
| 17 | 接入点参数下拉列表 | /index.php/wl_apgrp_params/list_brief |
接入点参数下拉列表 |
| 18 | AP信道调整 | /index.php/wl_ap/channelmodify |
修改AP射频信道、带宽、发射功率 |
二、接口详细说明
2.2 接入点列表(list)
接口功能说明: 分页查询接入点列表,支持关键字搜索与高级搜索(工作模式/信道/带宽/发射功率/WDS/硬件型号/USB模式/接入点类型/云发现/同步状态等)
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| branch_id | integer | 否 | 分支 ID,中心端为 0(分权分支场景使用)(NAC默认填:0) | - | - |
| direction | string | 否 | 排序方向:ASC/DESC(样本:ASC) | - | - |
| filter | object | 否 | 过滤条件对象 | - | - |
| limit | integer | 否 | 每页条数(样本:50) | - | - |
| opr | string | 否 | list | - | - |
| search | string | 否 | 搜索关键字(名称/MAC/SN/IP 等模糊匹配)(样本:real_370 / ap2) | - | - |
| sort | string | 否 | 排序字段,默认 name(样本:name) | - | - |
| start | integer | 否 | 分页起始行(样本:0) | - | - |
| filter.advanced_search | object | 否 | 高级搜索条件对象 | - | - |
| filter.id | integer | 是 | 当前选中的接入点分组节点 ID(列表按分组过滤;0=全部) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].children[].id |
| filter.advanced_search.ap_type | string | 否 | 接入点类型筛选(样本 relay=中继模式,any=全部) | - | - |
| filter.advanced_search.bandwidth | string | 否 | 信道带宽筛选(any=全部,20M/40M/80M…) | - | - |
| filter.advanced_search.channel | string | 否 | 信道配置筛选(manual=手动指定,auto=自动,any=全部) | - | - |
| filter.advanced_search.dev_yun_find | string | 否 | 云发现开关筛选(disable=未开启,enable=已开启,any=全部) | - | - |
| filter.advanced_search.hardmodel | string | 否 | 硬件型号筛选(如 uap-620-p-v4) | - | - |
| filter.advanced_search.mode | string | 否 | 射频工作模式筛选(monitor=监听模式,12=AP模式…) | - | - |
| filter.advanced_search.switch | string | 否 | 所接交换机筛选 | - | - |
| filter.advanced_search.sync_status | string | 否 | 配置同步状态筛选(all=全部) | - | - |
| filter.advanced_search.txpower | string | 否 | 发射功率筛选(manual=手动指定,any=全部) | - | - |
| filter.advanced_search.usbmode | string | 否 | USB模式筛选(unsupported=不支持) | - | - |
| filter.advanced_search.wds | integer | 否 | WDS 筛选(0=非WDS,1=WDS) | - | - |
| filter.advanced_search.wds_type | string | 否 | WDS 类型筛选(any=全部,root=根,client=客户端) | - | - |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"filter": {
"id": 1
},
"branch_id": 0,
"sort": "name",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"id": "1166271779105800192",
"name": "302会议室",
"ip": "10.24.48.2",
"type": 0,
"mac": "9F-9B-21-F8-EC-2A",
"position": "",
"port_id": "",
"switch_name": "",
"params": "独立配置",
"pattern": "SI-WM20-AV",
"hd_alias": "wm-3827",
"software_version": "AP3.16.3 BUILD20260430-103135",
"sequenceNO": "QUZ5400050",
"sequenceNO_SN": "QUZ5400050",
"client_ap_enable": false,
"client_ap_radio": null,
"deploy": "normal",
"hardware_type": 11,
"is_new_ap": true,
"not_wds_client": false,
"poe_ap_id": null,
"sn": "QUZ5400050",
"en_yun_find": false,
"sync_status": 4,
"last_sync_time": "-",
"is_gw_vap": false,
"work_mode_ap": "normal",
"cap_ap_id": "",
"zero_interruption_type": 0,
"batch_rf_type": "wm-3827",
"wds_client_enable_rf": "",
"multi_rf": "ap-260",
"channel_rf1": {
"1": {
"channel": 0,
"bandwidth": 1,
"mode": 12,
"txpower": 8,
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel_rf2": {
"2": {
"channel": 153,
"bandwidth": 1,
"mode": 13,
"txpower": 14,
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel": "0,153",
"bandwidth": "1,1",
"txpower": "8,14",
"work_mode": {
"rf1": {
"mode": "normal"
}
},
"leaf": true
},
{
"id": "1166271779095052288",
"name": "302会议室_临时测试",
"ip": "10.24.48.10",
"type": 0,
"mac": "37-DC-2A-07-E1-06",
"position": "",
"port_id": "",
"switch_name": "",
"params": "独立配置",
"pattern": "SI-WM20",
"hd_alias": "wm-3827",
"software_version": "AP3.16.3 BUILD20260430-103135",
"sequenceNO": "QTZ5270170",
"sequenceNO_SN": "QTZ5270170",
"client_ap_enable": false,
"client_ap_radio": null,
"deploy": "normal",
"hardware_type": 11,
"is_new_ap": true,
"not_wds_client": false,
"poe_ap_id": null,
"sn": "QTZ5270170",
"en_yun_find": false,
"sync_status": 4,
"last_sync_time": "-",
"is_gw_vap": false,
"work_mode_ap": "normal",
"cap_ap_id": "",
"zero_interruption_type": 0,
"batch_rf_type": "wm-3827",
"wds_client_enable_rf": "",
"multi_rf": "ap-260",
"channel_rf1": {
"1": {
"channel": 0,
"bandwidth": 1,
"mode": 12,
"txpower": "auto",
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel_rf2": {
"2": {
"channel": 165,
"bandwidth": 1,
"mode": 13,
"txpower": "auto",
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel": "0,165",
"bandwidth": "1,1",
"txpower": "auto,auto",
"work_mode": {
"rf1": {
"mode": "normal"
}
},
"leaf": true
}
],
"total": 22,
"append": {
"isExistRF": false,
"isExistNullSn": true,
"yunFindInfo": {
"sync_err_sum": 0
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| append | object | 附加信息对象 |
| data | array[object] | 业务数据对象 |
| data[] | object | 业务数据对象 |
| success | boolean | 请求是否成功 |
| total | integer | 记录总数 |
| append.isExistNullSn | boolean | 是否存在无SN记录 |
| append.isExistRF | boolean | 是否存在射频配置 |
| append.yunFindInfo | object | 云发现信息 |
| data[].bandwidth | string | 信道带宽 |
| data[].batch_rf_type | string | 批量射频型号 |
| data[].cap_ap_id | string | 所属CAP AP ID |
| data[].channel | string | 信道 |
| data[].channel_rf1 | object | 射频1信道功率配置 |
| data[].channel_rf2 | object | 射频2信道功率配置 |
| data[].client_ap_enable | boolean | 是否启用无线客户端AP |
| data[].client_ap_radio | null | 无线客户端AP射频配置 |
| data[].deploy | string | 部署方式(normal=普通) |
| data[].en_yun_find | boolean | 是否开启云发现 |
| data[].hardware_type | integer | 硬件类型 |
| data[].hd_alias | string | 硬件型号 |
| data[].id | string | 记录唯一标识 |
| data[].ip | string | IP 地址 |
| data[].is_gw_vap | boolean | 是否网关虚拟AP |
| data[].is_new_ap | boolean | 是否新架构AP |
| data[].last_sync_time | string | 最后同步时间 |
| data[].leaf | boolean | 叶子节点标识 |
| data[].mac | string | MAC 地址 |
| data[].multi_rf | string/null | 多射频信息 |
| data[].name | string | 名称 |
| data[].not_wds_client | boolean | 是否非WDS客户端 |
| data[].params | string | 配置来源(独立配置/使用分组配置) |
| data[].pattern | string | 产品型号标识 |
| data[].poe_ap_id | null | POE供电关联AP ID |
| data[].port_id | string | 所接交换机端口ID |
| data[].position | string | 安装位置说明 |
| data[].sequenceNO | string | 序列号 |
| data[].sequenceNO_SN | string | 序列号SN |
| data[].sn | string | 设备序列号 |
| data[].software_version | string | 软件版本 |
| data[].switch_name | string | 所接交换机名称 |
| data[].sync_status | integer | 配置同步状态 |
| data[].txpower | string | 发射功率 |
| data[].type | integer | 类型 |
| data[].wds_client_enable_rf | string | WDS客户端使能射频 |
| data[].work_mode | object | 工作模式配置 |
| data[].work_mode_ap | string | AP工作模式(normal=普通) |
| data[].zero_interruption_type | integer | 零中断切换类型 |
| append.yunFindInfo.sync_err_sum | integer | 同步失败数量 |
| data[].channel_rf1.1 | object | 频段1(2.4G)配置 |
| data[].channel_rf2.2 | object | 频段2(5G)配置 |
| data[].work_mode.rf1 | object | 射频1配置 |
| data[].channel_rf1.1.advance | object | 高级配置对象 |
| data[].channel_rf1.1.bandwidth | integer | 信道带宽 |
| data[].channel_rf1.1.channel | integer | 信道 |
| data[].channel_rf1.1.enable | integer | 是否启用 |
| data[].channel_rf1.1.mode | integer | 模式 |
| data[].channel_rf1.1.txpower | integer/string | 发射功率 |
| data[].channel_rf2.2.advance | object | 高级配置对象 |
| data[].channel_rf2.2.bandwidth | integer | 信道带宽 |
| data[].channel_rf2.2.channel | integer | 信道 |
| data[].channel_rf2.2.enable | integer | 是否启用 |
| data[].channel_rf2.2.mode | integer | 模式 |
| data[].channel_rf2.2.txpower | integer/string | 发射功率 |
| data[].work_mode.rf1.mode | string | 模式 |
| data[].channel_rf1.1.advance.all_channel_list_enable | boolean | 全信道列表开关 |
| data[].channel_rf1.1.advance.power_enhance | boolean | 功率增强开关 |
| data[].channel_rf2.2.advance.all_channel_list_enable | boolean | 全信道列表开关 |
| data[].channel_rf2.2.advance.power_enhance | boolean | 功率增强开关 |
后续接口取值:接口2/3/4/5/6/7/8/9/10/11 均需此接口的行数据:
data[].id供 modify/channelmodify/listDetail/get_vap_ref 的data.id及 delete/reboot/batch_name 的data[].id、batch 的data.aps[]、move 的oldData[]取用,取值路径$.data[].id与$.data[](整行回带)
2.3 接入点详情(listDetail)
接口功能说明: 查询单个接入点的完整配置详情(含基础信息、部署、射频信道功率、WDS、隧道、转发、DHCP、有线口等),供编辑页回填
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 否 | listDetail | - | - |
| branch_id | string | 否 | 分支 ID,中心端为 0(分权分支场景使用)(NAC默认填:0) | - | - |
| data | object | 是 | 业务数据对象 | - | - |
| data.id | string | 否 | ID。字符串,允许字符:数字 0-9 和连字符 -(正则 /^[\d\-]+$/,允许前导 -、纯数字串)。(样本:14457182639815786496) |
/index.php/wl_ap/list | $.data[].id |
请求示例
{
"opr": "listDetail",
"branch_id": "0",
"data": {
"id": "14457182639815786496"
}
}
响应 Body
{
"data": {
"id": "14457182639815786496",
"name": "工位w03115_3827SR_更换Flash_EMST-F50D1G41LB",
"position": "",
"position_bak": "",
"hd_alias": "ap-3827-sr",
"pattern": "NAP-3827(SR)",
"type": 0,
"ip": null,
"mac": "7D-1D-4D-B8-9F-F8",
"software_version": "AP3.16.1 BUILD20260811-102552",
"is_new_ap": true,
"group": [
{
"id": 2,
"type": "grp",
"path": "/三楼办公环境/3楼",
"multi_rf": "ap-260"
}
],
"multi_rf": "ap-260",
"deploy": {
"select": "common",
"common": {
"enable": true,
"lan": {
"net_addr": "auto",
"auto": true,
"manual": {
"enable": false,
"gateway": null,
"ip": null,
"mgr_start_ip": null,
"mgr_end_ip": null,
"mask": null,
"fdns": null,
"sdns": null,
"vlan": null
},
"get_address": null,
"ipv4Container": {
"net_addr": "auto",
"enable": true,
"auto": true,
"manual": {
"enable": false,
"gateway": null,
"ip": null,
"mgr_start_ip": null,
"mgr_end_ip": null,
"mask": null,
"fdns": null,
"sdns": null,
"vlan": null
},
"get_address": null
},
"ipv6Container": {
"address_type": "auto",
"enable": false,
"auto": true,
"manual": {
"enable": false,
"gateway": null,
"ip": null,
"start_ip": null,
"end_ip": null,
"prefix": null,
"fdns": null,
"sdns": null
}
},
"vlan_type": {
"vlan": "eth0",
"number": null
},
"advance_mtu": {
"wan_mtu": 1500
}
}
},
"gatewayMode": {
"enable": false,
"wan": {
"net_addr": "manual",
"auto": false,
"manual": {
"enable": true,
"gateway": null,
"ip": null,
"mask": null,
"vlan": null,
"fdns": null,
"sdns": null
},
"vlan_type": {
"vlan": null,
"number": null
},
"pppoe": {
"enable": false,
"account": null,
"password": null
},
"advance_mtu": {
"wan_mtu": 1500
}
}
}
},
"advance": {
"work_mode": {
"counter_toggle": false,
"sta": false,
"rf1": {
"band": 1,
"mode": "normal"
},
"rf2": {
"band": 2,
"mode": "normal"
},
"rf3": {
"band": 2,
"mode": "normal"
},
"rf4": {
"band": 2048,
"mode": "normal"
},
"work_mode_ap": "normal",
"enable_backup_wlan": false,
"enable": false
},
"band": {
"rf1": [
{
"enable": false,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.4",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": false,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf2": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": false,
"usr_limit": 50,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": false,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf3": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf4": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"geconfig": {
"pointsmode": 0,
"rf_optimize": {
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108
}
},
"multicast_opt": {
"enable": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 90
}
},
"priority_access": {
"enable": true,
"mult": {
"signalValue": -80,
"priority_mode": 0,
"groups": []
}
}
},
"antenna_options": 1
},
"enable": false
},
"tunnel": {
"encryption": false,
"keepalive_time": 12,
"keepalive_unit": "second",
"interval_time": 2,
"interval_unit": "second",
"encript": 12,
"enable_layer2_tunnel": true,
"agent_property": 50,
"layer2_control": 12,
"enable": false
},
"wds": {
"rf1wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": "1",
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": "",
"password": "",
"bridgeRadius": "0",
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": "1",
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"rf2wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": "1",
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": "",
"password": "",
"bridgeRadius": "0",
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": "1",
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"rf3wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": 1,
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": null,
"password": null,
"bridgeRadius": 0,
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"rf4wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": 1,
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": null,
"password": null,
"bridgeRadius": 0,
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"enable": true
},
"forward": {
"auth": {
"auth_infor": 0,
"device": null,
"key": "",
"proto_type": "sangfor0.1",
"send_nopass_user": 1
},
"thirdparty": {
"enable": null
},
"usb": 1,
"manufacturer": 0,
"filter_manufacturer": false,
"bluetooth_mode": "low_power",
"bluetooth_mac": "",
"bluetooth_name": "",
"usb_volume": false,
"led_status": {
"led_switch_status": 0,
"time_groupid": null
},
"iot_gateway_s2": {
"enable": 0
},
"authpage_cache": {
"enable": 0
},
"bluetooth": {
"blue_tooth": {
"blue_tooth_fun": 0,
"uuid": "",
"major": 0,
"minor": 0
}
},
"smoke_alarm": {
"smoke_detect": 0,
"buzzing": "long",
"interleave_buz": {
"enable": false
},
"poff_tv": 0
},
"useLine": {
"use_line": 0,
"priorLine": 1,
"other_options": {
"apn": {
"apn": "",
"username": "",
"password": ""
},
"network_mode": {
"network_mode": 0
},
"pin": {
"enable": {
"enable": false,
"pin": "",
"close_pin": {
"enable": true
}
}
},
"line_check": {
"ip": "",
"interval": 15,
"fail_threshold": 3
}
}
},
"poeCensor": {
"poe_censor": 1,
"Censor_time": 10
},
"delay_shutdown": {
"delay_shutdown_1": 1,
"delay_shutdown_timeout": 300
},
"maintainReport": {
"maintainReportWrap": {
"isReport": "1",
"tcpStatistics": true
}
},
"iotp_type": "local_wac",
"iotp_username": null,
"iotp_addr": null,
"iotp_ext": null,
"switch_auth": {
"switch_auth_sw": "0"
},
"iot_kit": 1,
"auth_pass_vlan": 1,
"ueth_dnat_enable": {
"enable": false,
"ueth_ext_dnat_port": 443,
"ueth_in_dnat_port": 443
},
"ueth_data_mode": "wan_tran",
"AIEnableContainer": {
"AIEnable": 1
},
"enable": false
},
"channel_power": {
"rf1": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf2": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 1,
"channel": 40,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf3": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf4": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"enable": true
},
"apDHCP": {
"admin_account": {
"account": null,
"pwd": null
},
"subnet": [],
"port_mapping": {
"dnat_list": []
},
"nat_timestamp": false,
"enable": false
},
"choose_vers": "group_vers"
},
"lan": "disable",
"net_config": false,
"admin_account": {
"account": null,
"pwd": null
},
"wan_lan": {
"forbid_con_vlan": {
"enable": true
},
"reject_DHCP_data": {
"enable": true
},
"eth_lan_enable_poe_out": {
"enable": true
},
"wiredContainer": [
{
"port": "eth0",
"mode": "trunk",
"vlan": "1",
"nat_vlan": "1",
"vlans": "1-4094",
"type": "wan",
"speed": 2
},
{
"port": "eth1",
"mode": "trunk",
"vlan": "1",
"nat_vlan": "1",
"vlans": "1-4094",
"type": "wan",
"speed": 6
}
]
},
"wan_lan_group_config": "self",
"panelAP_eth0": {
"net": {
"select": null,
"access": {
"enable": false,
"vlan": null
},
"trunk": {
"enable": false,
"desc": null,
"nat_vlan": null,
"vlans": null,
"channel": null
},
"hybrid": {
"enable": false,
"nat_vlan": null,
"tagged_vlan": null,
"untagged_vlan": null
},
"group": {
"enable": null
}
}
},
"ap_discovery": {
"enable": false,
"controller_ip": "192.169.171.200",
"controller_domain": null,
"enableWADiscover": false,
"sequenceNO": "HNJ44902E6",
"local_ip": "192.169.171.200",
"local_backup_ip": "192.169.171.99"
},
"base_station": [],
"containment_sw": false,
"containment_nm": "",
"containment_monther": "none",
"vap_ref": "",
"vap_ref_name": "",
"train_ref": "",
"train_ref_name": "",
"cochannel_ref": "",
"cochannel_ref_name": "",
"ports": [],
"lan_of_group": "disable",
"wired_group": {
"lan_info": []
},
"branch_type": "wac",
"zero_interruption_type": 0
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 业务数据对象 |
| success | boolean | 请求是否成功 |
| data.admin_account | object | 管理员账号 |
| data.advance | object | 参数配置 |
| data.ap_discovery | object | 接入点发现 |
| data.base_station | array[object] | 接入中心基站 |
| data.branch_type | string | 分支类型 |
| data.cochannel_ref | string | 同频分组引用信息 |
| data.cochannel_ref_name | string | 同频分组引用名称 |
| data.containment_monther | string | 烟感联动月报开关 |
| data.containment_nm | string | 烟感夜间模式 |
| data.containment_sw | boolean | 烟感联动开关 |
| data.deploy | object | 部署模式组件 |
| data.group | array[object] | 所属组 |
| data.group[] | object | 所属分组 |
| data.hd_alias | string | AP别名 |
| data.id | string | 标识符 |
| data.ip | null | IP地址 |
| data.is_new_ap | boolean | 是否新接入点 |
| data.lan | string | LAN口 |
| data.lan_of_group | string | LAN口配置 |
| data.mac | string | MAC地址 |
| data.multi_rf | string | 射频型号 |
| data.name | string | AP名称 |
| data.net_config | boolean | 使用接入点上报的配置 |
| data.panelAP_eth0 | object | 面板AP eth0口配置 |
| data.pattern | string | 硬件型号 |
| data.ports | array[object] | 端口列表 |
| data.position | string | AP地理位置 |
| data.position_bak | string | AP地理位置 |
| data.software_version | string | 软件版本 |
| data.train_ref | string | 轨道列车引用信息 |
| data.train_ref_name | string | 轨道列车引用名称 |
| data.type | integer | 类型 |
| data.vap_ref | string | 虚拟AP引用信息 |
| data.vap_ref_name | string | 虚拟AP引用名称 |
| data.wan_lan | object | 接入点有线口配置 |
| data.wan_lan_group_config | string | 有线口分组配置 |
| data.wired_group | object | 有线分组配置 |
| data.zero_interruption_type | integer | 零中断切换类型 |
| data.admin_account.account | null | 账号 |
| data.admin_account.pwd | null | 密码 |
| data.advance.apDHCP | object | 子网配置 |
| data.advance.band | object | 频段 |
| data.advance.channel_power | object | 信道功率 |
| data.advance.choose_vers | string | 射频参数型号 |
| data.advance.forward | object | 其他配置 |
| data.advance.tunnel | object | 隧道参数 |
| data.advance.wds | object | 中继网桥 |
| data.advance.work_mode | object | 工作模式 |
| data.ap_discovery.controller_domain | null | 控制器域名 |
| data.ap_discovery.controller_ip | string | 控制器IP |
| data.ap_discovery.enable | boolean | 启用云发现 |
| data.ap_discovery.enableWADiscover | boolean | 启用无线发现 |
| data.ap_discovery.local_backup_ip | string | 备控制器IP/域名 |
| data.ap_discovery.local_ip | string | 主控制器IP/域名 |
| data.ap_discovery.sequenceNO | string | SN码 |
| data.deploy.common | object | 普通模式 |
| data.deploy.gatewayMode | object | 网关模式配置 |
| data.deploy.select | string | 选择值 |
| data.group[].id | integer | 标识符 |
| data.group[].multi_rf | string | 射频型号 |
| data.group[].path | string | 所属分组路径 |
| data.group[].type | string | 类型 |
| data.panelAP_eth0.net | object | VLAN配置 |
| data.wan_lan.eth_lan_enable_poe_out | object | LAN口 POE 输出配置 |
| data.wan_lan.forbid_con_vlan | object | 禁止互通VLAN |
| data.wan_lan.reject_DHCP_data | object | 拒绝DHCP数据开关 |
| data.wan_lan.wiredContainer | array[object] | 接口 |
| data.wan_lan.wiredContainer[] | object | 有线口容器 |
| data.wired_group.lan_info | array[object] | LAN口信息列表 |
| data.advance.apDHCP.admin_account | object | 管理员账号 |
| data.advance.apDHCP.enable | boolean | 是否启用 |
| data.advance.apDHCP.nat_timestamp | boolean | NAT时去掉TCP时间戳 |
| data.advance.apDHCP.port_mapping | object | 端口映射 |
| data.advance.apDHCP.subnet | array[object] | 子网配置 |
| data.advance.band.enable | boolean | 是否启用 |
| data.advance.band.geconfig | object | 功能配置 |
| data.advance.band.rf1 | array[object] | 射频1 |
| data.advance.band.rf1[] | object | 射频1配置 |
| data.advance.band.rf2 | array[object] | 射频2 |
| data.advance.band.rf2[] | object | 射频2配置 |
| data.advance.band.rf3 | array[object] | 射频3 |
| data.advance.band.rf3[] | object | 射频3配置 |
| data.advance.band.rf4 | array[object] | 射频4 |
| data.advance.band.rf4[] | object | 射频4配置 |
| data.advance.channel_power.enable | boolean | 是否启用 |
| data.advance.channel_power.rf1 | array[object] | 射频1 |
| data.advance.channel_power.rf1[] | object | 射频1配置 |
| data.advance.channel_power.rf2 | array[object] | 射频2 |
| data.advance.channel_power.rf2[] | object | 射频2配置 |
| data.advance.channel_power.rf3 | array[object] | 射频3 |
| data.advance.channel_power.rf3[] | object | 射频3配置 |
| data.advance.channel_power.rf4 | array[object] | 射频4 |
| data.advance.channel_power.rf4[] | object | 射频4配置 |
| data.advance.forward.AIEnableContainer | object | 安视射频 |
| data.advance.forward.auth | object | 认证信息转发 |
| data.advance.forward.auth_pass_vlan | integer | 网络设备VLAN |
| data.advance.forward.authpage_cache | object | 认证页面缓存 |
| data.advance.forward.bluetooth | object | 蓝牙模块 |
| data.advance.forward.bluetooth_mac | string | 蓝牙音箱MAC地址 |
| data.advance.forward.bluetooth_mode | string | 蓝牙模式 |
| data.advance.forward.bluetooth_name | string | 蓝牙音箱名称 |
| data.advance.forward.delay_shutdown | object | 延迟时间 |
| data.advance.forward.enable | boolean | 是否启用 |
| data.advance.forward.filter_manufacturer | boolean | 指定厂商ID |
| data.advance.forward.iot_gateway_s2 | object | 物联网网关S2 |
| data.advance.forward.iot_kit | integer | IOT_KIT |
| data.advance.forward.iotp_addr | null | 平台地址 |
| data.advance.forward.iotp_ext | null | 扩展字段 |
| data.advance.forward.iotp_type | string | 接入类型 |
| data.advance.forward.iotp_username | null | 用户名 |
| data.advance.forward.led_status | object | 设备灯控制 |
| data.advance.forward.maintainReport | object | 维护上报配置 |
| data.advance.forward.manufacturer | integer | 指定厂商ID |
| data.advance.forward.poeCensor | object | 上联口链路检查 |
| data.advance.forward.smoke_alarm | object | 烟感模块 |
| data.advance.forward.switch_auth | object | 交换机认证功能 |
| data.advance.forward.thirdparty | object | 无线信息采集 |
| data.advance.forward.ueth_data_mode | string | 网络数据转发模式 |
| data.advance.forward.ueth_dnat_enable | object | 端口映射 |
| data.advance.forward.usb | integer | USB设备工作模式 |
| data.advance.forward.usb_volume | boolean | USB缓存容量 |
| data.advance.forward.useLine | object | 2/3/4G线路 |
| data.advance.tunnel.agent_property | integer | 代理优先级 |
| data.advance.tunnel.enable | boolean | 是否启用 |
| data.advance.tunnel.enable_layer2_tunnel | boolean | 启用二层隧道代理功能 |
| data.advance.tunnel.encript | integer | 数据隧道保活时间 |
| data.advance.tunnel.encryption | boolean | 加密数据隧道 |
| data.advance.tunnel.interval_time | integer | 控制隧道心跳间隔时间 |
| data.advance.tunnel.interval_unit | string | 控制隧道心跳间隔时间单位 |
| data.advance.tunnel.keepalive_time | integer | 控制隧道保活时间 |
| data.advance.tunnel.keepalive_unit | string | 控制隧道保活时间单位 |
| data.advance.tunnel.layer2_control | integer | 二层隧道保活时间 |
| data.advance.wds.enable | boolean | 是否启用 |
| data.advance.wds.rf1wdsRootCheck | object | 射频1 |
| data.advance.wds.rf2wdsRootCheck | object | 射频2 |
| data.advance.wds.rf3wdsRootCheck | object | 射频3 |
| data.advance.wds.rf4wdsRootCheck | object | 射频4 |
| data.advance.work_mode.counter_toggle | boolean | 开启反制功能 |
| data.advance.work_mode.enable | boolean | 是否启用 |
| data.advance.work_mode.enable_backup_wlan | boolean | 网络备份 |
| data.advance.work_mode.rf1 | object | 射频1 |
| data.advance.work_mode.rf2 | object | 射频2 |
| data.advance.work_mode.rf3 | object | 射频3 |
| data.advance.work_mode.rf4 | object | 射频4 |
| data.advance.work_mode.sta | boolean | 启用STA检测 |
| data.advance.work_mode.work_mode_ap | string | 工作模式 |
| data.deploy.common.enable | boolean | 是否启用 |
| data.deploy.common.lan | object | LAN口 |
| data.deploy.gatewayMode.enable | boolean | 是否启用 |
| data.deploy.gatewayMode.wan | object | WAN口 |
| data.panelAP_eth0.net.access | object | Access |
| data.panelAP_eth0.net.group | object | 所属分组 |
| data.panelAP_eth0.net.hybrid | object | Hybrid |
| data.panelAP_eth0.net.select | null | SSID |
| data.panelAP_eth0.net.trunk | object | Trunk |
| data.wan_lan.eth_lan_enable_poe_out.enable | boolean | 是否启用 |
| data.wan_lan.forbid_con_vlan.enable | boolean | 是否启用 |
| data.wan_lan.reject_DHCP_data.enable | boolean | 是否启用 |
| data.wan_lan.wiredContainer[].mode | string | 模式 |
| data.wan_lan.wiredContainer[].nat_vlan | string | NAT VLAN |
| data.wan_lan.wiredContainer[].port | string | 端口 |
| data.wan_lan.wiredContainer[].speed | integer | 速率 |
| data.wan_lan.wiredContainer[].type | string | 类型 |
| data.wan_lan.wiredContainer[].vlan | string | VLAN ID |
| data.wan_lan.wiredContainer[].vlans | string | VLAN 列表 |
| data.advance.apDHCP.admin_account.account | null | 账号 |
| data.advance.apDHCP.admin_account.pwd | null | 密码 |
| data.advance.apDHCP.port_mapping.dnat_list | array[object] | 端口映射 |
| data.advance.band.geconfig.antenna_options | integer | 天线选项 |
| data.advance.band.geconfig.pointsmode | integer | 功分模式 |
| data.advance.band.geconfig.rf_optimize | object | 射频优化 |
| data.advance.band.rf1[].advance | object | 高级配置对象 |
| data.advance.band.rf1[].beacon_rate | string | 信标速率 |
| data.advance.band.rf1[].client_limit | string | 客户端数量限制 |
| data.advance.band.rf1[].client_speed_specify | object | 终端限速指定值 |
| data.advance.band.rf1[].enable | boolean | 是否启用 |
| data.advance.band.rf1[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.band.rf1[].mimo | array[object] | MIMO 收发配置 |
| data.advance.band.rf1[].mimo_type | integer | MIMO 类型 |
| data.advance.band.rf1[].mimo[] | object | MIMO 收发配置 |
| data.advance.band.rf1[].none | boolean | 不限 |
| data.advance.band.rf1[].probe | object | 探测响应配置对象 |
| data.advance.band.rf1[].rate_min | integer | 最低速率 |
| data.advance.band.rf1[].usr_limit | integer | 用户数上限 |
| data.advance.band.rf2[].advance | object | 高级配置对象 |
| data.advance.band.rf2[].beacon_rate | string | 信标速率 |
| data.advance.band.rf2[].client_limit | string | 客户端数量限制 |
| data.advance.band.rf2[].client_speed_specify | object | 终端限速指定值 |
| data.advance.band.rf2[].enable | boolean | 是否启用 |
| data.advance.band.rf2[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.band.rf2[].mimo | array[object] | MIMO 收发配置 |
| data.advance.band.rf2[].mimo_type | integer | MIMO 类型 |
| data.advance.band.rf2[].mimo[] | object | MIMO 收发配置 |
| data.advance.band.rf2[].none | boolean | 不限 |
| data.advance.band.rf2[].probe | object | 探测响应配置对象 |
| data.advance.band.rf2[].rate_min | integer | 最低速率 |
| data.advance.band.rf2[].usr_limit | integer | 用户数上限 |
| data.advance.band.rf3[].advance | object | 高级配置对象 |
| data.advance.band.rf3[].beacon_rate | string | 信标速率 |
| data.advance.band.rf3[].client_limit | string | 客户端数量限制 |
| data.advance.band.rf3[].client_speed_specify | object | 终端限速指定值 |
| data.advance.band.rf3[].enable | boolean | 是否启用 |
| data.advance.band.rf3[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.band.rf3[].mimo | array[object] | MIMO 收发配置 |
| data.advance.band.rf3[].mimo_type | integer | MIMO 类型 |
| data.advance.band.rf3[].mimo[] | object | MIMO 收发配置 |
| data.advance.band.rf3[].none | boolean | 不限 |
| data.advance.band.rf3[].probe | object | 探测响应配置对象 |
| data.advance.band.rf3[].rate_min | integer | 最低速率 |
| data.advance.band.rf3[].usr_limit | integer | 用户数上限 |
| data.advance.band.rf4[].advance | object | 高级配置对象 |
| data.advance.band.rf4[].beacon_rate | string | 信标速率 |
| data.advance.band.rf4[].client_limit | string | 客户端数量限制 |
| data.advance.band.rf4[].client_speed_specify | object | 终端限速指定值 |
| data.advance.band.rf4[].enable | boolean | 是否启用 |
| data.advance.band.rf4[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.band.rf4[].mimo | array[object] | MIMO 收发配置 |
| data.advance.band.rf4[].mimo_type | integer | MIMO 类型 |
| data.advance.band.rf4[].mimo[] | object | MIMO 收发配置 |
| data.advance.band.rf4[].none | boolean | 不限 |
| data.advance.band.rf4[].probe | object | 探测响应配置对象 |
| data.advance.band.rf4[].rate_min | integer | 最低速率 |
| data.advance.band.rf4[].usr_limit | integer | 用户数上限 |
| data.advance.channel_power.rf1[].advance | object | 高级配置对象 |
| data.advance.channel_power.rf1[].bandwidth | integer | 信道带宽 |
| data.advance.channel_power.rf1[].channel | integer | 信道 |
| data.advance.channel_power.rf1[].enable | boolean | 是否启用 |
| data.advance.channel_power.rf1[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.channel_power.rf1[].mode | integer | 模式 |
| data.advance.channel_power.rf1[].transmit_power | object | 发射功率 |
| data.advance.channel_power.rf1[].usr_limit | integer | 用户数上限 |
| data.advance.channel_power.rf2[].advance | object | 高级配置对象 |
| data.advance.channel_power.rf2[].bandwidth | integer | 信道带宽 |
| data.advance.channel_power.rf2[].channel | integer | 信道 |
| data.advance.channel_power.rf2[].enable | boolean | 是否启用 |
| data.advance.channel_power.rf2[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.channel_power.rf2[].mode | integer | 模式 |
| data.advance.channel_power.rf2[].transmit_power | object | 发射功率 |
| data.advance.channel_power.rf2[].usr_limit | integer | 用户数上限 |
| data.advance.channel_power.rf3[].advance | object | 高级配置对象 |
| data.advance.channel_power.rf3[].bandwidth | integer | 信道带宽 |
| data.advance.channel_power.rf3[].channel | integer | 信道 |
| data.advance.channel_power.rf3[].enable | boolean | 是否启用 |
| data.advance.channel_power.rf3[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.channel_power.rf3[].mode | integer | 模式 |
| data.advance.channel_power.rf3[].transmit_power | object | 发射功率 |
| data.advance.channel_power.rf3[].usr_limit | integer | 用户数上限 |
| data.advance.channel_power.rf4[].advance | object | 高级配置对象 |
| data.advance.channel_power.rf4[].bandwidth | integer | 信道带宽 |
| data.advance.channel_power.rf4[].channel | integer | 信道 |
| data.advance.channel_power.rf4[].enable | boolean | 是否启用 |
| data.advance.channel_power.rf4[].frame_dynamic_response | boolean | 动态帧响应开关 |
| data.advance.channel_power.rf4[].mode | integer | 模式 |
| data.advance.channel_power.rf4[].transmit_power | object | 发射功率 |
| data.advance.channel_power.rf4[].usr_limit | integer | 用户数上限 |
| data.advance.forward.AIEnableContainer.AIEnable | integer | AI射频 |
| data.advance.forward.auth.auth_infor | integer | 认证信息转发 |
| data.advance.forward.auth.device | null | 认证信息转发->设备地址 |
| data.advance.forward.auth.key | string | 共享密钥 |
| data.advance.forward.auth.proto_type | string | 协议类型 |
| data.advance.forward.auth.send_nopass_user | integer | 用户信息上报 |
| data.advance.forward.authpage_cache.enable | integer | 是否启用 |
| data.advance.forward.bluetooth.blue_tooth | object | 启用蓝牙 |
| data.advance.forward.delay_shutdown.delay_shutdown_1 | integer | 延迟下电 |
| data.advance.forward.delay_shutdown.delay_shutdown_timeout | integer | 延迟时间 |
| data.advance.forward.iot_gateway_s2.enable | integer | 是否启用 |
| data.advance.forward.led_status.led_switch_status | integer | 设备灯控制 |
| data.advance.forward.led_status.time_groupid | null | 时间计划 |
| data.advance.forward.maintainReport.maintainReportWrap | object | 业务感知信息上报 |
| data.advance.forward.poeCensor.Censor_time | integer | 上联口链路不通时间上限 |
| data.advance.forward.poeCensor.poe_censor | integer | 上联口链路检查 |
| data.advance.forward.smoke_alarm.buzzing | string | 蜂鸣 |
| data.advance.forward.smoke_alarm.interleave_buz | object | 烟雾消失后停止蜂鸣 |
| data.advance.forward.smoke_alarm.poff_tv | integer | 暂停烟感探测 |
| data.advance.forward.smoke_alarm.smoke_detect | integer | 烟感探测 |
| data.advance.forward.switch_auth.switch_auth_sw | string | 交换机认证 |
| data.advance.forward.thirdparty.enable | null | 是否启用 |
| data.advance.forward.ueth_dnat_enable.enable | boolean | 是否启用 |
| data.advance.forward.ueth_dnat_enable.ueth_ext_dnat_port | integer | 外部访问端口 |
| data.advance.forward.ueth_dnat_enable.ueth_in_dnat_port | integer | 内部映射端口 |
| data.advance.forward.useLine.other_options | object | 其他选项 |
| data.advance.forward.useLine.priorLine | integer | 优先线路 |
| data.advance.forward.useLine.use_line | integer | 2/3/4G线路 |
| data.advance.wds.rf1wdsRootCheck.clientAP | object | 普通桥接(ClientAP) |
| data.advance.wds.rf1wdsRootCheck.enable | boolean | 是否启用 |
| data.advance.wds.rf1wdsRootCheck.mode | string | 桥接模式 |
| data.advance.wds.rf1wdsRootCheck.rf | string | 频段 |
| data.advance.wds.rf1wdsRootCheck.rootAP | object | 普通桥接(RootAP) |
| data.advance.wds.rf1wdsRootCheck.slowRoam | object | 慢速移动桥接 |
| data.advance.wds.rf2wdsRootCheck.clientAP | object | 普通桥接(ClientAP) |
| data.advance.wds.rf2wdsRootCheck.enable | boolean | 是否启用 |
| data.advance.wds.rf2wdsRootCheck.mode | string | 桥接模式 |
| data.advance.wds.rf2wdsRootCheck.rf | string | 频段 |
| data.advance.wds.rf2wdsRootCheck.rootAP | object | 普通桥接(RootAP) |
| data.advance.wds.rf2wdsRootCheck.slowRoam | object | 慢速移动桥接 |
| data.advance.wds.rf3wdsRootCheck.clientAP | object | 普通桥接(ClientAP) |
| data.advance.wds.rf3wdsRootCheck.enable | boolean | 是否启用 |
| data.advance.wds.rf3wdsRootCheck.mode | string | 桥接模式 |
| data.advance.wds.rf3wdsRootCheck.rf | integer | 频段 |
| data.advance.wds.rf3wdsRootCheck.rootAP | object | 普通桥接(RootAP) |
| data.advance.wds.rf3wdsRootCheck.slowRoam | object | 慢速移动桥接 |
| data.advance.wds.rf4wdsRootCheck.clientAP | object | 普通桥接(ClientAP) |
| data.advance.wds.rf4wdsRootCheck.enable | boolean | 是否启用 |
| data.advance.wds.rf4wdsRootCheck.mode | string | 桥接模式 |
| data.advance.wds.rf4wdsRootCheck.rf | integer | 频段 |
| data.advance.wds.rf4wdsRootCheck.rootAP | object | 普通桥接(RootAP) |
| data.advance.wds.rf4wdsRootCheck.slowRoam | object | 慢速移动桥接 |
| data.advance.work_mode.rf1.band | integer | 频段 |
| data.advance.work_mode.rf1.mode | string | 工作模式 |
| data.advance.work_mode.rf2.band | integer | 频段 |
| data.advance.work_mode.rf2.mode | string | 工作模式 |
| data.advance.work_mode.rf3.band | integer | 频段 |
| data.advance.work_mode.rf3.mode | string | 工作模式 |
| data.advance.work_mode.rf4.band | integer | 频段 |
| data.advance.work_mode.rf4.mode | string | 工作模式 |
| data.deploy.common.lan.advance_mtu | object | MTU 高级配置 |
| data.deploy.common.lan.auto | boolean | 自动 |
| data.deploy.common.lan.get_address | null | 地址获取方式 |
| data.deploy.common.lan.ipv4Container | object | IPv4 配置容器 |
| data.deploy.common.lan.ipv6Container | object | IPv6 配置容器 |
| data.deploy.common.lan.manual | object | 手动 |
| data.deploy.common.lan.net_addr | string | 网络地址配置 |
| data.deploy.common.lan.vlan_type | object | VLAN 类型 |
| data.deploy.gatewayMode.wan.advance_mtu | object | MTU 高级配置 |
| data.deploy.gatewayMode.wan.auto | boolean | 自动 |
| data.deploy.gatewayMode.wan.manual | object | 手动 |
| data.deploy.gatewayMode.wan.net_addr | string | 网络地址配置 |
| data.deploy.gatewayMode.wan.pppoe | object | PPPoE 配置 |
| data.deploy.gatewayMode.wan.vlan_type | object | VLAN 类型 |
| data.panelAP_eth0.net.access.enable | boolean | 是否启用 |
| data.panelAP_eth0.net.access.vlan | null | VLAN ID |
| data.panelAP_eth0.net.group.enable | null | 使用分组配置 |
| data.panelAP_eth0.net.hybrid.enable | boolean | 是否启用 |
| data.panelAP_eth0.net.hybrid.nat_vlan | null | NAT VLAN |
| data.panelAP_eth0.net.hybrid.tagged_vlan | null | Tagged VLAN |
| data.panelAP_eth0.net.hybrid.untagged_vlan | null | Untagged VLAN |
| data.panelAP_eth0.net.trunk.channel | null | 桥接信道 |
| data.panelAP_eth0.net.trunk.desc | null | 描述 |
| data.panelAP_eth0.net.trunk.enable | boolean | 是否启用 |
| data.panelAP_eth0.net.trunk.nat_vlan | null | NAT VLAN |
| data.panelAP_eth0.net.trunk.vlans | null | 3 |
| data.advance.band.geconfig.rf_optimize.multicast_opt | object | 多播优化 |
| data.advance.band.geconfig.rf_optimize.priority_access | object | 启用5G接入探测帧引导 |
| data.advance.band.geconfig.rf_optimize.probe | object | 关闭广播probe探测 |
| data.advance.band.rf1[].advance.beacon | integer | 信标间隔(ms) |
| data.advance.band.rf1[].advance.dfs | boolean | DFS 雷达检测开关 |
| data.advance.band.rf1[].advance.dtim | integer | DTIM 间隔 |
| data.advance.band.rf1[].advance.enhance_txpower | boolean | 增强发射功率 |
| data.advance.band.rf1[].advance.force_awake_sta | boolean | 强制唤醒终端开关 |
| data.advance.band.rf1[].advance.guard | boolean | 保护间隔开关 |
| data.advance.band.rf1[].advance.guard_interval | string | 保护间隔 |
| data.advance.band.rf1[].advance.long | boolean | 长前导码开关 |
| data.advance.band.rf1[].advance.mimo | integer | MIMO 收发配置 |
| data.advance.band.rf1[].advance.mpdu | boolean | MPDU 聚合开关 |
| data.advance.band.rf1[].advance.msdu | boolean | MSDU 聚合开关 |
| data.advance.band.rf1[].advance.mu_mimo | boolean | MU-MIMO 开关 |
| data.advance.band.rf1[].advance.mult | object | 5G优先选项 |
| data.advance.band.rf1[].advance.multicast_opt | boolean | 多播优化配置 |
| data.advance.band.rf1[].advance.no_over_rts | integer | 未超RTS重试次数 |
| data.advance.band.rf1[].advance.ofdma | boolean | OFDMA 开关 |
| data.advance.band.rf1[].advance.over_rts | integer | 超过RTS重试次数 |
| data.advance.band.rf1[].advance.preamble | string | 前导码类型 |
| data.advance.band.rf1[].advance.probe | boolean | 探测响应配置对象 |
| data.advance.band.rf1[].advance.rts | integer | RTS 阈值 |
| data.advance.band.rf1[].advance.short | boolean | 短前导码开关 |
| data.advance.band.rf1[].advance.slice | integer | 分片阈值 |
| data.advance.band.rf1[].advance.twt | boolean | TWT(目标唤醒时间)开关 |
| data.advance.band.rf1[].advance.uapsd_sw | boolean | UAPSD 开关 |
| data.advance.band.rf1[].client_speed_specify.enable | boolean | 是否启用 |
| data.advance.band.rf1[].client_speed_specify.specify | string | 指定值 |
| data.advance.band.rf1[].mimo[].text | string | 说明文本 |
| data.advance.band.rf1[].mimo[].value | integer | 值 |
| data.advance.band.rf1[].probe.enable | boolean | 是否启用 |
| data.advance.band.rf1[].probe.mult | object | 5G优先选项 |
| data.advance.band.rf2[].advance.beacon | integer | 信标间隔(ms) |
| data.advance.band.rf2[].advance.dfs | boolean | DFS 雷达检测开关 |
| data.advance.band.rf2[].advance.dtim | integer | DTIM 间隔 |
| data.advance.band.rf2[].advance.enhance_txpower | boolean | 增强发射功率 |
| data.advance.band.rf2[].advance.force_awake_sta | boolean | 强制唤醒终端开关 |
| data.advance.band.rf2[].advance.guard | boolean | 保护间隔开关 |
| data.advance.band.rf2[].advance.guard_interval | string | 保护间隔 |
| data.advance.band.rf2[].advance.long | boolean | 长前导码开关 |
| data.advance.band.rf2[].advance.mimo | integer | MIMO 收发配置 |
| data.advance.band.rf2[].advance.mpdu | boolean | MPDU 聚合开关 |
| data.advance.band.rf2[].advance.msdu | boolean | MSDU 聚合开关 |
| data.advance.band.rf2[].advance.mu_mimo | boolean | MU-MIMO 开关 |
| data.advance.band.rf2[].advance.mult | object | 5G优先选项 |
| data.advance.band.rf2[].advance.multicast_opt | boolean | 多播优化配置 |
| data.advance.band.rf2[].advance.no_over_rts | integer | 未超RTS重试次数 |
| data.advance.band.rf2[].advance.ofdma | boolean | OFDMA 开关 |
| data.advance.band.rf2[].advance.over_rts | integer | 超过RTS重试次数 |
| data.advance.band.rf2[].advance.preamble | string | 前导码类型 |
| data.advance.band.rf2[].advance.probe | boolean | 探测响应配置对象 |
| data.advance.band.rf2[].advance.rts | integer | RTS 阈值 |
| data.advance.band.rf2[].advance.short | boolean | 短前导码开关 |
| data.advance.band.rf2[].advance.slice | integer | 分片阈值 |
| data.advance.band.rf2[].advance.twt | boolean | TWT(目标唤醒时间)开关 |
| data.advance.band.rf2[].advance.uapsd_sw | boolean | UAPSD 开关 |
| data.advance.band.rf2[].client_speed_specify.enable | boolean | 是否启用 |
| data.advance.band.rf2[].client_speed_specify.specify | string | 指定值 |
| data.advance.band.rf2[].mimo[].text | string | 说明文本 |
| data.advance.band.rf2[].mimo[].value | integer | 值 |
| data.advance.band.rf2[].probe.enable | boolean | 是否启用 |
| data.advance.band.rf2[].probe.mult | object | 5G优先选项 |
| data.advance.band.rf3[].advance.beacon | integer | 信标间隔(ms) |
| data.advance.band.rf3[].advance.dfs | boolean | DFS 雷达检测开关 |
| data.advance.band.rf3[].advance.dtim | integer | DTIM 间隔 |
| data.advance.band.rf3[].advance.enhance_txpower | boolean | 增强发射功率 |
| data.advance.band.rf3[].advance.force_awake_sta | boolean | 强制唤醒终端开关 |
| data.advance.band.rf3[].advance.guard | boolean | 保护间隔开关 |
| data.advance.band.rf3[].advance.guard_interval | string | 保护间隔 |
| data.advance.band.rf3[].advance.long | boolean | 长前导码开关 |
| data.advance.band.rf3[].advance.mimo | integer | MIMO 收发配置 |
| data.advance.band.rf3[].advance.mpdu | boolean | MPDU 聚合开关 |
| data.advance.band.rf3[].advance.msdu | boolean | MSDU 聚合开关 |
| data.advance.band.rf3[].advance.mu_mimo | boolean | MU-MIMO 开关 |
| data.advance.band.rf3[].advance.mult | object | 5G优先选项 |
| data.advance.band.rf3[].advance.multicast_opt | boolean | 多播优化配置 |
| data.advance.band.rf3[].advance.no_over_rts | integer | 未超RTS重试次数 |
| data.advance.band.rf3[].advance.ofdma | boolean | OFDMA 开关 |
| data.advance.band.rf3[].advance.over_rts | integer | 超过RTS重试次数 |
| data.advance.band.rf3[].advance.preamble | string | 前导码类型 |
| data.advance.band.rf3[].advance.probe | boolean | 探测响应配置对象 |
| data.advance.band.rf3[].advance.rts | integer | RTS 阈值 |
| data.advance.band.rf3[].advance.short | boolean | 短前导码开关 |
| data.advance.band.rf3[].advance.slice | integer | 分片阈值 |
| data.advance.band.rf3[].advance.twt | boolean | TWT(目标唤醒时间)开关 |
| data.advance.band.rf3[].advance.uapsd_sw | boolean | UAPSD 开关 |
| data.advance.band.rf3[].client_speed_specify.enable | boolean | 是否启用 |
| data.advance.band.rf3[].client_speed_specify.specify | string | 指定值 |
| data.advance.band.rf3[].mimo[].text | string | 说明文本 |
| data.advance.band.rf3[].mimo[].value | integer | 值 |
| data.advance.band.rf3[].probe.enable | boolean | 是否启用 |
| data.advance.band.rf3[].probe.mult | object | 5G优先选项 |
| data.advance.band.rf4[].advance.beacon | integer | 信标间隔(ms) |
| data.advance.band.rf4[].advance.dfs | boolean | DFS 雷达检测开关 |
| data.advance.band.rf4[].advance.dtim | integer | DTIM 间隔 |
| data.advance.band.rf4[].advance.enhance_txpower | boolean | 增强发射功率 |
| data.advance.band.rf4[].advance.force_awake_sta | boolean | 强制唤醒终端开关 |
| data.advance.band.rf4[].advance.guard | boolean | 保护间隔开关 |
| data.advance.band.rf4[].advance.guard_interval | string | 保护间隔 |
| data.advance.band.rf4[].advance.long | boolean | 长前导码开关 |
| data.advance.band.rf4[].advance.mimo | integer | MIMO 收发配置 |
| data.advance.band.rf4[].advance.mpdu | boolean | MPDU 聚合开关 |
| data.advance.band.rf4[].advance.msdu | boolean | MSDU 聚合开关 |
| data.advance.band.rf4[].advance.mu_mimo | boolean | MU-MIMO 开关 |
| data.advance.band.rf4[].advance.mult | object | 5G优先选项 |
| data.advance.band.rf4[].advance.multicast_opt | boolean | 多播优化配置 |
| data.advance.band.rf4[].advance.no_over_rts | integer | 未超RTS重试次数 |
| data.advance.band.rf4[].advance.ofdma | boolean | OFDMA 开关 |
| data.advance.band.rf4[].advance.over_rts | integer | 超过RTS重试次数 |
| data.advance.band.rf4[].advance.preamble | string | 前导码类型 |
| data.advance.band.rf4[].advance.probe | boolean | 探测响应配置对象 |
| data.advance.band.rf4[].advance.rts | integer | RTS 阈值 |
| data.advance.band.rf4[].advance.short | boolean | 短前导码开关 |
| data.advance.band.rf4[].advance.slice | integer | 分片阈值 |
| data.advance.band.rf4[].advance.twt | boolean | TWT(目标唤醒时间)开关 |
| data.advance.band.rf4[].advance.uapsd_sw | boolean | UAPSD 开关 |
| data.advance.band.rf4[].client_speed_specify.enable | boolean | 是否启用 |
| data.advance.band.rf4[].client_speed_specify.specify | string | 指定值 |
| data.advance.band.rf4[].mimo[].text | string | 说明文本 |
| data.advance.band.rf4[].mimo[].value | integer | 值 |
| data.advance.band.rf4[].probe.enable | boolean | 是否启用 |
| data.advance.band.rf4[].probe.mult | object | 5G优先选项 |
| data.advance.channel_power.rf1[].advance.all_channel_list_enable | boolean | 全信道列表开关 |
| data.advance.channel_power.rf1[].advance.power_enhance | boolean | 功率增强开关 |
| data.advance.channel_power.rf1[].transmit_power.value | integer | 值 |
| data.advance.channel_power.rf2[].advance.all_channel_list_enable | boolean | 全信道列表开关 |
| data.advance.channel_power.rf2[].advance.power_enhance | boolean | 功率增强开关 |
| data.advance.channel_power.rf2[].transmit_power.value | integer | 值 |
| data.advance.channel_power.rf3[].advance.all_channel_list_enable | boolean | 全信道列表开关 |
| data.advance.channel_power.rf3[].advance.power_enhance | boolean | 功率增强开关 |
| data.advance.channel_power.rf3[].transmit_power.value | integer | 值 |
| data.advance.channel_power.rf4[].advance.all_channel_list_enable | boolean | 全信道列表开关 |
| data.advance.channel_power.rf4[].advance.power_enhance | boolean | 功率增强开关 |
| data.advance.channel_power.rf4[].transmit_power.value | integer | 值 |
| data.advance.forward.bluetooth.blue_tooth.blue_tooth_fun | integer | 蓝牙功能 |
| data.advance.forward.bluetooth.blue_tooth.major | integer | major |
| data.advance.forward.bluetooth.blue_tooth.minor | integer | minor |
| data.advance.forward.bluetooth.blue_tooth.uuid | string | uuid |
| data.advance.forward.maintainReport.maintainReportWrap.isReport | string | 业务感知信息上报 |
| data.advance.forward.maintainReport.maintainReportWrap.tcpStatistics | boolean | TCP质量统计 |
| data.advance.forward.smoke_alarm.interleave_buz.enable | boolean | 是否启用 |
| data.advance.forward.useLine.other_options.apn | object | APN |
| data.advance.forward.useLine.other_options.line_check | object | 链路检测 |
| data.advance.forward.useLine.other_options.network_mode | object | 网络模式 |
| data.advance.forward.useLine.other_options.pin | object | PIN码 |
| data.advance.wds.rf1wdsRootCheck.clientAP.ap | object | 桥接到指定接入点 |
| data.advance.wds.rf1wdsRootCheck.clientAP.bridgeDistance | integer | 桥接半径(米) |
| data.advance.wds.rf1wdsRootCheck.clientAP.password | null | 接入密钥 |
| data.advance.wds.rf1wdsRootCheck.clientAP.ssid | null | SSID |
| data.advance.wds.rf1wdsRootCheck.clientAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf1wdsRootCheck.clientAP.wir | object | 禁用连接频段上的无线网络 |
| data.advance.wds.rf1wdsRootCheck.rootAP.bridgeRadius | string | 桥接半径(米) |
| data.advance.wds.rf1wdsRootCheck.rootAP.hide | boolean | 隐藏SSID |
| data.advance.wds.rf1wdsRootCheck.rootAP.password | string | 接入密钥 |
| data.advance.wds.rf1wdsRootCheck.rootAP.ssid | string | SSID |
| data.advance.wds.rf1wdsRootCheck.rootAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf1wdsRootCheck.slowRoam.back_switch_val | null | 备链路漫游差值 |
| data.advance.wds.rf1wdsRootCheck.slowRoam.main_switch_val | null | 主链路切换差值 |
| data.advance.wds.rf1wdsRootCheck.slowRoam.password | null | 接入密钥 |
| data.advance.wds.rf1wdsRootCheck.slowRoam.scan_channel_list | array[object] | 桥接信道列表 |
| data.advance.wds.rf1wdsRootCheck.slowRoam.ssid | null | SSID |
| data.advance.wds.rf1wdsRootCheck.slowRoam.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf2wdsRootCheck.clientAP.ap | object | 桥接到指定接入点 |
| data.advance.wds.rf2wdsRootCheck.clientAP.bridgeDistance | integer | 桥接半径(米) |
| data.advance.wds.rf2wdsRootCheck.clientAP.password | null | 接入密钥 |
| data.advance.wds.rf2wdsRootCheck.clientAP.ssid | null | SSID |
| data.advance.wds.rf2wdsRootCheck.clientAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf2wdsRootCheck.clientAP.wir | object | 禁用连接频段上的无线网络 |
| data.advance.wds.rf2wdsRootCheck.rootAP.bridgeRadius | string | 桥接半径(米) |
| data.advance.wds.rf2wdsRootCheck.rootAP.hide | boolean | 隐藏SSID |
| data.advance.wds.rf2wdsRootCheck.rootAP.password | string | 接入密钥 |
| data.advance.wds.rf2wdsRootCheck.rootAP.ssid | string | SSID |
| data.advance.wds.rf2wdsRootCheck.rootAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf2wdsRootCheck.slowRoam.back_switch_val | null | 备链路漫游差值 |
| data.advance.wds.rf2wdsRootCheck.slowRoam.main_switch_val | null | 主链路切换差值 |
| data.advance.wds.rf2wdsRootCheck.slowRoam.password | null | 接入密钥 |
| data.advance.wds.rf2wdsRootCheck.slowRoam.scan_channel_list | array[object] | 桥接信道列表 |
| data.advance.wds.rf2wdsRootCheck.slowRoam.ssid | null | SSID |
| data.advance.wds.rf2wdsRootCheck.slowRoam.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf3wdsRootCheck.clientAP.ap | object | 桥接到指定接入点 |
| data.advance.wds.rf3wdsRootCheck.clientAP.bridgeDistance | integer | 桥接半径(米) |
| data.advance.wds.rf3wdsRootCheck.clientAP.password | null | 接入密钥 |
| data.advance.wds.rf3wdsRootCheck.clientAP.ssid | null | SSID |
| data.advance.wds.rf3wdsRootCheck.clientAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf3wdsRootCheck.clientAP.wir | object | 禁用连接频段上的无线网络 |
| data.advance.wds.rf3wdsRootCheck.rootAP.bridgeRadius | integer | 桥接半径(米) |
| data.advance.wds.rf3wdsRootCheck.rootAP.hide | boolean | 隐藏SSID |
| data.advance.wds.rf3wdsRootCheck.rootAP.password | null | 接入密钥 |
| data.advance.wds.rf3wdsRootCheck.rootAP.ssid | null | SSID |
| data.advance.wds.rf3wdsRootCheck.rootAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf3wdsRootCheck.slowRoam.back_switch_val | null | 备链路漫游差值 |
| data.advance.wds.rf3wdsRootCheck.slowRoam.main_switch_val | null | 主链路切换差值 |
| data.advance.wds.rf3wdsRootCheck.slowRoam.password | null | 接入密钥 |
| data.advance.wds.rf3wdsRootCheck.slowRoam.scan_channel_list | array[object] | 桥接信道列表 |
| data.advance.wds.rf3wdsRootCheck.slowRoam.ssid | null | SSID |
| data.advance.wds.rf3wdsRootCheck.slowRoam.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf4wdsRootCheck.clientAP.ap | object | 桥接到指定接入点 |
| data.advance.wds.rf4wdsRootCheck.clientAP.bridgeDistance | integer | 桥接半径(米) |
| data.advance.wds.rf4wdsRootCheck.clientAP.password | null | 接入密钥 |
| data.advance.wds.rf4wdsRootCheck.clientAP.ssid | null | SSID |
| data.advance.wds.rf4wdsRootCheck.clientAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf4wdsRootCheck.clientAP.wir | object | 禁用连接频段上的无线网络 |
| data.advance.wds.rf4wdsRootCheck.rootAP.bridgeRadius | integer | 桥接半径(米) |
| data.advance.wds.rf4wdsRootCheck.rootAP.hide | boolean | 隐藏SSID |
| data.advance.wds.rf4wdsRootCheck.rootAP.password | null | 接入密钥 |
| data.advance.wds.rf4wdsRootCheck.rootAP.ssid | null | SSID |
| data.advance.wds.rf4wdsRootCheck.rootAP.vlan_cfg | object | VLAN属性配置 |
| data.advance.wds.rf4wdsRootCheck.slowRoam.back_switch_val | null | 备链路漫游差值 |
| data.advance.wds.rf4wdsRootCheck.slowRoam.main_switch_val | null | 主链路切换差值 |
| data.advance.wds.rf4wdsRootCheck.slowRoam.password | null | 接入密钥 |
| data.advance.wds.rf4wdsRootCheck.slowRoam.scan_channel_list | array[object] | 桥接信道列表 |
| data.advance.wds.rf4wdsRootCheck.slowRoam.ssid | null | SSID |
| data.advance.wds.rf4wdsRootCheck.slowRoam.vlan_cfg | object | VLAN属性配置 |
| data.deploy.common.lan.advance_mtu.wan_mtu | integer | WAN口 MTU |
| data.deploy.common.lan.ipv4Container.auto | boolean | 自动 |
| data.deploy.common.lan.ipv4Container.enable | boolean | 是否启用 |
| data.deploy.common.lan.ipv4Container.get_address | null | 地址获取方式 |
| data.deploy.common.lan.ipv4Container.manual | object | 手动 |
| data.deploy.common.lan.ipv4Container.net_addr | string | 网络地址配置 |
| data.deploy.common.lan.ipv6Container.address_type | string | 地址类型 |
| data.deploy.common.lan.ipv6Container.auto | boolean | 自动 |
| data.deploy.common.lan.ipv6Container.enable | boolean | 是否启用 |
| data.deploy.common.lan.ipv6Container.manual | object | 手动 |
| data.deploy.common.lan.manual.enable | boolean | 是否启用 |
| data.deploy.common.lan.manual.fdns | null | 首选DNS |
| data.deploy.common.lan.manual.gateway | null | 网关地址 |
| data.deploy.common.lan.manual.ip | null | IP 地址 |
| data.deploy.common.lan.manual.mask | null | 子网掩码 |
| data.deploy.common.lan.manual.mgr_end_ip | null | 管理段结束IP |
| data.deploy.common.lan.manual.mgr_start_ip | null | 管理段起始IP |
| data.deploy.common.lan.manual.sdns | null | 备用DNS |
| data.deploy.common.lan.manual.vlan | null | VLAN ID |
| data.deploy.common.lan.vlan_type.number | null | 数量 |
| data.deploy.common.lan.vlan_type.vlan | string | VLAN ID |
| data.deploy.gatewayMode.wan.advance_mtu.wan_mtu | integer | WAN口 MTU |
| data.deploy.gatewayMode.wan.manual.enable | boolean | 是否启用 |
| data.deploy.gatewayMode.wan.manual.fdns | null | 首选DNS |
| data.deploy.gatewayMode.wan.manual.gateway | null | 网关地址 |
| data.deploy.gatewayMode.wan.manual.ip | null | IP 地址 |
| data.deploy.gatewayMode.wan.manual.mask | null | 子网掩码 |
| data.deploy.gatewayMode.wan.manual.sdns | null | 备用DNS |
| data.deploy.gatewayMode.wan.manual.vlan | null | VLAN ID |
| data.deploy.gatewayMode.wan.pppoe.account | null | 账号 |
| data.deploy.gatewayMode.wan.pppoe.enable | boolean | 是否启用 |
| data.deploy.gatewayMode.wan.pppoe.password | null | PPPoE 拨号密码 |
| data.deploy.gatewayMode.wan.vlan_type.number | null | 数量 |
| data.deploy.gatewayMode.wan.vlan_type.vlan | null | VLAN ID |
| data.advance.band.geconfig.rf_optimize.multicast_opt.enable | boolean | 多播优化 |
| data.advance.band.geconfig.rf_optimize.multicast_opt.mult | object | 5G优先选项 |
| data.advance.band.geconfig.rf_optimize.priority_access.enable | boolean | 启用5G接入探测帧引导 |
| data.advance.band.geconfig.rf_optimize.priority_access.mult | object | 5G优先选项 |
| data.advance.band.geconfig.rf_optimize.probe.enable | boolean | 是否启用 |
| data.advance.band.geconfig.rf_optimize.probe.mult | object | 5G优先选项 |
| data.advance.band.rf1[].advance.mult.ignore_client_enble | boolean | 忽略弱信号客户端开关 |
| data.advance.band.rf1[].advance.mult.mult_bw_flow | integer | 多播带宽限速 |
| data.advance.band.rf1[].advance.mult.mult_weight_value | integer | 多播权重值 |
| data.advance.band.rf1[].probe.mult.gao_fa_v | integer | 高频探测值 |
| data.advance.band.rf1[].probe.mult.safe_signalValue | integer | 信号强度阈值(dBm) |
| data.advance.band.rf2[].advance.mult.ignore_client_enble | boolean | 忽略弱信号客户端开关 |
| data.advance.band.rf2[].advance.mult.mult_bw_flow | integer | 多播带宽限速 |
| data.advance.band.rf2[].advance.mult.mult_weight_value | integer | 多播权重值 |
| data.advance.band.rf2[].probe.mult.gao_fa_v | integer | 高频探测值 |
| data.advance.band.rf2[].probe.mult.safe_signalValue | integer | 信号强度阈值(dBm) |
| data.advance.band.rf3[].advance.mult.ignore_client_enble | boolean | 忽略弱信号客户端开关 |
| data.advance.band.rf3[].advance.mult.mult_bw_flow | integer | 多播带宽限速 |
| data.advance.band.rf3[].advance.mult.mult_weight_value | integer | 多播权重值 |
| data.advance.band.rf3[].probe.mult.gao_fa_v | integer | 高频探测值 |
| data.advance.band.rf3[].probe.mult.safe_signalValue | integer | 信号强度阈值(dBm) |
| data.advance.band.rf4[].advance.mult.ignore_client_enble | boolean | 忽略弱信号客户端开关 |
| data.advance.band.rf4[].advance.mult.mult_bw_flow | integer | 多播带宽限速 |
| data.advance.band.rf4[].advance.mult.mult_weight_value | integer | 多播权重值 |
| data.advance.band.rf4[].probe.mult.gao_fa_v | integer | 高频探测值 |
| data.advance.band.rf4[].probe.mult.safe_signalValue | integer | 信号强度阈值(dBm) |
| data.advance.forward.useLine.other_options.apn.apn | string | apn |
| data.advance.forward.useLine.other_options.apn.password | string | password |
| data.advance.forward.useLine.other_options.apn.username | string | username |
| data.advance.forward.useLine.other_options.line_check.fail_threshold | integer | 失败次数阈值 |
| data.advance.forward.useLine.other_options.line_check.interval | integer | 检测间隔 |
| data.advance.forward.useLine.other_options.line_check.ip | string | 目标IP列表 |
| data.advance.forward.useLine.other_options.network_mode.network_mode | integer | 网络模式 |
| data.advance.forward.useLine.other_options.pin.enable | object | 开启自动解锁PIN码功能 |
| data.advance.wds.rf1wdsRootCheck.clientAP.ap.enable | boolean | 是否启用 |
| data.advance.wds.rf1wdsRootCheck.clientAP.ap.mac | string | MAC 地址 |
| data.advance.wds.rf1wdsRootCheck.clientAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf1wdsRootCheck.clientAP.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf1wdsRootCheck.clientAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf1wdsRootCheck.clientAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf1wdsRootCheck.clientAP.wir.enable | boolean | 是否启用 |
| data.advance.wds.rf1wdsRootCheck.rootAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf1wdsRootCheck.rootAP.vlan_cfg.vlan | string | VLAN ID |
| data.advance.wds.rf1wdsRootCheck.rootAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf1wdsRootCheck.rootAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf1wdsRootCheck.slowRoam.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf1wdsRootCheck.slowRoam.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf1wdsRootCheck.slowRoam.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf1wdsRootCheck.slowRoam.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf2wdsRootCheck.clientAP.ap.enable | boolean | 是否启用 |
| data.advance.wds.rf2wdsRootCheck.clientAP.ap.mac | string | MAC 地址 |
| data.advance.wds.rf2wdsRootCheck.clientAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf2wdsRootCheck.clientAP.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf2wdsRootCheck.clientAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf2wdsRootCheck.clientAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf2wdsRootCheck.clientAP.wir.enable | boolean | 是否启用 |
| data.advance.wds.rf2wdsRootCheck.rootAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf2wdsRootCheck.rootAP.vlan_cfg.vlan | string | VLAN ID |
| data.advance.wds.rf2wdsRootCheck.rootAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf2wdsRootCheck.rootAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf2wdsRootCheck.slowRoam.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf2wdsRootCheck.slowRoam.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf2wdsRootCheck.slowRoam.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf2wdsRootCheck.slowRoam.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf3wdsRootCheck.clientAP.ap.enable | boolean | 是否启用 |
| data.advance.wds.rf3wdsRootCheck.clientAP.ap.mac | string | MAC 地址 |
| data.advance.wds.rf3wdsRootCheck.clientAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf3wdsRootCheck.clientAP.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf3wdsRootCheck.clientAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf3wdsRootCheck.clientAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf3wdsRootCheck.clientAP.wir.enable | boolean | 是否启用 |
| data.advance.wds.rf3wdsRootCheck.rootAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf3wdsRootCheck.rootAP.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf3wdsRootCheck.rootAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf3wdsRootCheck.rootAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf3wdsRootCheck.slowRoam.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf3wdsRootCheck.slowRoam.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf3wdsRootCheck.slowRoam.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf3wdsRootCheck.slowRoam.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf4wdsRootCheck.clientAP.ap.enable | boolean | 是否启用 |
| data.advance.wds.rf4wdsRootCheck.clientAP.ap.mac | string | MAC 地址 |
| data.advance.wds.rf4wdsRootCheck.clientAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf4wdsRootCheck.clientAP.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf4wdsRootCheck.clientAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf4wdsRootCheck.clientAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf4wdsRootCheck.clientAP.wir.enable | boolean | 是否启用 |
| data.advance.wds.rf4wdsRootCheck.rootAP.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf4wdsRootCheck.rootAP.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf4wdsRootCheck.rootAP.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf4wdsRootCheck.rootAP.vlan_cfg.vlans | null | VLAN 列表 |
| data.advance.wds.rf4wdsRootCheck.slowRoam.vlan_cfg.nat_vlan | null | NAT VLAN |
| data.advance.wds.rf4wdsRootCheck.slowRoam.vlan_cfg.vlan | null | VLAN ID |
| data.advance.wds.rf4wdsRootCheck.slowRoam.vlan_cfg.vlan_type | string | 模式 |
| data.advance.wds.rf4wdsRootCheck.slowRoam.vlan_cfg.vlans | null | VLAN 列表 |
| data.deploy.common.lan.ipv4Container.manual.enable | boolean | 是否启用 |
| data.deploy.common.lan.ipv4Container.manual.fdns | null | 首选DNS |
| data.deploy.common.lan.ipv4Container.manual.gateway | null | 网关地址 |
| data.deploy.common.lan.ipv4Container.manual.ip | null | IP 地址 |
| data.deploy.common.lan.ipv4Container.manual.mask | null | 子网掩码 |
| data.deploy.common.lan.ipv4Container.manual.mgr_end_ip | null | 管理段结束IP |
| data.deploy.common.lan.ipv4Container.manual.mgr_start_ip | null | 管理段起始IP |
| data.deploy.common.lan.ipv4Container.manual.sdns | null | 备用DNS |
| data.deploy.common.lan.ipv4Container.manual.vlan | null | VLAN ID |
| data.deploy.common.lan.ipv6Container.manual.enable | boolean | 是否启用 |
| data.deploy.common.lan.ipv6Container.manual.end_ip | null | IPv6 手动分配结束地址 |
| data.deploy.common.lan.ipv6Container.manual.fdns | null | 首选DNS |
| data.deploy.common.lan.ipv6Container.manual.gateway | null | 网关地址 |
| data.deploy.common.lan.ipv6Container.manual.ip | null | IP 地址 |
| data.deploy.common.lan.ipv6Container.manual.prefix | null | 前缀 |
| data.deploy.common.lan.ipv6Container.manual.sdns | null | 备用DNS |
| data.deploy.common.lan.ipv6Container.manual.start_ip | null | IPv6 手动分配起始地址 |
| data.advance.band.geconfig.rf_optimize.multicast_opt.mult.ignore_client_enble | boolean | 忽略弱信号客户端开关 |
| data.advance.band.geconfig.rf_optimize.multicast_opt.mult.mult_bw_flow | integer | 多播带宽限速 |
| data.advance.band.geconfig.rf_optimize.multicast_opt.mult.mult_weight_value | integer | 多播权重值 |
| data.advance.band.geconfig.rf_optimize.priority_access.mult.groups | array[object] | 例外的终端 |
| data.advance.band.geconfig.rf_optimize.priority_access.mult.priority_mode | integer | 引导模式 |
| data.advance.band.geconfig.rf_optimize.priority_access.mult.signalValue | integer | 生效信号强度阈值 |
| data.advance.band.geconfig.rf_optimize.probe.mult.gao_fa_v | integer | 高频探测值 |
| data.advance.forward.useLine.other_options.pin.enable.close_pin | object | 解锁成功后关闭PIN码保护 |
| data.advance.forward.useLine.other_options.pin.enable.enable | boolean | 开启自动解锁PIN码功能 |
| data.advance.forward.useLine.other_options.pin.enable.pin | string | PIN码 |
| data.advance.forward.useLine.other_options.pin.enable.close_pin.enable | boolean | 解锁成功后关闭PIN码保护 |
后续接口取值:本接口返回单条记录的当前完整配置,仅作为接口4 modify 的提交基础(回填),不作为任何字段的"数据来源"
2.4 新增普通接入点(add_normal_ap)
接口功能说明: 手动新增一个普通接入点(录入 MAC/SN/硬件型号并选择所属分组,可同时配置部署方式与射频参数)
!!重要:该接口属于nmc-sdk支持开发的接口,详细请查看 nmc-sdk.zip
请求表单schema
本接口使用表单 schema:wl_ap.add_normal_ap.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| branch_id | integer/string | 否 | 分支 ID,中心端为 0(分权分支场景使用)(NAC默认填:0) | - | - |
| data | object | 是(服务端强制) | 业务数据对象 | - | - |
| opr | string | 否 | add_normal_ap | - | - |
| data.group | array[object] | 否 | 所属组(分组路径,样本:/三楼办公环境/3楼)取apg_type: 1 | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].children[] |
| data.id | string | 否 | 接入点 ID(样本:14457182639815786496) | /index.php/wl_ap/list | $.data[].id |
| data.mac | string | 否 | 接入点 MAC 地址(样本:B6-D1-E4-A1-F4-BC) | - | - |
| data.name | string | 是 | AP 名称(样本:test) | - | - |
| data.position | string | 否 | AP 地理位置(样本:三楼工位) | - | - |
| data.hd_alias | string | 否 | AP 别名(样本:ap-362) | - | - |
| data.ap_discovery.controller_domain | string | 否 | 控制器域名(样本:sundray.com) | - | - |
| data.ap_discovery.controller_ip | string | 否 | 控制器 IP(样本:10.222.79.1) | - | - |
| data.ap_discovery.local_backup_ip | string | 否 | 备控制器 IP/域名(样本:10.222.79.12) | - | - |
| data.ap_discovery.local_ip | string | 否 | 主控制器 IP/域名(样本:10.222.79.11) | - | - |
| data.ap_discovery.sequenceNO | string | 否 | SN 码(样本:56744158) | - | - |
| 其他字段 | - | - | data.advance、data.deploy、channel_rf* 等其他参数因业务复杂度高,由 nmc-sdk 封装固定、暂不支持外部接口修改 | - | - |
请求示例
{
"opr": "add_normal_ap",
"data": {
"id": "",
"fml_port": "",
"form_type": "add",
"mac": "B6-D1-E4-A1-F4-BC",
"type": "0",
"software_version": "",
"sequenceNO": "",
"is_new_ap": "",
"branch_type": "",
"name": "test",
"multi_rf": "ap-260",
"position": "",
"position_bak": "",
"base_station": [],
"group": [
{
"id": 0,
"type": "grp",
"path": "/三楼办公环境/默认组",
"multi_rf": "",
"dlink_type": "ap-260"
}
],
"hd_alias": "ap-362",
"pattern": "",
"version": "ap-362",
"net_config": false,
"ap_discovery": {
"enable": false,
"sequenceNO": "56744158",
"controller_ip": "10.222.79.1",
"controller_domain": "",
"local_ip": "",
"local_backup_ip": "",
"enableWADiscover": false
},
"deploy": {
"common": {
"enable": true,
"lan": {
"ipv4Container": {
"enable": true,
"auto": true,
"manual": {
"enable": false,
"ip": null,
"mask": null,
"gateway": null,
"fdns": null,
"sdns": null
},
"net_addr": "auto"
},
"ipv6Container": {
"enable": false,
"auto": true,
"manual": {
"enable": false,
"ip": null,
"prefix": null,
"gateway": null,
"fdns": null,
"sdns": null
},
"address_type": "auto"
},
"vlan_type": {
"vlan": "eth0",
"number": ""
},
"advance_mtu": {
"wan_mtu": 1500
}
}
},
"gatewayMode": {
"enable": false,
"wan": {
"auto": false,
"pppoe": {
"enable": false,
"account": null,
"password": null
},
"manual": {
"enable": false,
"ip": null,
"mask": null,
"gateway": null,
"fdns": null,
"sdns": null
},
"net_addr": "",
"vlan_type": {
"vlan": "eth0",
"number": ""
},
"advance_mtu": null
}
},
"select": "common"
},
"admin_account": {
"account": null,
"pwd": null
},
"wan_lan_group_config": "self",
"lan": "disable",
"wan_lan": {
"wiredContainer": [
{
"port": "eth0",
"type": "wan",
"mode": "trunk",
"vlan": "1",
"nat_vlan": "1",
"vlans": "1-4094"
}
],
"forbid_con_vlan": {
"enable": true
},
"eth_lan_enable_poe_out": {
"enable": false
},
"reject_DHCP_data": {
"enable": true
}
},
"advance": {
"work_mode": {
"enable": false,
"mode": "normal",
"scan": "work",
"limit": true,
"all": false,
"channel": 30,
"single_chn": 60,
"intelligent": true
},
"band": {
"geconfig": {
"pointsmode": "0",
"rf_optimize": {
"probe": {
"enable": false
},
"multicast_opt": {
"enable": true,
"mult": {
"mult_bw_flow": "0",
"mult_weight_value": "90",
"ignore_client_enble": false
}
}
}
},
"enable": false,
"band_1": {
"enable": true,
"mode": 5,
"bandwidth": 1,
"frame_dynamic_response": true,
"usr_limit": 40,
"client_limit": "none",
"none": true,
"advance": {
"multicast_opt": true,
"beacon_type": 1,
"beacon": 100,
"rts": 2347,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"msdu": false,
"uapsd_sw": false,
"force_awake_sta": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
"band_2": {
"enable": true,
"mode": 9,
"bandwidth": 4,
"frame_dynamic_response": true,
"usr_limit": 40,
"client_limit": "none",
"none": true,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 1,
"beacon": 100,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
"rf1": [
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
}
],
"rf2": [
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
}
],
"rf3": [
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
}
],
"rf4": [
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
},
{
"enable": true,
"frame_dynamic_response": true,
"client_limit": "none",
"none": true,
"usr_limit": 40,
"advance": {
"multicast_opt": true,
"rts": 2347,
"beacon_type": 2,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"mu-mimo": false,
"ofdma": true,
"twt": false,
"guard": true,
"no_over_rts": 7,
"mpdu": true,
"over_rts": 7,
"uapsd_sw": false,
"force_awake_sta": false,
"msdu": false,
"mult": {
"mult_bw_flow": 0,
"mult_weight_value": 90,
"ignore_client_enble": false
}
},
"probe": {
"enable": false,
"mult": {
"gao_fa_v": "24",
"safe_signalValue": -90
}
}
}
]
},
"channel_power": {
"power1": {
"enable": true,
"bandwidth": 1,
"mode": 10,
"client_limit": "none",
"none": true
},
"power2": {
"enable": true,
"bandwidth": 4,
"mode": 11,
"client_limit": "none",
"none": true
},
"rf1": [
{
"enable": true,
"bandwidth": 1,
"channel": 0,
"mode": 12,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf2": [
{
"enable": true,
"bandwidth": 1,
"channel": 0,
"mode": 12,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf3": [
{
"enable": true,
"bandwidth": 1,
"channel": 0,
"mode": 12,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf4": [
{
"enable": true,
"bandwidth": 1,
"channel": 0,
"mode": 12,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"bandwidth": 4,
"channel": 0,
"mode": 13,
"transmit_power": {
"value": 0
},
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
]
},
"tunnel": {
"enable": false,
"encryption": false,
"encript": 12,
"keepalive_time": 12,
"keepalive_unit": "second",
"interval_time": 2,
"interval_unit": "second"
},
"wds": {
"enable": true,
"wdsRootCheck": {
"enable": false,
"ssid": "",
"password": "",
"wdsband": "5g",
"other_select": [],
"hide": false
},
"wdsClientCheck": {
"enable": false,
"ssid": "",
"password": "",
"wdsband": "5g",
"wir": {
"enable": false
},
"ap": {
"enable": false,
"mac": ""
}
}
},
"apDHCP": {
"apCheck": {
"enable": false,
"endIP": "192.168.1.200",
"expire": {
"num": 24,
"unit": "hour"
},
"fdns": "192.168.1.1",
"gateway": "192.168.1.1",
"mask": "255.255.255.0",
"sdns": "",
"startIP": "192.168.1.100",
"wlanOnly": {
"enable": false
}
},
"enable": false,
"ip": "192.168.1.1",
"mask": "255.255.255.0"
},
"forward": {
"usb_volume": 8192
},
"channel_sw": {
"enable": false,
"opt": "grp_opt"
},
"forward_sw": {
"enable": false,
"opt": "grp_opt"
},
"work_mode_sw": {
"enable": false,
"opt": "grp_opt"
},
"tunnel_sw": {
"enable": false,
"opt": "grp_opt"
},
"band_sw": {
"enable": false,
"opt": "grp_opt"
},
"wds_sw": {
"enable": false,
"opt": "self_opt"
},
"form_type": "add",
"choose_vers": "group_vers"
},
"panelAP_eth0": null,
"zero_interruption_type": ""
},
"branch_id": 0
}
响应 Body
{
"msg": [
"MAC地址: 不能是组播地址和广播地址。"
],
"success": false
}
或者:
{
"success": true
}
后续接口取值:本接口为入口接口,新增成功后的记录由接口1 list 展示;返回结果不作为其他接口的字段来源
2.5 编辑接入点(modify)
接口功能说明: 修改接入点配置(基础信息/部署/射频/WDS/隧道/转发/DHCP/有线口等,以 listDetail 回填的完整 data 为基础覆盖修改项)
!!重要:该接口属于nmc-sdk支持开发的接口,详细请查看 nmc-sdk.zip
请求表单schema
本接口使用表单 schema:wl_ap.add_normal_ap.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| branch_id | integer/string | 否 | 分支 ID,中心端为 0(分权分支场景使用)(NAC默认填:0) | - | - |
| data | object | 是(服务端强制) | 业务数据对象 | - | - |
| opr | string | 否 | modify | - | - |
| data.group | array[object] | 否 | 所属组(分组路径,样本:/三楼办公环境/3楼)取apg_type: 1 | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].children[] |
| data.id | string | 否 | 接入点 ID(样本:14457182639815786496) | /index.php/wl_ap/list | $.data[].id |
| data.mac | string | 否 | 接入点 MAC 地址(样本:B6-D1-E4-A1-F4-BC) | - | - |
| data.name | string | 是 | AP 名称(样本:test) | - | - |
| data.position | string | 否 | AP 地理位置(样本:三楼工位) | - | - |
| data.hd_alias | string | 否 | AP 别名(样本:ap-362) | - | - |
| data.ap_discovery.controller_domain | string | 否 | 控制器域名(样本:sundray.com) | - | - |
| data.ap_discovery.controller_ip | string | 否 | 控制器 IP(样本:10.222.79.1) | - | - |
| data.ap_discovery.local_backup_ip | string | 否 | 备控制器 IP/域名(样本:10.222.79.12) | - | - |
| data.ap_discovery.local_ip | string | 否 | 主控制器 IP/域名(样本:10.222.79.11) | - | - |
| data.ap_discovery.sequenceNO | string | 否 | SN 码(样本:56744158) | - | - |
| 其他字段 | - | - | data.advance、data.deploy、channel_rf* 等其他参数因业务复杂度高,由 nmc-sdk 封装固定、暂不支持外部接口修改 | - | - |
请求示例
{
"opr": "modify",
"data": {
"id": "15305687870177542144",
"fml_port": "",
"form_type": "",
"mac": "16-1B-6E-1B-77-69",
"type": "0",
"software_version": "AP3.16.0 BUILD20250729-213520",
"sequenceNO": "",
"is_new_ap": "true",
"branch_type": "wac",
"name": "real_370",
"multi_rf": "ap-260",
"position": "",
"position_bak": "",
"base_station": [],
"group": [
{
"id": 0,
"type": "grp",
"path": "/三楼办公环境/默认组",
"multi_rf": "ap-260"
}
],
"hd_alias": "ap-370-y",
"pattern": "SDU-3625-X(SR)-V2",
"version": "common",
"net_config": false,
"ap_discovery": {
"enable": false,
"sequenceNO": "CBY7080503",
"controller_ip": "10.222.79.1",
"controller_domain": "",
"local_ip": "",
"local_backup_ip": "",
"enableWADiscover": false
},
"deploy": {
"common": {
"enable": true,
"lan": {
"ipv4Container": {
"enable": true,
"auto": true,
"manual": {
"enable": false,
"ip": null,
"mask": null,
"gateway": null,
"fdns": null,
"sdns": null
},
"net_addr": "auto"
},
"ipv6Container": {
"enable": false,
"auto": true,
"manual": {
"enable": false,
"ip": null,
"prefix": null,
"gateway": null,
"fdns": null,
"sdns": null
},
"address_type": "auto"
},
"vlan_type": {
"vlan": "eth0",
"number": ""
},
"advance_mtu": {
"wan_mtu": 1500
}
}
},
"gatewayMode": {
"enable": false,
"wan": {
"auto": false,
"pppoe": {
"enable": false,
"account": null,
"password": null
},
"manual": {
"enable": true,
"ip": null,
"mask": null,
"gateway": null,
"fdns": null,
"sdns": null
},
"net_addr": "manual",
"vlan_type": {
"vlan": "eth0",
"number": ""
},
"advance_mtu": {
"wan_mtu": 1500
}
}
},
"select": "common"
},
"admin_account": {
"account": null,
"pwd": null
},
"wan_lan_group_config": "self",
"lan": "disable",
"wan_lan": {
"wiredContainer": [
{
"port": "eth0",
"mode": "trunk",
"vlan": "1",
"nat_vlan": "1",
"vlans": "1-4094",
"type": "wan",
"speed": 2
}
],
"forbid_con_vlan": {
"enable": true
},
"eth_lan_enable_poe_out": {
"enable": true
},
"reject_DHCP_data": {
"enable": true
}
},
"advance": {
"work_mode": {
"counter_toggle": true,
"sta": true,
"rf1": {
"band": 1,
"mode": "normal"
},
"rf2": {
"band": 2,
"mode": "normal"
},
"rf3": {
"band": 2,
"mode": "normal"
},
"rf4": {
"band": 2048,
"mode": "normal"
},
"work_mode_ap": "normal",
"enable_backup_wlan": false,
"enable": false
},
"band": {
"rf1": [
{
"enable": false,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.4",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": false,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf2": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": false,
"usr_limit": 50,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": false,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf3": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf4": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"geconfig": {
"pointsmode": 0,
"rf_optimize": {
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108
}
},
"multicast_opt": {
"enable": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 90
}
},
"priority_access": {
"enable": true,
"mult": {
"signalValue": -80,
"priority_mode": 0,
"groups": []
}
}
},
"antenna_options": 1
},
"enable": false
},
"tunnel": {
"encryption": false,
"keepalive_time": 12,
"keepalive_unit": "second",
"interval_time": 2,
"interval_unit": "second",
"encript": 12,
"enable_layer2_tunnel": true,
"agent_property": 50,
"layer2_control": 12,
"enable": false
},
"wds": {
"rf1wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": "1",
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": "",
"password": "",
"bridgeRadius": "0",
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": 1,
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"rf2wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": "1",
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": "",
"password": "",
"bridgeRadius": "0",
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": 1,
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"rf3wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": 1,
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": null,
"password": null,
"bridgeRadius": 0,
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"rf4wdsRootCheck": {
"enable": false,
"mode": "rootAP",
"rf": 1,
"clientAP": {
"ssid": null,
"password": null,
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
},
"bridgeDistance": 0,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"rootAP": {
"ssid": null,
"password": null,
"bridgeRadius": 0,
"hide": false,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
}
},
"slowRoam": {
"ssid": null,
"password": null,
"main_switch_val": null,
"back_switch_val": null,
"vlan_cfg": {
"vlan_type": "access",
"vlan": null,
"nat_vlan": null,
"vlans": null
},
"scan_channel_list": []
}
},
"enable": true
},
"forward": {
"auth": {
"auth_infor": 0,
"device": null,
"key": "",
"proto_type": "sangfor0.1",
"send_nopass_user": 1
},
"thirdparty": {
"enable": null
},
"usb": 1,
"manufacturer": 0,
"filter_manufacturer": false,
"bluetooth_mode": "low_power",
"bluetooth_mac": "",
"bluetooth_name": "",
"usb_volume": false,
"led_status": {
"led_switch_status": 0,
"time_groupid": null
},
"iot_gateway_s2": {
"enable": 0
},
"authpage_cache": {
"enable": 0
},
"bluetooth": {
"blue_tooth": {
"blue_tooth_fun": 0,
"uuid": "",
"major": 0,
"minor": 0
}
},
"smoke_alarm": {
"smoke_detect": 0,
"buzzing": "long",
"interleave_buz": {
"enable": false
},
"poff_tv": 0
},
"useLine": {
"use_line": 0,
"priorLine": 1,
"other_options": {
"apn": {
"apn": "",
"username": "",
"password": ""
},
"network_mode": {
"network_mode": 0
},
"pin": {
"enable": {
"enable": false,
"pin": "",
"close_pin": {
"enable": true
}
}
},
"line_check": {
"ip": "",
"interval": 15,
"fail_threshold": 3
}
}
},
"poeCensor": {
"poe_censor": 1,
"Censor_time": 10
},
"delay_shutdown": {
"delay_shutdown_1": 1,
"delay_shutdown_timeout": 300
},
"maintainReport": {
"maintainReportWrap": {
"isReport": "1",
"tcpStatistics": true
}
},
"iotp_type": "local_wac",
"iotp_username": null,
"iotp_addr": null,
"iotp_ext": null,
"switch_auth": {
"switch_auth_sw": "0"
},
"iot_kit": 1,
"auth_pass_vlan": 1,
"ueth_dnat_enable": {
"enable": false,
"ueth_ext_dnat_port": 443,
"ueth_in_dnat_port": 443
},
"ueth_data_mode": "wan_tran",
"AIEnableContainer": {
"AIEnable": 1
},
"enable": false
},
"channel_power": {
"rf1": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf2": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf3": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf4": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"enable": false
},
"apDHCP": {
"admin_account": {
"account": null,
"pwd": null
},
"subnet": [],
"port_mapping": {
"dnat_list": []
},
"nat_timestamp": false,
"enable": false
},
"choose_vers": "group_vers"
},
"panelAP_eth0": {
"net": {
"select": null,
"access": {
"enable": false,
"vlan": null
},
"trunk": {
"enable": false,
"desc": null,
"nat_vlan": null,
"vlans": null,
"channel": null
},
"hybrid": {
"enable": false,
"nat_vlan": null,
"tagged_vlan": null,
"untagged_vlan": null
},
"group": {
"enable": null
}
}
},
"zero_interruption_type": "0"
},
"branch_id": 0
}
响应 Body
{
"success": true
}
⚠️ modify 提交基础:建议以 listDetail 返回的完整 data 对象为底,再覆盖要改的字段,避免丢字段
后续接口取值:本接口修改后的记录由接口1 list 展示;返回结果不作为其他接口的字段来源
2.6 删除接入点(delete)
接口功能说明: 删除选中的接入点记录(支持批量)
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 否 | delete | - | - |
| data | array[object] | 是 | 业务数据对象 | - | - |
| data[].id | string | 是 | 记录唯一标识(样本:4539155671547904) | /index.php/wl_ap/list | $.data[].id |
| data[].name | string | 否 | 名称(样本:test) | 同上列表页面带回,以下都用-替代 | - |
| data[].ip | string | 否 | IP 地址(样本:自动获取) | - | - |
| data[].type | number | 否 | 类型(样本:0) | - | - |
| data[].mac | string | 否 | MAC 地址(样本:ED-19-D2-AF-D0-77) | - | - |
| data[].position | string | 否 | 安装位置说明 | - | - |
| data[].port_id | string | 否 | 所接交换机端口ID | - | - |
| data[].switch_name | string | 否 | 所接交换机名称 | - | - |
| data[].params | string | 否 | 配置来源(独立配置/使用分组配置),(样本:组配置) | - | - |
| data[].pattern | string | 否 | 产品型号标识,(样本:NAP-3620) | - | - |
| data[].hd_alias | string | 否 | 硬件型号,(样本:ap-362) | - | - |
| data[].software_version | string | 否 | 软件版本,(样本:-) | - | - |
| data[].sequenceNO | string | 否 | 序列号,(样本:56744158) | - | - |
| data[].sequenceNO_SN | string | 否 | 序列号SN,(样本:56744158) | - | - |
| data[].client_ap_enable | boolean | 否 | 是否启用无线客户端AP,(样本:false) | - | - |
| data[].client_ap_radio | object | 否 | 无线客户端AP射频配置 | - | - |
| data[].deploy | string | 否 | 部署方式(normal=普通),(样本:normal) | - | - |
| data[].hardware_type | number | 否 | 硬件类型(1=内置天线,11=其他),(样本:1) | - | - |
| data[].is_new_ap | boolean | 否 | 是否新架构AP,(样本:true) | - | - |
| data[].not_wds_client | boolean | 否 | 是否非WDS客户端,(样本:false) | - | - |
| data[].poe_ap_id | object | 否 | POE供电关联AP ID | - | - |
| data[].sn | string | 否 | 设备序列号,(样本:56744158) | - | - |
| data[].en_yun_find | boolean | 否 | 是否开启云发现,(样本:false) | - | - |
| data[].sync_status | number | 否 | 配置同步状态,(样本:4) | - | - |
| data[].last_sync_time | string | 否 | 最后同步时间,(样本:-) | - | - |
| data[].is_gw_vap | boolean | 否 | 是否网关虚拟AP,(样本:false) | - | - |
| data[].work_mode_ap | string | 否 | AP工作模式(normal=普通),(样本:normal) | - | - |
| data[].cap_ap_id | string | 否 | 所属CAP AP ID | - | - |
| data[].zero_interruption_type | number | 否 | 零中断切换类型,(样本:0) | - | - |
| data[].batch_rf_type | string | 否 | 批量射频型号,(样本:ap-260) | - | - |
| data[].wds_client_enable_rf | string | 否 | WDS客户端使能射频 | - | - |
| data[].multi_rf | object | 否 | 多射频信息 | - | - |
| data[].channel_rf1 | object | 否 | 射频1信道功率配置 | - | - |
| data[].channel_rf1.1 | object | 否 | 频段1(2.4G)配置 | - | - |
| data[].channel_rf2 | object | 否 | 射频2信道功率配置 | - | - |
| data[].channel_rf2.2 | object | 否 | 频段2(5G)配置 | - | - |
| data[].channel | string | 否 | 信道,(样本:0,0) | - | - |
| data[].bandwidth | string | 否 | 信道带宽,(样本:1,4) | - | - |
| data[].txpower | string | 否 | 发射功率,(样本:auto,auto) | - | - |
| data[].work_mode | object | 否 | 工作模式 | - | - |
| data[].work_mode.rf1 | object | 否 | 射频1配置 | - | - |
| data[].leaf | boolean | 否 | 叶子节点标识,(样本:true) | - | - |
| data[]._parent | object | 否 | 树节点父ID(前端回带) | - | - |
| data[]._id | string | 否 | 树节点ID(前端回带) | - | - |
| data[]._is_leaf | boolean | 否 | 是否叶子节点(前端回带) | - | - |
| branch_id | number | 否 | 分支 ID,中心端为 0(分权分支场景使用)(NAC默认填:0) | - | - |
请求示例
{
"opr": "delete",
"data": [
{
"id": "4539155671547904",
"name": "test",
"ip": "自动获取",
"type": 0,
"mac": "ED-19-D2-AF-D0-77",
"position": "",
"port_id": "",
"switch_name": "",
"params": "组配置",
"pattern": "NAP-3620",
"hd_alias": "ap-362",
"software_version": "-",
"sequenceNO": "56744158",
"sequenceNO_SN": "56744158",
"client_ap_enable": false,
"client_ap_radio": null,
"deploy": "normal",
"hardware_type": 1,
"is_new_ap": true,
"not_wds_client": false,
"poe_ap_id": null,
"sn": "56744158",
"en_yun_find": false,
"sync_status": 4,
"last_sync_time": "-",
"is_gw_vap": false,
"work_mode_ap": "normal",
"cap_ap_id": "",
"zero_interruption_type": 0,
"batch_rf_type": "ap-260",
"wds_client_enable_rf": "",
"multi_rf": null,
"channel_rf1": {
"1": {
"channel": 0,
"bandwidth": 1,
"mode": 12,
"txpower": "auto",
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel_rf2": {
"2": {
"channel": 0,
"bandwidth": 4,
"mode": 13,
"txpower": "auto",
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel": "0,0",
"bandwidth": "1,4",
"txpower": "auto,auto",
"work_mode": {
"rf1": {
"mode": "normal"
}
},
"leaf": true,
"_parent": null,
"_id": "4539155671547904",
"_is_leaf": true
},
{
"id": "1760675605300379648",
"name": "snmp_test_ap1test",
"ip": "4.4.2.10",
"type": 0,
"mac": "1B-59-FF-7E-1D-3C",
"position": "这里",
"port_id": "",
"switch_name": "",
"params": "独立配置",
"pattern": "NAP-8220-X",
"hd_alias": "ap-8220-x-c3",
"software_version": "AP3.16.1 BUILD20260716-093210",
"sequenceNO": "DLY0360143",
"sequenceNO_SN": "DLY0360143",
"client_ap_enable": false,
"client_ap_radio": null,
"deploy": "normal",
"hardware_type": 3,
"is_new_ap": true,
"not_wds_client": false,
"poe_ap_id": null,
"sn": "DLY0360143",
"en_yun_find": false,
"sync_status": 4,
"last_sync_time": "-",
"is_gw_vap": false,
"work_mode_ap": "normal",
"cap_ap_id": "",
"zero_interruption_type": 0,
"batch_rf_type": "ap-8220-x-c3",
"wds_client_enable_rf": "",
"multi_rf": null,
"channel_rf1": {
"1": {
"channel": 0,
"bandwidth": 1,
"mode": 10,
"txpower": "auto",
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel_rf2": {
"2": {
"channel": 0,
"bandwidth": 1,
"mode": 7,
"txpower": 30,
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel": "0,0",
"bandwidth": "1,1",
"txpower": "auto,30",
"work_mode": {
"rf1": {
"mode": "normal"
}
},
"leaf": true,
"_parent": null,
"_id": "1760675605300379648",
"_is_leaf": true
},
{
"id": "15305687870177542144",
"name": "real_370test",
"ip": "自动获取",
"type": 0,
"mac": "16-1B-6E-1B-77-69",
"position": "还在这里",
"port_id": "",
"switch_name": "",
"params": "组配置",
"pattern": "SDU-3625-X(SR)-V2",
"hd_alias": "ap-370-y",
"software_version": "AP3.16.0 BUILD20250729-213520",
"sequenceNO": "CBY7080503",
"sequenceNO_SN": "CBY7080503",
"client_ap_enable": false,
"client_ap_radio": null,
"deploy": "normal",
"hardware_type": 1,
"is_new_ap": true,
"not_wds_client": false,
"poe_ap_id": null,
"sn": "CBY7080503",
"en_yun_find": false,
"sync_status": 4,
"last_sync_time": "-",
"is_gw_vap": false,
"work_mode_ap": "normal",
"cap_ap_id": "",
"zero_interruption_type": 0,
"batch_rf_type": "ap-370-y",
"wds_client_enable_rf": "",
"multi_rf": null,
"channel_rf1": {
"1": {
"channel": 0,
"bandwidth": 1,
"mode": 12,
"txpower": "auto",
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel_rf2": {
"2": {
"channel": 0,
"bandwidth": 4,
"mode": 13,
"txpower": "auto",
"enable": 1,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
},
"channel": "0,0",
"bandwidth": "1,4",
"txpower": "auto,auto",
"work_mode": {
"rf1": {
"mode": "normal"
}
},
"leaf": true,
"_parent": null,
"_id": "15305687870177542144",
"_is_leaf": true
}
],
"branch_id": 0
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [
"real_370test",
"snmp_test_ap1test",
"test"
],
"successCount": 3,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorCount | integer | 失败数量 |
| errorList | array[object] | 失败列表 |
| info | string | 详情信息 |
| msg | array[object] | 提示信息 |
| msg[] | string | 提示信息 |
| success | boolean | 请求是否成功 |
| successCount | integer | 成功数量 |
| succList | array[object] | 成功列表 |
| succList[] | string | 成功列表 |
后续接口取值:本接口为操作类接口,返回结果不作为其他接口的字段来源
2.7 AP 型号列表查询
外部型号与内部型号映射列表
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | query_hm | - | - |
| query | string | 否 | 搜索关键字(空串表示不过滤) | - | - |
请求示例
{
"opr": "query_hm"
}
响应 Body
{
"data": [
{
"text": "CAP-685",
"value": "ap-685"
},
{
"text": "DIS-1220",
"value": "dis-1220"
},
{
"text": "DIS-1320",
"value": "dis-1320"
},
{
"text": "DIS-1520",
"value": "dis-1520"
},
{
"text": "DRU-520P",
"value": "dru-520-p"
},
{
"text": "DRU-530",
"value": "dru-530-y"
},
{
"text": "DRU-530P",
"value": "dru-530-p"
},
{
"text": "DRU-620P",
"value": "dru-620-p"
},
{
"text": "DRU-630",
"value": "dru-630-v4"
},
{
"text": "DRU-630P",
"value": "dru-630-p"
},
{
"text": "DRU-635-IoT",
"value": "dru-635-iot"
},
{
"text": "DRU-650-SR",
"value": "dru-650-j-sr"
},
{
"text": "DRU-650P-SR",
"value": "dru-650-p-sr"
},
{
"text": "EAP-680",
"value": "ap-680"
},
{
"text": "HG-2005-P",
"value": "HG-2005-Pc"
},
{
"text": "NAP-1500",
"value": "ap-150"
},
{
"text": "NAP-1600",
"value": "ap-160"
},
{
"text": "NAP-1700",
"value": "ap-170-y"
},
{
"text": "NAP-1720-LTE",
"value": "ap-170-v"
},
{
"text": "NAP-2400",
"value": "ap-240"
},
{
"text": "NAP-2400-P",
"value": "ap-240-pd"
},
{
"text": "NAP-2400-S",
"value": "ap-240-s-v2"
},
{
"text": "NAP-2600",
"value": "ap-260"
},
{
"text": "NAP-2800",
"value": "ap-280"
},
{
"text": "NAP-2800-P",
"value": "ap-280-p"
},
{
"text": "NAP-3500-P",
"value": "ap-350-p"
},
{
"text": "NAP-3520-X",
"value": "NAP-3520-X"
},
{
"text": "NAP-3560-P",
"value": "ap-356-p"
},
{
"text": "NAP-3600",
"value": "ap-360"
},
{
"text": "NAP-3600(BC)",
"value": "ap-360-bc"
},
{
"text": "NAP-3600(MU)",
"value": "ap-360-v2"
},
{
"text": "NAP-3600(SD)",
"value": "ap-360-sd"
},
{
"text": "NAP-3600-P",
"value": "ap-360-p-q"
},
{
"text": "NAP-3600-P(MU)",
"value": "ap-360-p-v2"
},
{
"text": "NAP-3600-Y",
"value": "ap-360-y"
},
{
"text": "NAP-3620",
"value": "ap-362"
},
{
"text": "NAP-3620(R3)",
"value": "ap-533"
},
{
"text": "NAP-3620P-X",
"value": "ap-3620-p-x"
},
{
"text": "NAP-3625-X(SR)",
"value": "ap-3625-x-sr"
},
{
"text": "NAP-3625-X(SR)-V2",
"value": "NAP-3625-X(SR)-V2"
},
{
"text": "NAP-3625P-X",
"value": "NAP-3625P-X"
},
{
"text": "NAP-3680",
"value": "ap-460-s"
},
{
"text": "NAP-3690",
"value": "ap-3690-t"
},
{
"text": "NAP-3700",
"value": "ap-370-t"
},
{
"text": "NAP-3700(D)",
"value": "ap-370-d"
},
{
"text": "NAP-3720-X",
"value": "ap-372-x-y-v4"
},
{
"text": "NAP-3720-X(EA)",
"value": "ap-372-x-ea"
},
{
"text": "NAP-3720-X-S",
"value": "ap-3720-x-s"
},
{
"text": "NAP-3720-XL",
"value": "ap-372-xl"
},
{
"text": "NAP-3720HD-X",
"value": "ap-372-hd-x"
},
{
"text": "NAP-3720P-X",
"value": "ap-3720-p-x-v3"
},
{
"text": "NAP-3726F-X(SR)",
"value": "NAP-3726F-X(SR)"
},
{
"text": "NAP-3727P",
"value": "NAP-3727P"
},
{
"text": "NAP-3820-X",
"value": "ap-3820-x-v3"
},
{
"text": "NAP-3820P-X",
"value": "ap-3820-p-x"
},
{
"text": "NAP-3822E-X",
"value": "ap-3822e-x"
},
{
"text": "NAP-3825-X(SR)",
"value": "ap-3825-x-j-sr"
},
{
"text": "NAP-3825EA-X(SR)",
"value": "ap-3825-ea-x-sr"
},
{
"text": "NAP-3825HD-X(SR)",
"value": "ap-3825-hd-x-sr"
},
{
"text": "NAP-3825P-X(SR)",
"value": "ap-3825-p-x-c3-sr"
},
{
"text": "NAP-3826-X",
"value": "NAP-3826-X"
},
{
"text": "NAP-3826P-X",
"value": "NAP-3826P-X"
},
{
"text": "NAP-3827(SR)",
"value": "NAP-3827(SR)"
},
{
"text": "NAP-3827PF(SR)",
"value": "NAP-3827PF(SR)"
},
{
"text": "NAP-3927(SR)",
"value": "NAP-3927(SR)"
},
{
"text": "NAP-4100V",
"value": "ap-410-v-v2"
},
{
"text": "NAP-4600",
"value": "ap-460"
},
{
"text": "NAP-4650",
"value": "ap-465"
},
{
"text": "NAP-5230",
"value": "ap-5230-t"
},
{
"text": "NAP-5520-X",
"value": "ap-5520-x"
},
{
"text": "NAP-5530-X",
"value": "ap-5530-x-q-v4"
},
{
"text": "NAP-5600",
"value": "ap-560"
},
{
"text": "NAP-5636-X(SR)",
"value": "ap-5636-x-sr"
},
{
"text": "NAP-5737(SR)",
"value": "NAP-5737(SR)"
},
{
"text": "NAP-5820-X",
"value": "ap-582-x"
},
{
"text": "NAP-5937(SR)",
"value": "NAP-5937(SR)"
},
{
"text": "NAP-7600",
"value": "ap-760"
},
{
"text": "NAP-7800",
"value": "ap-780"
},
{
"text": "NAP-8000",
"value": "ap-800"
},
{
"text": "NAP-8000(L)",
"value": "ap-800-l"
},
{
"text": "NAP-8100",
"value": "ap-810"
},
{
"text": "NAP-8100(L)",
"value": "ap-810-l"
},
{
"text": "NAP-8100(L)-LTE",
"value": "ap-810-l-lte-j"
},
{
"text": "NAP-8220-X",
"value": "ap-8220-x"
},
{
"text": "NAP-8220-X(EA)",
"value": "ap-8220-x-c3-ea"
},
{
"text": "NAP-8227(SR)",
"value": "NAP-8227(SR)"
},
{
"text": "NAP-8227EA(SR)",
"value": "NAP-8227EA(SR)"
},
{
"text": "NAP-8530-X",
"value": "ap-8530-x-q"
},
{
"text": "NAP-8537(SR)",
"value": "NAP-8537(SR)"
},
{
"text": "NAP-8889(SR)",
"value": "NAP-8889(SR)"
},
{
"text": "SDU-1200-S",
"value": "SDU-1200-S"
},
{
"text": "SDU-1800",
"value": "SDU-1800"
},
{
"text": "SDU-3625-X(SR)-V2",
"value": "SDU-3625-X(SR)-V2"
},
{
"text": "SDU-3800",
"value": "SDU-3800"
},
{
"text": "SI-WM20",
"value": "SI-WM20"
},
{
"text": "SI-WM20-AV",
"value": "SI-WM20-AV"
},
{
"text": "SI-WM50",
"value": "SI-WM50"
},
{
"text": "UAP-610P",
"value": "uap-610-p"
},
{
"text": "UAP-610P-S",
"value": "uap-610-p-s"
},
{
"text": "UAP-620P",
"value": "uap-620-p-v4"
},
{
"text": "UAP-625P",
"value": "UAP-625P"
},
{
"text": "UAP-630PF",
"value": "uap-630-p-f"
},
{
"text": "UAP-650PF",
"value": "UAP-650PF"
},
{
"text": "UAP-750P",
"value": "UAP-750P"
},
{
"text": "UAP-750PF",
"value": "UAP-750PF"
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | AP 型号对象数组(已按 text 升序排序) |
| data[].text | string | 型号显示名,如 "CAP-685"、"NAP-2600" |
| data[].value | string | 型号别名(内部标识),如 "ap-685"、"ap-260" |
| success | boolean | 请求是否成功 |
后续接口取值:接口2(query_apgroup_tree)的入参
hd_alias取本接口返回的型号别名,取值路径$.data[].value
2.8 AP 组树查询
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 | |
|---|---|---|---|---|---|---|
| opr | string | 是 | query_apgroup_tree | - | - | |
| parent | string | 否 | 树展开的父节点标识,固定 "root" | - | - | |
| hd_alias | string \ | array | 否 | 按型号别名过滤树节点(如 "ap-260");支持数组多型号 | /index.php/wl_apgroup/query_hm | $.data[].value |
| branch_id | integer | 否 | 分支 ID,0 表示当前登录分支 | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
请求示例
{
"opr": "query_apgroup_tree",
"parent": "root",
"hd_alias": "ap-260",
"branch_id": 0
}
响应 Body
{
"data": {
"tree": [
{
"leaf": false,
"id": 1,
"pid": -1,
"name": "三楼办公环境",
"deletable": false,
"branch_id": 0,
"multi_rf": "",
"apg_type": 2,
"dlink_type": "ap-260",
"type": "area",
"expanded": true,
"children": [
{
"leaf": true,
"id": 0,
"pid": 1,
"name": "默认组",
"deletable": false,
"branch_id": 0,
"multi_rf": "",
"apg_type": 1,
"dlink_type": "ap-260",
"type": "grp"
},
{
"leaf": true,
"id": 2,
"pid": 1,
"name": "3楼",
"deletable": true,
"branch_id": 0,
"multi_rf": "",
"apg_type": 1,
"dlink_type": "ap-260",
"type": "grp"
},
{
"leaf": true,
"id": 6,
"pid": 1,
"name": "zxt_test",
"deletable": true,
"branch_id": 0,
"multi_rf": "",
"apg_type": 1,
"dlink_type": "ap-260",
"type": "grp"
}
]
}
],
"all": true
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 树数据容器 |
| data.all | boolean | 是否包含全部节点(分权后无隐藏节点) |
| data.tree | array | AP 组/区域树根节点数组 |
| data.tree[].id | integer | 节点 ID(AP 组或区域的 group_id) |
| data.tree[].pid | integer | 父节点 ID(根节点为 -1) |
| data.tree[].name | string | 节点名称(AP 组名或区域名) |
| data.tree[].type | string | 节点类型:area=区域,grp=AP 组 |
| data.tree[].apg_type | integer | 分组类型:1=AP 组,2=区域 |
| data.tree[].leaf | boolean | 是否叶子节点 |
| data.tree[].expanded | boolean | 是否默认展开 |
| data.tree[].deletable | boolean | 是否可删除 |
| data.tree[].branch_id | integer | 所属分支 ID |
| data.tree[].multi_rf | string | 多射频标识(空串) |
| data.tree[].dlink_type | string | 关联型号别名(如 "ap-260") |
| data.tree[].children | array | 子节点数组(结构与 data.tree[] 相同,递归) |
| success | boolean | 请求是否成功 |
后续接口取值:接口7(modify)、8(listDetail)、9(listDetail_area)、10(modify_area)取本接口的 id 作为
data.id,接口11(delete)取本接口的 id 作为data[].apg[].id,取值路径$.data.tree[].id(含区域节点$.data.tree[].children[].id)
2.9 AP 区域树查询
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | query_aparea_tree | - | - |
| node | string | 否 | 树展开的父节点标识,固定 "root" | - | - |
| branch_id | integer | 否 | 分支 ID,0 表示当前登录分支 | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
请求示例
{
"opr": "query_aparea_tree",
"node": "root",
"branch_id": 0
}
响应 Body
{
"data": {
"tree": [
{
"leaf": false,
"id": 1,
"pid": -1,
"name": "所有区域",
"deletable": false,
"branch_id": 0,
"multi_rf": "",
"apg_type": 2,
"dlink_type": "ap-260",
"type": "area",
"expanded": true,
"children": [
{
"leaf": true,
"id": 7,
"pid": 1,
"name": "areatest",
"deletable": true,
"branch_id": 0,
"multi_rf": "",
"apg_type": 2,
"dlink_type": null,
"type": "area"
}
]
}
],
"all": true,
"branch_name": "三楼办公环境"
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 树数据容器 |
| data.all | boolean | 是否包含全部节点 |
| data.branch_name | string | 分支名称(由 branch_id 查询得到,如 "三楼办公环境") |
| data.tree | array | 区域树根节点数组(服务端强制 area_only=true,仅含 apg_type=2 的区域节点) |
| data.tree[].id | integer | 区域 ID(group_id) |
| data.tree[].pid | integer | 父区域 ID(根节点为 -1) |
| data.tree[].name | string | 区域名称,如 "所有区域"、"areatest" |
| data.tree[].type | string | 节点类型,固定 "area" |
| data.tree[].apg_type | integer | 固定 2(区域) |
| data.tree[].leaf | boolean | 是否叶子节点 |
| data.tree[].expanded | boolean | 是否默认展开 |
| data.tree[].deletable | boolean | 是否可删除 |
| data.tree[].branch_id | integer | 所属分支 ID |
| data.tree[].multi_rf | string | 多射频标识(空串) |
| data.tree[].dlink_type | string | 关联型号别名 |
| data.tree[].children | array | 子区域数组(结构与 data.tree[] 相同,递归) |
| success | boolean | 请求是否成功 |
后续接口取值:接口5(add)、6(add_area)、7(modify)取本接口的区域 id 作为
data.path.id,取值路径$.data.tree[].id;区域名称$.data.tree[].name对应data.path.text
2.10 AP 组新增
请求表单schema
本接口使用表单 schema:wl_apgroup.add.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | add | - | - |
| branch_id | integer | 否 | 分支 ID(分权上下文,0=当前登录分支)--取所属区域的分支id | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data | object | 是 | AP 组配置对象 | - | - |
| data.id | string | 否 | 新增时传空串(服务端生成新 id) | - | - |
| data.name | string | 是 | AP 组名称。名称字符串,长度 1~95 字符;type='allow_xg' 分支:允许小写字母、数字、中文简繁体、下划线、点、空格及斜杠 /,大写字母 A-Z 不在允许集合内 | - | - |
| data.desc | string | 否 | 描述。描述文本,字节长度 1~99;允许英文字母、数字、中文简繁体、全角逗号、下划线、点、空格、连字符、斜杠,不允许单引号 | - | - |
| data.path | object | 是 | 所属区域对象(新增时必选,未选择将校验失败) | - | - |
| data.path.id | integer | 否 | 所属区域 ID(apg_type=2 的区域节点) | /index.php/wl_apgroup/query_aparea_tree | $.data.tree[].id |
| data.path.text | string | 否 | 所属区域完整路径(前端回带显示用) | - | - |
| data.path.display_text | string | 否 | 去除根区域前缀的显示路径(前端回带) | - | - |
| data.apgrp_params | object | 否 | 接入点参数对象 | - | - |
| data.apgrp_params.id | integer | 否 | 接入点参数 ID(0=默认参数) | /index.php/wl_apgrp_params/list_brief | $.data[].id |
| data.apgrp_params.name | string | 否 | 接入点参数名称,如 "NMC/NAC系列AP默认参数" | /index.php/wl_apgrp_params/list_brief | $.data[].name |
请求示例
{
"opr": "add",
"branch_id": 0,
"data": {
"id": "",
"name": "分组test",
"desc": "",
"path": {
"id": 7,
"text": "/三楼办公环境/areatest"
},
"apgrp_params": {
"id": 0,
"name": "NMC/NAC系列AP默认参数"
}
}
}
响应 Body
{
"id": "8",
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 新建的 AP 组 ID(如 "8") |
| success | boolean | 请求是否成功 |
⚠️ 服务端固定创建 apg_type=1(AP 组)类型记录;
data.name为 Form 层 required 必填,缺省将校验失败。
后续接口取值:本接口返回的新 id 会出现在接口2(query_apgroup_tree)/接口3(query_aparea_tree)的树节点中,供接口7(modify)、8(listDetail)、11(delete)按
$.data.tree[].id取用;树接口本身是这些 id 的候选来源
2.11 区域新增
请求表单schema
本接口使用表单 schema:wl_apgroup.add_area.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | add_area | - | - |
| branch_id | integer | 否 | 分支 ID(0=当前登录分支) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data | object | 是 | 区域配置对象 | - | - |
| data.id | string | 否 | 新增时传空串(服务端生成新 id) | - | - |
| data.name | string | 是 | 区域名称。规则:required, callback[check_text](名称合法性校验) | - | - |
| data.desc | string | 否 | 描述。规则:callback[check_desc][1](字节长度上限 99) | - | - |
| data.path | object | 否 | 上级区域对象 | - | - |
| data.path.id | integer | 否 | 上级区域 ID(服务端会 unset 该键,仅用于前端回显定位) | /index.php/wl_apgroup/query_aparea_tree | $.data.tree[].id |
| data.path.text | string | 否 | 上级区域名称(前端回带) | - | - |
请求示例
{
"opr": "add_area",
"branch_id": 0,
"data": {
"id": "",
"name": "areatest",
"desc": "11",
"path": {
"id": 1,
"text": "三楼办公环境"
}
}
}
响应 Body
{
"id": "7",
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 新建的区域 ID(如 "7") |
| success | boolean | 请求是否成功 |
⚠️ 服务端固定创建 apg_type=2(区域)类型记录;新区域总是挂在当前分支根下(父级由服务端决定)。
后续接口取值:新区域 id 会出现在接口3(query_aparea_tree)/接口2(query_apgroup_tree)的树节点中,供接口5(add)/7(modify)的
data.path.id取用,取值路径$.data.tree[].id
2.12 AP 组编辑
请求表单schema
本接口使用表单 schema:wl_apgroup.add.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | modify | - | - |
| branch_id | integer | 否 | 分支 ID(0=当前登录分支) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data | object | 是 | AP 组配置对象 | - | - |
| data.id | string | 是 | 待修改的 AP 组 ID | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].id |
| data.name | string | 是 | AP 组名称。名称字符串,长度 1~95 字符;type='allow_xg' 分支:允许小写字母、数字、中文简繁体、下划线、点、空格及斜杠 /,大写字母 A-Z 不在允许集合内 | - | - |
| data.desc | string | 否 | 描述。描述文本,字节长度 1~99;允许英文字母、数字、中文简繁体、全角逗号、下划线、点、空格、连字符、斜杠,不允许单引号 | - | - |
| data.path | object | 是 | 所属区域对象 | - | - |
| data.path.id | integer | 否 | 所属区域 ID | /index.php/wl_apgroup/query_aparea_tree | $.data.tree[].id |
| data.path.text | string | 否 | 所属区域完整路径(前端回带) | - | - |
| data.path.display_text | string | 否 | 去除根区域前缀的显示路径(前端回带) | - | - |
| data.apgrp_params | object | 否 | 接入点参数对象 | - | - |
| data.apgrp_params.id | integer | 否 | 接入点参数 ID(0=默认参数) | /index.php/wl_apgrp_params/list_brief | $.data[].id |
| data.apgrp_params.name | string | 否 | 接入点参数名称,如 "默认组" | /index.php/wl_apgrp_params/list_brief | $.data[].name |
请求示例
{
"opr": "modify",
"branch_id": 0,
"data": {
"id": "2",
"name": "3楼",
"desc": "",
"path": {
"id": 1,
"text": "三楼办公环境",
"display_text": "三楼办公环境"
},
"apgrp_params": {
"id": 0,
"name": "默认组"
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
⚠️ modify 提交基础:建议以 listDetail 返回的完整 data 对象为底,再覆盖要改的字段,避免丢字段
后续接口取值:无(编辑后页面重新查询接口2/3 的树刷新展示)
2.13 AP 组详情
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | listDetail | - | - |
| branch_id | integer | 否 | 分支 ID(0=当前登录分支) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data | object | 是 | 详情查询对象 | - | - |
| data.id | integer | 是 | AP 组 ID(服务端强制,缺省报"记录不存在") | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].id |
| data.branch_id | integer | 否 | 数据所属分支 ID(前端回带) | - | - |
请求示例
{
"opr": "listDetail",
"branch_id": 0,
"data": {
"id": 2,
"branch_id": 0
}
}
响应 Body
{
"data": {
"id": 2,
"name": "3楼",
"desc": "",
"type": "xlink",
"version": "common",
"path": {
"id": 1,
"text": "所有区域",
"display_text": "三楼办公环境"
},
"main_ip": "192.169.171.200",
"spare_ip": "192.169.171.99",
"intelligent": {
"enable": false,
"setting": {
"count": 3,
"params": {
"adjust_rssi_limit": null,
"join_person_limit": 3
},
"priority_channel": false
}
},
"lan": "disable",
"work_mode": {
"counter_toggle": true,
"sta": true,
"rf1": {
"band": 1,
"mode": "normal"
},
"rf2": {
"band": 2,
"mode": "normal"
},
"rf3": {
"band": 2,
"mode": "normal"
},
"rf4": {
"band": 2048,
"mode": "normal"
},
"work_mode_ap": "normal",
"enable_backup_wlan": false
},
"band": {
"rf1": [
{
"enable": false,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.4",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": false,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf2": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": false,
"usr_limit": 50,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": false,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf3": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"rf4": [
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "1"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
},
{
"enable": true,
"usr_limit": 40,
"advance": {
"rts": 2347,
"beacon": 0,
"dtim": 1,
"slice": 2346,
"preamble": "short",
"long": false,
"short": true,
"guard": true,
"guard_interval": "0.8",
"no_over_rts": 7,
"over_rts": 7,
"mpdu": true,
"msdu": false,
"mimo": 1,
"probe": false,
"multicast_opt": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 10
},
"mu_mimo": false,
"uapsd_sw": false,
"force_awake_sta": true,
"enhance_txpower": false,
"dfs": true,
"ofdma": true,
"twt": false
},
"mimo": [
{
"text": "",
"value": 1
}
],
"mimo_type": 1,
"client_speed_specify": {
"enable": false,
"specify": "6"
},
"client_limit": "none",
"none": true,
"beacon_rate": "0",
"rate_min": 0,
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108,
"safe_signalValue": -90
}
},
"frame_dynamic_response": true
}
],
"geconfig": {
"pointsmode": 0,
"rf_optimize": {
"probe": {
"enable": false,
"mult": {
"gao_fa_v": 108
}
},
"multicast_opt": {
"enable": true,
"mult": {
"ignore_client_enble": false,
"mult_bw_flow": 0,
"mult_weight_value": 90
}
},
"priority_access": {
"enable": true,
"mult": {
"signalValue": -80,
"priority_mode": 0,
"groups": []
}
}
},
"antenna_options": 1
}
},
"tunnel": {
"encryption": false,
"keepalive_time": 12,
"keepalive_unit": "second",
"interval_time": 2,
"interval_unit": "second",
"encript": 12,
"enable_layer2_tunnel": true,
"agent_property": 50,
"layer2_control": 12
},
"wds": {
"wdscheck": {
"enable": false,
"wdsmode": "root",
"wdsband": "5g",
"wdsband_root": "5g",
"ap": {
"enable": false,
"mac": ""
},
"wir": {
"enable": false
}
}
},
"forward": {
"auth": {
"auth_infor": 0,
"device": null,
"key": "",
"proto_type": "sangfor0.1",
"send_nopass_user": 1
},
"thirdparty": {
"enable": 0
},
"led_status": {
"led_switch_status": 0,
"time_groupid": null
},
"iot_gateway_s2": {
"enable": 0
},
"usb": 1,
"manufacturer": 0,
"filter_manufacturer": false,
"bluetooth_mode": "low_power",
"bluetooth_mac": "",
"bluetooth_name": "",
"usb_volume": false,
"authpage_cache": {
"enable": 0
},
"bluetooth": {
"blue_tooth": {
"blue_tooth_fun": 0,
"uuid": "",
"major": 0,
"minor": 0
}
},
"smoke_alarm": {
"smoke_detect": 0,
"buzzing": "long",
"interleave_buz": {
"enable": false
},
"poff_tv": 0
},
"useLine": {
"use_line": 0,
"priorLine": 1,
"other_options": {
"apn": {
"apn": "",
"username": "",
"password": ""
},
"network_mode": {
"network_mode": 0
},
"pin": {
"enable": {
"enable": false,
"pin": "",
"close_pin": {
"enable": true
}
}
},
"line_check": {
"ip": "",
"interval": 15,
"fail_threshold": 3
}
}
},
"poeCensor": {
"poe_censor": 1,
"Censor_time": 10
},
"delay_shutdown": {
"delay_shutdown_1": 1,
"delay_shutdown_timeout": 300
},
"maintainReport": {
"maintainReportWrap": {
"isReport": "1",
"tcpStatistics": true
}
},
"iotp_type": "local_wac",
"iotp_username": null,
"iotp_addr": null,
"iotp_ext": null,
"switch_auth": {
"switch_auth_sw": "0"
},
"iot_kit": 1,
"auth_pass_vlan": 1,
"ueth_dnat_enable": {
"enable": false,
"ueth_ext_dnat_port": 443,
"ueth_in_dnat_port": 443
},
"ueth_data_mode": "wan_tran",
"AIEnableContainer": {
"AIEnable": 1
}
},
"channel_power": {
"rf1": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf2": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf3": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
],
"rf4": [
{
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
},
{
"enable": true,
"mode": 13,
"bandwidth": 4,
"channel": 0,
"transmit_power": {
"value": 0
},
"usr_limit": 40,
"frame_dynamic_response": true,
"advance": {
"all_channel_list_enable": false,
"power_enhance": false
}
}
]
},
"apDHCP": {
"admin_account": {
"account": null,
"pwd": null
},
"subnet": {
"nat_timestamp": false
},
"port_mapping": {
"dnat_list": []
}
},
"advance": {
"apscan_params": {
"single_scan_time": 30,
"scan_interval": 60
},
"neighbor_params": {
"threshold": -75,
"cycle": 15,
"sync_time": 15
},
"ch_params": {
"ch_rate": 80,
"rate_bound": 80,
"auto_adjust_stable_intval": 300,
"enable_online_adjust": false,
"nochange802": false
},
"sign_limit_params": {
"sign_limit": -75
}
},
"wired": {
"forbid_con_vlan": {
"enable": true
},
"reject_DHCP_data": {
"enable": true
},
"eth_lan_enable_poe_out": {
"enable": null
},
"use_group_config": {
"enable": false
},
"wiredContainer": [
{
"port": "eth0",
"mode": "trunk",
"vlan": "1",
"nat_vlan": "1",
"vlans": "1-4093",
"type": "wan",
"speed": 2
},
{
"port": "eth1",
"mode": "access",
"vlan": "1",
"nat_vlan": "1",
"vlans": null,
"type": "lan",
"speed": 2
}
]
},
"apgrp_params": {
"id": "0",
"name": "默认组"
},
"containment_sw": true
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 响应数据 |
| success | boolean | 请求是否成功 |
| data.advance | object | 高级选项 |
| data.apDHCP | object | 网关接入点 |
| data.apgrp_params | object | 接入点参数 |
| data.band | object | 射频参数 |
| data.channel_power | object | 信道功率 |
| data.containment_sw | boolean | 遏制开关 |
| data.desc | string | 描述 |
| data.forward | object | 其他配置 |
| data.id | integer | AP组ID |
| data.intelligent | object | 接入点智能负载 |
| data.lan | string | LAN 口模式。取值:disable=禁用,passthrough=透传,auth=认证 |
| data.main_ip | string | master_controller_ip_domain |
| data.name | string | 名称 |
| data.path | object | 所属区域 |
| data.spare_ip | string | slave_controller_ip_domain |
| data.tunnel | object | 隧道参数 |
| data.type | string | 型号类别 |
| data.version | string | 型号 |
| data.wds | object | 无线中继 |
| data.wired | object | 有线口配置 |
| data.work_mode | object | 工作模式 |
| data.advance.apscan_params | object | AP扫描参数 |
| data.advance.ch_params | object | 信道参数 |
| data.advance.neighbor_params | object | 邻居参数 |
| data.advance.sign_limit_params | object | 信号阈值参数 |
| data.apDHCP.admin_account | object | 管理员账号 |
| data.apDHCP.port_mapping | object | 端口映射 |
| data.apDHCP.subnet | object | 子网配置 |
| data.apgrp_params.id | string | 接入点参数ID |
| data.apgrp_params.name | string | 名称 |
| data.band.geconfig | object | 功能配置 |
| data.band.rf1 | array | 射频1 |
| data.band.rf1[] | object | 射频1 |
| data.band.rf2 | array | 同 data.band.rf1 (同构) |
| data.band.rf2[] | object | 同 data.band.rf1[] (同构) |
| data.band.rf3 | array | 同 data.band.rf1 (同构) |
| data.band.rf3[] | object | 同 data.band.rf1[] (同构) |
| data.band.rf4 | array | 同 data.band.rf1 (同构) |
| data.band.rf4[] | object | 同 data.band.rf1[] (同构) |
| data.channel_power.rf1 | array | 射频1 |
| data.channel_power.rf1[] | object | 射频1 |
| data.channel_power.rf2 | array | 同 data.channel_power.rf1 (同构) |
| data.channel_power.rf2[] | object | 同 data.channel_power.rf1[] (同构) |
| data.channel_power.rf3 | array | 同 data.channel_power.rf1 (同构) |
| data.channel_power.rf3[] | object | 同 data.channel_power.rf1[] (同构) |
| data.channel_power.rf4 | array | 同 data.channel_power.rf1 (同构) |
| data.channel_power.rf4[] | object | 同 data.channel_power.rf1[] (同构) |
| data.forward.AIEnableContainer | object | 安视射频 |
| data.forward.auth | object | 认证信息转发 |
| data.forward.auth_pass_vlan | integer | 网络设备VLAN |
| data.forward.authpage_cache | object | 认证页面缓存 |
| data.forward.bluetooth | object | 蓝牙模块 |
| data.forward.bluetooth_mac | string | 蓝牙音箱MAC地址 |
| data.forward.bluetooth_mode | string | 蓝牙模式 |
| data.forward.bluetooth_name | string | 蓝牙音箱名称 |
| data.forward.delay_shutdown | object | 延迟时间 |
| data.forward.filter_manufacturer | boolean | 指定厂商ID |
| data.forward.iot_gateway_s2 | object | 物联网网关S2 |
| data.forward.iot_kit | integer | IOT_KIT |
| data.forward.iotp_addr | null | 平台地址 |
| data.forward.iotp_ext | null | 扩展字段 |
| data.forward.iotp_type | string | 接入类型 |
| data.forward.iotp_username | null | 用户名 |
| data.forward.led_status | object | 设备灯控制 |
| data.forward.maintainReport | object | 业务感知信息上报 |
| data.forward.manufacturer | integer | 指定厂商ID |
| data.forward.poeCensor | object | 上联口链路检查 |
| data.forward.smoke_alarm | object | 烟感模块 |
| data.forward.switch_auth | object | 交换机认证功能 |
| data.forward.thirdparty | object | 无线信息采集 |
| data.forward.ueth_data_mode | string | 网络数据转发模式 |
| data.forward.ueth_dnat_enable | object | 端口映射 |
| data.forward.usb | integer | USB设备工作模式 |
| data.forward.usb_volume | boolean | USB缓存容量 |
| data.forward.useLine | object | 2/3/4G线路 |
| data.intelligent.enable | boolean | 启用接入点智能负载 |
| data.intelligent.setting | object | 设置 |
| data.path.display_text | string | 所属区域显示文本 |
| data.path.id | integer | 所属区域ID |
| data.path.text | string | 所属区域名称 |
| data.tunnel.agent_property | integer | 代理优先级 |
| data.tunnel.enable_layer2_tunnel | boolean | 启用二层隧道代理功能 |
| data.tunnel.encript | integer | 数据隧道保活时间 |
| data.tunnel.encryption | boolean | 加密数据隧道 |
| data.tunnel.interval_time | integer | 控制隧道心跳间隔时间 |
| data.tunnel.interval_unit | string | 发送间隔单位。取值:millisecond=毫秒,second=秒 |
| data.tunnel.keepalive_time | integer | 控制隧道保活时间 |
| data.tunnel.keepalive_unit | string | 控制隧道保活时间单位 |
| data.tunnel.layer2_control | integer | 二层隧道保活时间 |
| data.wds.wdscheck | object | 无线中继 |
| data.wired.eth_lan_enable_poe_out | object | LAN口使能POE输出 |
| data.wired.forbid_con_vlan | object | 禁止协商VLAN |
| data.wired.reject_DHCP_data | object | 拒绝DHCP数据 |
| data.wired.use_group_config | object | 使用组配置 |
| data.wired.wiredContainer | array | 有线口容器 |
| data.wired.wiredContainer[] | object | 有线口容器 |
| data.work_mode.counter_toggle | boolean | 开启反制功能 |
| data.work_mode.enable_backup_wlan | boolean | 网络备份 |
| data.work_mode.rf1 | object | 射频1 |
| data.work_mode.rf2 | object | 同 data.work_mode.rf1 (同构) |
| data.work_mode.rf3 | object | 同 data.work_mode.rf1 (同构) |
| data.work_mode.rf4 | object | 同 data.work_mode.rf1 (同构) |
| data.work_mode.sta | boolean | 启用STA检测 |
| data.work_mode.work_mode_ap | string | 工作模式 |
| data.advance.apscan_params.scan_interval | integer | 扫描间隔时间 |
| data.advance.apscan_params.single_scan_time | integer | 单信道扫描时间 |
| data.advance.ch_params.auto_adjust_stable_intval | integer | 信道调整稳定时间 |
| data.advance.ch_params.ch_rate | integer | 信道利用率阈值 |
| data.advance.ch_params.enable_online_adjust | boolean | 允许在线接入点实时调整最佳信道 |
| data.advance.ch_params.nochange802 | boolean | 存在不支持802.11h协议的终端时不调整 |
| data.advance.ch_params.rate_bound | integer | 超过阈值累计时间 |
| data.advance.neighbor_params.cycle | integer | 邻居个数阈值 |
| data.advance.neighbor_params.sync_time | integer | 邻居ap信息同步间隔 |
| data.advance.neighbor_params.threshold | integer | 邻居信号强度阈值 |
| data.advance.sign_limit_params.sign_limit | integer | 终端信号强度阈值 |
| data.apDHCP.admin_account.account | null | 名称 |
| data.apDHCP.admin_account.pwd | null | 密码 |
| data.apDHCP.port_mapping.dnat_list | array | 端口映射 |
| data.apDHCP.subnet.nat_timestamp | boolean | NAT时去掉TCP时间戳 |
| data.band.geconfig.antenna_options | integer | 天线选项 |
| data.band.geconfig.pointsmode | integer | 功分模式 |
| data.band.geconfig.rf_optimize | object | 射频优化 |
| data.band.rf1[].advance | object | 高级选项 |
| data.band.rf1[].beacon_rate | string | 限制beacon帧发送速率 |
| data.band.rf1[].client_limit | string | 客户端数量限制 |
| data.band.rf1[].client_speed_specify | object | 终端速率限制 |
| data.band.rf1[].enable | boolean | 启用 |
| data.band.rf1[].frame_dynamic_response | boolean | 探测帧动态应答 |
| data.band.rf1[].mimo | array | 天线MIMO |
| data.band.rf1[].mimo_type | integer | 天线类型 |
| data.band.rf1[].mimo[] | object | 天线MIMO |
| data.band.rf1[].none | boolean | 无 |
| data.band.rf1[].probe | object | 高密优化 |
| data.band.rf1[].rate_min | integer | 数据传输速率下限 |
| data.band.rf1[].usr_limit | integer | 用户上限 |
| data.band.rf2[].advance | object | 同 data.band.rf1[].advance (同构) |
| data.band.rf2[].beacon_rate | string | 同 data.band.rf1[].beacon_rate (同构) |
| data.band.rf2[].client_limit | string | 同 data.band.rf1[].client_limit (同构) |
| data.band.rf2[].client_speed_specify | object | 同 data.band.rf1[].client_speed_specify (同构) |
| data.band.rf2[].enable | boolean | 同 data.band.rf1[].enable (同构) |
| data.band.rf2[].frame_dynamic_response | boolean | 同 data.band.rf1[].frame_dynamic_response (同构) |
| data.band.rf2[].mimo | array | 同 data.band.rf1[].mimo (同构) |
| data.band.rf2[].mimo_type | integer | 同 data.band.rf1[].mimo_type (同构) |
| data.band.rf2[].mimo[] | object | 同 data.band.rf1[].mimo[] (同构) |
| data.band.rf2[].none | boolean | 同 data.band.rf1[].none (同构) |
| data.band.rf2[].probe | object | 同 data.band.rf1[].probe (同构) |
| data.band.rf2[].rate_min | integer | 同 data.band.rf1[].rate_min (同构) |
| data.band.rf2[].usr_limit | integer | 同 data.band.rf1[].usr_limit (同构) |
| data.band.rf3[].advance | object | 同 data.band.rf1[].advance (同构) |
| data.band.rf3[].beacon_rate | string | 同 data.band.rf1[].beacon_rate (同构) |
| data.band.rf3[].client_limit | string | 同 data.band.rf1[].client_limit (同构) |
| data.band.rf3[].client_speed_specify | object | 同 data.band.rf1[].client_speed_specify (同构) |
| data.band.rf3[].enable | boolean | 同 data.band.rf1[].enable (同构) |
| data.band.rf3[].frame_dynamic_response | boolean | 同 data.band.rf1[].frame_dynamic_response (同构) |
| data.band.rf3[].mimo | array | 同 data.band.rf1[].mimo (同构) |
| data.band.rf3[].mimo_type | integer | 同 data.band.rf1[].mimo_type (同构) |
| data.band.rf3[].mimo[] | object | 同 data.band.rf1[].mimo[] (同构) |
| data.band.rf3[].none | boolean | 同 data.band.rf1[].none (同构) |
| data.band.rf3[].probe | object | 同 data.band.rf1[].probe (同构) |
| data.band.rf3[].rate_min | integer | 同 data.band.rf1[].rate_min (同构) |
| data.band.rf3[].usr_limit | integer | 同 data.band.rf1[].usr_limit (同构) |
| data.band.rf4[].advance | object | 同 data.band.rf1[].advance (同构) |
| data.band.rf4[].beacon_rate | string | 同 data.band.rf1[].beacon_rate (同构) |
| data.band.rf4[].client_limit | string | 同 data.band.rf1[].client_limit (同构) |
| data.band.rf4[].client_speed_specify | object | 同 data.band.rf1[].client_speed_specify (同构) |
| data.band.rf4[].enable | boolean | 同 data.band.rf1[].enable (同构) |
| data.band.rf4[].frame_dynamic_response | boolean | 同 data.band.rf1[].frame_dynamic_response (同构) |
| data.band.rf4[].mimo | array | 同 data.band.rf1[].mimo (同构) |
| data.band.rf4[].mimo_type | integer | 同 data.band.rf1[].mimo_type (同构) |
| data.band.rf4[].mimo[] | object | 同 data.band.rf1[].mimo[] (同构) |
| data.band.rf4[].none | boolean | 同 data.band.rf1[].none (同构) |
| data.band.rf4[].probe | object | 同 data.band.rf1[].probe (同构) |
| data.band.rf4[].rate_min | integer | 同 data.band.rf1[].rate_min (同构) |
| data.band.rf4[].usr_limit | integer | 同 data.band.rf1[].usr_limit (同构) |
| data.channel_power.rf1[].advance | object | 高级选项 |
| data.channel_power.rf1[].bandwidth | integer | 信道带宽 |
| data.channel_power.rf1[].channel | integer | 信道 |
| data.channel_power.rf1[].enable | boolean | 启用 |
| data.channel_power.rf1[].frame_dynamic_response | boolean | 探测帧动态应答 |
| data.channel_power.rf1[].mode | integer | 协议 |
| data.channel_power.rf1[].transmit_power | object | 发射功率 |
| data.channel_power.rf1[].usr_limit | integer | 用户上限 |
| data.channel_power.rf2[].advance | object | 同 data.channel_power.rf1[].advance (同构) |
| data.channel_power.rf2[].bandwidth | integer | 同 data.channel_power.rf1[].bandwidth (同构) |
| data.channel_power.rf2[].channel | integer | 同 data.channel_power.rf1[].channel (同构) |
| data.channel_power.rf2[].enable | boolean | 同 data.channel_power.rf1[].enable (同构) |
| data.channel_power.rf2[].frame_dynamic_response | boolean | 同 data.channel_power.rf1[].frame_dynamic_response (同构) |
| data.channel_power.rf2[].mode | integer | 同 data.channel_power.rf1[].mode (同构) |
| data.channel_power.rf2[].transmit_power | object | 同 data.channel_power.rf1[].transmit_power (同构) |
| data.channel_power.rf2[].usr_limit | integer | 同 data.channel_power.rf1[].usr_limit (同构) |
| data.channel_power.rf3[].advance | object | 同 data.channel_power.rf1[].advance (同构) |
| data.channel_power.rf3[].bandwidth | integer | 同 data.channel_power.rf1[].bandwidth (同构) |
| data.channel_power.rf3[].channel | integer | 同 data.channel_power.rf1[].channel (同构) |
| data.channel_power.rf3[].enable | boolean | 同 data.channel_power.rf1[].enable (同构) |
| data.channel_power.rf3[].frame_dynamic_response | boolean | 同 data.channel_power.rf1[].frame_dynamic_response (同构) |
| data.channel_power.rf3[].mode | integer | 同 data.channel_power.rf1[].mode (同构) |
| data.channel_power.rf3[].transmit_power | object | 同 data.channel_power.rf1[].transmit_power (同构) |
| data.channel_power.rf3[].usr_limit | integer | 同 data.channel_power.rf1[].usr_limit (同构) |
| data.channel_power.rf4[].advance | object | 同 data.channel_power.rf1[].advance (同构) |
| data.channel_power.rf4[].bandwidth | integer | 同 data.channel_power.rf1[].bandwidth (同构) |
| data.channel_power.rf4[].channel | integer | 同 data.channel_power.rf1[].channel (同构) |
| data.channel_power.rf4[].enable | boolean | 同 data.channel_power.rf1[].enable (同构) |
| data.channel_power.rf4[].frame_dynamic_response | boolean | 同 data.channel_power.rf1[].frame_dynamic_response (同构) |
| data.channel_power.rf4[].mode | integer | 同 data.channel_power.rf1[].mode (同构) |
| data.channel_power.rf4[].transmit_power | object | 同 data.channel_power.rf1[].transmit_power (同构) |
| data.channel_power.rf4[].usr_limit | integer | 同 data.channel_power.rf1[].usr_limit (同构) |
| data.forward.AIEnableContainer.AIEnable | integer | AI射频 |
| data.forward.auth.auth_infor | integer | 认证信息转发 |
| data.forward.auth.device | null | 设备地址 |
| data.forward.auth.key | string | 共享密钥 |
| data.forward.auth.proto_type | string | 协议类型 |
| data.forward.auth.send_nopass_user | integer | 用户信息上报 |
| data.forward.authpage_cache.enable | integer | 启用认证页面缓存 |
| data.forward.bluetooth.blue_tooth | object | 启用蓝牙 |
| data.forward.delay_shutdown.delay_shutdown_1 | integer | 延迟下电 |
| data.forward.delay_shutdown.delay_shutdown_timeout | integer | 延迟时间 |
| data.forward.iot_gateway_s2.enable | integer | 启用物联网网关S2 |
| data.forward.led_status.led_switch_status | integer | 设备灯控制 |
| data.forward.led_status.time_groupid | null | 时间计划 |
| data.forward.maintainReport.maintainReportWrap | object | 业务感知信息上报 |
| data.forward.poeCensor.Censor_time | integer | 上联口链路不通时间上限 |
| data.forward.poeCensor.poe_censor | integer | 上联口链路检查 |
| data.forward.smoke_alarm.buzzing | string | 蜂鸣 |
| data.forward.smoke_alarm.interleave_buz | object | 烟雾消失后停止蜂鸣 |
| data.forward.smoke_alarm.poff_tv | integer | 暂停烟感探测 |
| data.forward.smoke_alarm.smoke_detect | integer | 烟感探测 |
| data.forward.switch_auth.switch_auth_sw | string | 交换机认证 |
| data.forward.thirdparty.enable | integer | 启用无线信息采集 |
| data.forward.ueth_dnat_enable.enable | boolean | 启用端口映射 |
| data.forward.ueth_dnat_enable.ueth_ext_dnat_port | integer | 外部访问端口 |
| data.forward.ueth_dnat_enable.ueth_in_dnat_port | integer | 内部映射端口 |
| data.forward.useLine.other_options | object | 其他选项 |
| data.forward.useLine.priorLine | integer | 优先线路 |
| data.forward.useLine.use_line | integer | 2/3/4G线路 |
| data.intelligent.setting.count | integer | 接入人数 |
| data.intelligent.setting.params | object | 负载均衡参数 |
| data.intelligent.setting.priority_channel | boolean | 优先信道 |
| data.wds.wdscheck.ap | object | 桥接到指定接入点 |
| data.wds.wdscheck.enable | boolean | 启用无线中继 |
| data.wds.wdscheck.wdsband | string | 中继频段 |
| data.wds.wdscheck.wdsband_root | string | 根桥频段 |
| data.wds.wdscheck.wdsmode | string | 中继模式 |
| data.wds.wdscheck.wir | object | 禁用连接频段上的无线网络 |
| data.wired.eth_lan_enable_poe_out.enable | null | 启用LAN口POE输出 |
| data.wired.forbid_con_vlan.enable | boolean | 启用禁止协商VLAN |
| data.wired.reject_DHCP_data.enable | boolean | 启用拒绝DHCP数据 |
| data.wired.use_group_config.enable | boolean | 启用使用组配置 |
| data.wired.wiredContainer[].mode | string | 端口模式。取值:access=Access,trunk=Trunk |
| data.wired.wiredContainer[].nat_vlan | string | NAT VLAN |
| data.wired.wiredContainer[].port | string | 端口 |
| data.wired.wiredContainer[].speed | integer | 速率 |
| data.wired.wiredContainer[].type | string | 类型 |
| data.wired.wiredContainer[].vlan | string | VLAN |
| data.wired.wiredContainer[].vlans | string | VLAN列表 |
| data.work_mode.rf1.band | integer | 频段 |
| data.work_mode.rf1.mode | string | 工作模式 |
| data.work_mode.rf2.band | integer | 同 data.work_mode.rf1.band (同构) |
| data.work_mode.rf2.mode | string | 同 data.work_mode.rf1.mode (同构) |
| data.work_mode.rf3.band | integer | 同 data.work_mode.rf1.band (同构) |
| data.work_mode.rf3.mode | string | 同 data.work_mode.rf1.mode (同构) |
| data.work_mode.rf4.band | integer | 同 data.work_mode.rf1.band (同构) |
| data.work_mode.rf4.mode | string | 同 data.work_mode.rf1.mode (同构) |
| data.band.geconfig.rf_optimize.multicast_opt | object | 多播优化 |
| data.band.geconfig.rf_optimize.priority_access | object | 启用5G接入探测帧引导 |
| data.band.geconfig.rf_optimize.probe | object | 关闭广播probe探测 |
| data.band.rf1[].advance.beacon | integer | Beacon周期 |
| data.band.rf1[].advance.dfs | boolean | 干扰退避 |
| data.band.rf1[].advance.dtim | integer | DTIM间隔 |
| data.band.rf1[].advance.enhance_txpower | boolean | 增强覆盖 |
| data.band.rf1[].advance.force_awake_sta | boolean | 强制唤醒终端 |
| data.band.rf1[].advance.guard | boolean | 保护间隔 |
| data.band.rf1[].advance.guard_interval | string | Guard Interval |
| data.band.rf1[].advance.long | boolean | 长前导 |
| data.band.rf1[].advance.mimo | integer | 天线MIMO |
| data.band.rf1[].advance.mpdu | boolean | MPDU聚合帧数 |
| data.band.rf1[].advance.msdu | boolean | MSDU聚合帧数 |
| data.band.rf1[].advance.mu_mimo | boolean | MU-MIMO |
| data.band.rf1[].advance.mult | object | 多播优化设置 |
| data.band.rf1[].advance.multicast_opt | boolean | 多播优化 |
| data.band.rf1[].advance.no_over_rts | integer | 不超过RTS阈值的最大重传 |
| data.band.rf1[].advance.ofdma | boolean | OFDMA |
| data.band.rf1[].advance.over_rts | integer | 超过RTS阈值的最大重传 |
| data.band.rf1[].advance.preamble | string | 前导码类型 |
| data.band.rf1[].advance.probe | boolean | 关闭广播probe探测 |
| data.band.rf1[].advance.rts | integer | RTS阈值 |
| data.band.rf1[].advance.short | boolean | 短前导 |
| data.band.rf1[].advance.slice | integer | 分片阈值 |
| data.band.rf1[].advance.twt | boolean | 目标唤醒时间 |
| data.band.rf1[].advance.uapsd_sw | boolean | UAPSD节能 |
| data.band.rf1[].client_speed_specify.enable | boolean | 启用终端速率限制 |
| data.band.rf1[].client_speed_specify.specify | string | 值 |
| data.band.rf1[].mimo[].text | string | 天线MIMO文本 |
| data.band.rf1[].mimo[].value | integer | 天线MIMO值 |
| data.band.rf1[].probe.enable | boolean | 启用高密优化 |
| data.band.rf1[].probe.mult | object | 高密优化选项 |
| data.band.rf2[].advance.beacon | integer | 同 data.band.rf1[].advance.beacon (同构) |
| data.band.rf2[].advance.dfs | boolean | 同 data.band.rf1[].advance.dfs (同构) |
| data.band.rf2[].advance.dtim | integer | 同 data.band.rf1[].advance.dtim (同构) |
| data.band.rf2[].advance.enhance_txpower | boolean | 同 data.band.rf1[].advance.enhance_txpower (同构) |
| data.band.rf2[].advance.force_awake_sta | boolean | 同 data.band.rf1[].advance.force_awake_sta (同构) |
| data.band.rf2[].advance.guard | boolean | 同 data.band.rf1[].advance.guard (同构) |
| data.band.rf2[].advance.guard_interval | string | 同 data.band.rf1[].advance.guard_interval (同构) |
| data.band.rf2[].advance.long | boolean | 同 data.band.rf1[].advance.long (同构) |
| data.band.rf2[].advance.mimo | integer | 同 data.band.rf1[].advance.mimo (同构) |
| data.band.rf2[].advance.mpdu | boolean | 同 data.band.rf1[].advance.mpdu (同构) |
| data.band.rf2[].advance.msdu | boolean | 同 data.band.rf1[].advance.msdu (同构) |
| data.band.rf2[].advance.mu_mimo | boolean | 同 data.band.rf1[].advance.mu_mimo (同构) |
| data.band.rf2[].advance.mult | object | 同 data.band.rf1[].advance.mult (同构) |
| data.band.rf2[].advance.multicast_opt | boolean | 同 data.band.rf1[].advance.multicast_opt (同构) |
| data.band.rf2[].advance.no_over_rts | integer | 同 data.band.rf1[].advance.no_over_rts (同构) |
| data.band.rf2[].advance.ofdma | boolean | 同 data.band.rf1[].advance.ofdma (同构) |
| data.band.rf2[].advance.over_rts | integer | 同 data.band.rf1[].advance.over_rts (同构) |
| data.band.rf2[].advance.preamble | string | 同 data.band.rf1[].advance.preamble (同构) |
| data.band.rf2[].advance.probe | boolean | 同 data.band.rf1[].advance.probe (同构) |
| data.band.rf2[].advance.rts | integer | 同 data.band.rf1[].advance.rts (同构) |
| data.band.rf2[].advance.short | boolean | 同 data.band.rf1[].advance.short (同构) |
| data.band.rf2[].advance.slice | integer | 同 data.band.rf1[].advance.slice (同构) |
| data.band.rf2[].advance.twt | boolean | 同 data.band.rf1[].advance.twt (同构) |
| data.band.rf2[].advance.uapsd_sw | boolean | 同 data.band.rf1[].advance.uapsd_sw (同构) |
| data.band.rf2[].client_speed_specify.enable | boolean | 同 data.band.rf1[].client_speed_specify.enable (同构) |
| data.band.rf2[].client_speed_specify.specify | string | 同 data.band.rf1[].client_speed_specify.specify (同构) |
| data.band.rf2[].mimo[].text | string | 同 data.band.rf1[].mimo[].text (同构) |
| data.band.rf2[].mimo[].value | integer | 同 data.band.rf1[].mimo[].value (同构) |
| data.band.rf2[].probe.enable | boolean | 同 data.band.rf1[].probe.enable (同构) |
| data.band.rf2[].probe.mult | object | 同 data.band.rf1[].probe.mult (同构) |
| data.band.rf3[].advance.beacon | integer | 同 data.band.rf1[].advance.beacon (同构) |
| data.band.rf3[].advance.dfs | boolean | 同 data.band.rf1[].advance.dfs (同构) |
| data.band.rf3[].advance.dtim | integer | 同 data.band.rf1[].advance.dtim (同构) |
| data.band.rf3[].advance.enhance_txpower | boolean | 同 data.band.rf1[].advance.enhance_txpower (同构) |
| data.band.rf3[].advance.force_awake_sta | boolean | 同 data.band.rf1[].advance.force_awake_sta (同构) |
| data.band.rf3[].advance.guard | boolean | 同 data.band.rf1[].advance.guard (同构) |
| data.band.rf3[].advance.guard_interval | string | 同 data.band.rf1[].advance.guard_interval (同构) |
| data.band.rf3[].advance.long | boolean | 同 data.band.rf1[].advance.long (同构) |
| data.band.rf3[].advance.mimo | integer | 同 data.band.rf1[].advance.mimo (同构) |
| data.band.rf3[].advance.mpdu | boolean | 同 data.band.rf1[].advance.mpdu (同构) |
| data.band.rf3[].advance.msdu | boolean | 同 data.band.rf1[].advance.msdu (同构) |
| data.band.rf3[].advance.mu_mimo | boolean | 同 data.band.rf1[].advance.mu_mimo (同构) |
| data.band.rf3[].advance.mult | object | 同 data.band.rf1[].advance.mult (同构) |
| data.band.rf3[].advance.multicast_opt | boolean | 同 data.band.rf1[].advance.multicast_opt (同构) |
| data.band.rf3[].advance.no_over_rts | integer | 同 data.band.rf1[].advance.no_over_rts (同构) |
| data.band.rf3[].advance.ofdma | boolean | 同 data.band.rf1[].advance.ofdma (同构) |
| data.band.rf3[].advance.over_rts | integer | 同 data.band.rf1[].advance.over_rts (同构) |
| data.band.rf3[].advance.preamble | string | 同 data.band.rf1[].advance.preamble (同构) |
| data.band.rf3[].advance.probe | boolean | 同 data.band.rf1[].advance.probe (同构) |
| data.band.rf3[].advance.rts | integer | 同 data.band.rf1[].advance.rts (同构) |
| data.band.rf3[].advance.short | boolean | 同 data.band.rf1[].advance.short (同构) |
| data.band.rf3[].advance.slice | integer | 同 data.band.rf1[].advance.slice (同构) |
| data.band.rf3[].advance.twt | boolean | 同 data.band.rf1[].advance.twt (同构) |
| data.band.rf3[].advance.uapsd_sw | boolean | 同 data.band.rf1[].advance.uapsd_sw (同构) |
| data.band.rf3[].client_speed_specify.enable | boolean | 同 data.band.rf1[].client_speed_specify.enable (同构) |
| data.band.rf3[].client_speed_specify.specify | string | 同 data.band.rf1[].client_speed_specify.specify (同构) |
| data.band.rf3[].mimo[].text | string | 同 data.band.rf1[].mimo[].text (同构) |
| data.band.rf3[].mimo[].value | integer | 同 data.band.rf1[].mimo[].value (同构) |
| data.band.rf3[].probe.enable | boolean | 同 data.band.rf1[].probe.enable (同构) |
| data.band.rf3[].probe.mult | object | 同 data.band.rf1[].probe.mult (同构) |
| data.band.rf4[].advance.beacon | integer | 同 data.band.rf1[].advance.beacon (同构) |
| data.band.rf4[].advance.dfs | boolean | 同 data.band.rf1[].advance.dfs (同构) |
| data.band.rf4[].advance.dtim | integer | 同 data.band.rf1[].advance.dtim (同构) |
| data.band.rf4[].advance.enhance_txpower | boolean | 同 data.band.rf1[].advance.enhance_txpower (同构) |
| data.band.rf4[].advance.force_awake_sta | boolean | 同 data.band.rf1[].advance.force_awake_sta (同构) |
| data.band.rf4[].advance.guard | boolean | 同 data.band.rf1[].advance.guard (同构) |
| data.band.rf4[].advance.guard_interval | string | 同 data.band.rf1[].advance.guard_interval (同构) |
| data.band.rf4[].advance.long | boolean | 同 data.band.rf1[].advance.long (同构) |
| data.band.rf4[].advance.mimo | integer | 同 data.band.rf1[].advance.mimo (同构) |
| data.band.rf4[].advance.mpdu | boolean | 同 data.band.rf1[].advance.mpdu (同构) |
| data.band.rf4[].advance.msdu | boolean | 同 data.band.rf1[].advance.msdu (同构) |
| data.band.rf4[].advance.mu_mimo | boolean | 同 data.band.rf1[].advance.mu_mimo (同构) |
| data.band.rf4[].advance.mult | object | 同 data.band.rf1[].advance.mult (同构) |
| data.band.rf4[].advance.multicast_opt | boolean | 同 data.band.rf1[].advance.multicast_opt (同构) |
| data.band.rf4[].advance.no_over_rts | integer | 同 data.band.rf1[].advance.no_over_rts (同构) |
| data.band.rf4[].advance.ofdma | boolean | 同 data.band.rf1[].advance.ofdma (同构) |
| data.band.rf4[].advance.over_rts | integer | 同 data.band.rf1[].advance.over_rts (同构) |
| data.band.rf4[].advance.preamble | string | 同 data.band.rf1[].advance.preamble (同构) |
| data.band.rf4[].advance.probe | boolean | 同 data.band.rf1[].advance.probe (同构) |
| data.band.rf4[].advance.rts | integer | 同 data.band.rf1[].advance.rts (同构) |
| data.band.rf4[].advance.short | boolean | 同 data.band.rf1[].advance.short (同构) |
| data.band.rf4[].advance.slice | integer | 同 data.band.rf1[].advance.slice (同构) |
| data.band.rf4[].advance.twt | boolean | 同 data.band.rf1[].advance.twt (同构) |
| data.band.rf4[].advance.uapsd_sw | boolean | 同 data.band.rf1[].advance.uapsd_sw (同构) |
| data.band.rf4[].client_speed_specify.enable | boolean | 同 data.band.rf1[].client_speed_specify.enable (同构) |
| data.band.rf4[].client_speed_specify.specify | string | 同 data.band.rf1[].client_speed_specify.specify (同构) |
| data.band.rf4[].mimo[].text | string | 同 data.band.rf1[].mimo[].text (同构) |
| data.band.rf4[].mimo[].value | integer | 同 data.band.rf1[].mimo[].value (同构) |
| data.band.rf4[].probe.enable | boolean | 同 data.band.rf1[].probe.enable (同构) |
| data.band.rf4[].probe.mult | object | 同 data.band.rf1[].probe.mult (同构) |
| data.channel_power.rf1[].advance.all_channel_list_enable | boolean | 全信道模式 |
| data.channel_power.rf1[].advance.power_enhance | boolean | 功率增强 |
| data.channel_power.rf1[].transmit_power.value | integer | 发射功率值 |
| data.channel_power.rf2[].advance.all_channel_list_enable | boolean | 同 data.channel_power.rf1[].advance.all_channel_list_enable (同构) |
| data.channel_power.rf2[].advance.power_enhance | boolean | 同 data.channel_power.rf1[].advance.power_enhance (同构) |
| data.channel_power.rf2[].transmit_power.value | integer | 同 data.channel_power.rf1[].transmit_power.value (同构) |
| data.channel_power.rf3[].advance.all_channel_list_enable | boolean | 同 data.channel_power.rf1[].advance.all_channel_list_enable (同构) |
| data.channel_power.rf3[].advance.power_enhance | boolean | 同 data.channel_power.rf1[].advance.power_enhance (同构) |
| data.channel_power.rf3[].transmit_power.value | integer | 同 data.channel_power.rf1[].transmit_power.value (同构) |
| data.channel_power.rf4[].advance.all_channel_list_enable | boolean | 同 data.channel_power.rf1[].advance.all_channel_list_enable (同构) |
| data.channel_power.rf4[].advance.power_enhance | boolean | 同 data.channel_power.rf1[].advance.power_enhance (同构) |
| data.channel_power.rf4[].transmit_power.value | integer | 同 data.channel_power.rf1[].transmit_power.value (同构) |
| data.forward.bluetooth.blue_tooth.blue_tooth_fun | integer | 蓝牙功能 |
| data.forward.bluetooth.blue_tooth.major | integer | major |
| data.forward.bluetooth.blue_tooth.minor | integer | minor |
| data.forward.bluetooth.blue_tooth.uuid | string | uuid |
| data.forward.maintainReport.maintainReportWrap.isReport | string | 业务感知信息上报 |
| data.forward.maintainReport.maintainReportWrap.tcpStatistics | boolean | TCP质量统计 |
| data.forward.smoke_alarm.interleave_buz.enable | boolean | 启用烟雾消失后停止蜂鸣 |
| data.forward.useLine.other_options.apn | object | APN |
| data.forward.useLine.other_options.line_check | object | 链路检测 |
| data.forward.useLine.other_options.network_mode | object | 网络模式 |
| data.forward.useLine.other_options.pin | object | PIN码 |
| data.intelligent.setting.params.adjust_rssi_limit | null | 信号强度阈值 |
| data.intelligent.setting.params.join_person_limit | integer | 接入人数差值 |
| data.wds.wdscheck.ap.enable | boolean | 启用桥接 |
| data.wds.wdscheck.ap.mac | string | 桥接接入点MAC |
| data.wds.wdscheck.wir.enable | boolean | 启用禁用连接频段上的无线网络 |
| data.band.geconfig.rf_optimize.multicast_opt.enable | boolean | 多播优化 |
| data.band.geconfig.rf_optimize.multicast_opt.mult | object | 多播优化设置 |
| data.band.geconfig.rf_optimize.priority_access.enable | boolean | 启用5G接入探测帧引导 |
| data.band.geconfig.rf_optimize.priority_access.mult | object | 5g优选选项 |
| data.band.geconfig.rf_optimize.probe.enable | boolean | 启用关闭广播probe探测 |
| data.band.geconfig.rf_optimize.probe.mult | object | 关闭广播probe探测选项 |
| data.band.rf1[].advance.mult.ignore_client_enble | boolean | 忽略客户端 |
| data.band.rf1[].advance.mult.mult_bw_flow | integer | 多播带宽流 |
| data.band.rf1[].advance.mult.mult_weight_value | integer | 多播权重值 |
| data.band.rf1[].probe.mult.gao_fa_v | integer | 报文发送速率 |
| data.band.rf1[].probe.mult.safe_signalValue | integer | 生效信号强度阈值 |
| data.band.rf2[].advance.mult.ignore_client_enble | boolean | 同 data.band.rf1[].advance.mult.ignore_client_enble (同构) |
| data.band.rf2[].advance.mult.mult_bw_flow | integer | 同 data.band.rf1[].advance.mult.mult_bw_flow (同构) |
| data.band.rf2[].advance.mult.mult_weight_value | integer | 同 data.band.rf1[].advance.mult.mult_weight_value (同构) |
| data.band.rf2[].probe.mult.gao_fa_v | integer | 同 data.band.rf1[].probe.mult.gao_fa_v (同构) |
| data.band.rf2[].probe.mult.safe_signalValue | integer | 同 data.band.rf1[].probe.mult.safe_signalValue (同构) |
| data.band.rf3[].advance.mult.ignore_client_enble | boolean | 同 data.band.rf1[].advance.mult.ignore_client_enble (同构) |
| data.band.rf3[].advance.mult.mult_bw_flow | integer | 同 data.band.rf1[].advance.mult.mult_bw_flow (同构) |
| data.band.rf3[].advance.mult.mult_weight_value | integer | 同 data.band.rf1[].advance.mult.mult_weight_value (同构) |
| data.band.rf3[].probe.mult.gao_fa_v | integer | 同 data.band.rf1[].probe.mult.gao_fa_v (同构) |
| data.band.rf3[].probe.mult.safe_signalValue | integer | 同 data.band.rf1[].probe.mult.safe_signalValue (同构) |
| data.band.rf4[].advance.mult.ignore_client_enble | boolean | 同 data.band.rf1[].advance.mult.ignore_client_enble (同构) |
| data.band.rf4[].advance.mult.mult_bw_flow | integer | 同 data.band.rf1[].advance.mult.mult_bw_flow (同构) |
| data.band.rf4[].advance.mult.mult_weight_value | integer | 同 data.band.rf1[].advance.mult.mult_weight_value (同构) |
| data.band.rf4[].probe.mult.gao_fa_v | integer | 同 data.band.rf1[].probe.mult.gao_fa_v (同构) |
| data.band.rf4[].probe.mult.safe_signalValue | integer | 同 data.band.rf1[].probe.mult.safe_signalValue (同构) |
| data.forward.useLine.other_options.apn.apn | string | apn |
| data.forward.useLine.other_options.apn.password | string | password |
| data.forward.useLine.other_options.apn.username | string | username |
| data.forward.useLine.other_options.line_check.fail_threshold | integer | 失败次数阈值 |
| data.forward.useLine.other_options.line_check.interval | integer | 检测间隔 |
| data.forward.useLine.other_options.line_check.ip | string | 目标IP列表 |
| data.forward.useLine.other_options.network_mode.network_mode | integer | 网络模式 |
| data.forward.useLine.other_options.pin.enable | object | 开启自动解锁PIN码功能 |
| data.band.geconfig.rf_optimize.multicast_opt.mult.ignore_client_enble | boolean | 忽略客户端 |
| data.band.geconfig.rf_optimize.multicast_opt.mult.mult_bw_flow | integer | 多播带宽流 |
| data.band.geconfig.rf_optimize.multicast_opt.mult.mult_weight_value | integer | 多播权重值 |
| data.band.geconfig.rf_optimize.priority_access.mult.groups | array | 例外的终端 |
| data.band.geconfig.rf_optimize.priority_access.mult.priority_mode | integer | 引导模式 |
| data.band.geconfig.rf_optimize.priority_access.mult.signalValue | integer | 生效信号强度阈值 |
| data.band.geconfig.rf_optimize.probe.mult.gao_fa_v | integer | 报文发送速率 |
| data.forward.useLine.other_options.pin.enable.close_pin | object | 解锁成功后关闭PIN码保护 |
| data.forward.useLine.other_options.pin.enable.enable | boolean | 开启自动解锁PIN码功能 |
| data.forward.useLine.other_options.pin.enable.pin | string | PIN码 |
| data.forward.useLine.other_options.pin.enable.close_pin.enable | boolean | 解锁成功后关闭PIN码保护 |
⚠️ modify 提交基础:建议以本接口返回的完整 data 对象为底,再覆盖要修改的字段提交 modify,避免丢字段
后续接口取值:无(本接口返回的是当前记录已选定的配置值,不构成候选集,不作为任何字段的数据来源;仅用于接口(modify)的提交基础回填)
2.14 区域详情
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | listDetail_area | - | - |
| branch_id | integer | 否 | 分支 ID(0=当前登录分支) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data | object | 是 | 详情查询对象 | - | - |
| data.id | integer | 是 | 区域 ID(服务端强制,缺省报"记录不存在") | /index.php/wl_apgroup/query_aparea_tree | $.data.tree[].id |
| data.branch_id | integer | 否 | 数据所属分支 ID(前端回带) | - | - |
请求示例
{
"opr": "listDetail_area",
"branch_id": 0,
"data": {
"id": 101,
"branch_id": 0
}
}
响应 Body
{
"data": {
"id": 101,
"name": "AAA",
"desc": "",
"path": {
"id": 100,
"text": "/本机"
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 区域详情对象 |
| data.id | integer | 区域 ID |
| data.name | string | 区域名称 |
| data.desc | string | 区域描述(无描述时为空串) |
| data.path | object | 上级区域路径对象 |
| data.path.id | integer | 上级区域 ID(无上级时为 -1) |
| data.path.text | string | 上级区域全路径名称(如 "/本机"、"所有区域") |
| success | boolean | 请求是否成功 |
后续接口取值:无(本接口返回的是当前区域已选定的值,不构成候选集,不作为任何字段的数据来源;仅用于接口10(modify_area)的提交基础回填)
2.15 区域编辑
请求表单schema
本接口使用表单 schema:wl_apgroup.add_area.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | modify_area | - | - |
| branch_id | integer | 否 | 分支 ID(0=当前登录分支) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data | object | 是 | 区域配置对象 | - | - |
| data.id | string | 是 | 区域 ID。规则:required(配置中拼写为 requried,服务端按 alias group_id 校验) |
/index.php/wl_apgroup/query_aparea_tree | $.data.tree[].id |
| data.name | string | 是 | 区域名称。规则:required, callback[check_text](名称合法性校验) | - | - |
| data.desc | string | 否 | 描述。规则:callback[check_desc][1](字节长度上限 99) | - | - |
| data.path | object | 否 | 上级区域对象 | - | - |
| data.path.id | integer | 否 | 上级区域 ID(-1 或省略表示置为根;否则服务端校验父级合法性) | /index.php/wl_apgroup/query_aparea_tree | $.data.tree[].id |
| data.path.text | string | 否 | 上级区域名称(前端回带) | - | - |
请求示例
{
"opr": "modify_area",
"branch_id": 0,
"data": {
"id": "101",
"name": "AAA",
"desc": "",
"path": {
"id": 102,
"text": "/本机/BBB"
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
| msg | array[string] | 失败原因(成功时无此字段) |
⚠️ 服务端固定按 apg_type=2(区域)类型更新;
data.path.id为 -1 时服务端 unset 该键(表示移动到根区域)。
⚠️ modify_area 提交基础:建议以 listDetail_area 返回的完整 data 对象为底,再覆盖要改的字段,避免丢字段。
后续接口取值:无(叶子操作;修改后页面重新查询接口3(query_aparea_tree)刷新区域树展示)
2.16 AP 组/区域删除
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | delete | - | - |
| delete_confirm | boolean | 否 | 删除确认标记;二次确认后置 true,否则为 false | - | - |
| branch_id | integer | 否 | 分支 ID(0=当前登录分支) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data | array | 是 | 待删除对象数组(按分支分组,每项一个分支) | - | - |
| data[].branch_id | integer | 是 | 该组记录所属的分支 ID | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].branch_id |
| data[].apg | array | 是 | 该分支下待删除的 AP 组/区域 id 数组 | - | - |
| data[].apg[].id | integer | 是 | AP 组/区域 ID(query_apgroup_tree 树同时含 AP 组与区域节点,两者皆可删) | /index.php/wl_apgroup/query_apgroup_tree | $.data.tree[].id |
请求示例
{
"opr": "delete",
"delete_confirm": false,
"data": [
{
"branch_id": 0,
"apg": [
{
"id": 7
}
]
}
],
"branch_id": 0
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
| msg | array[string] | 删除失败原因(如"该AP分组已被射频防护策略XXX引用");成功时无此字段 |
后续接口取值:无(叶子操作;删除后页面重新查询接口2/3 的树刷新展示)
2.17 集中管理分支列表
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | listBranch | - | - |
| switch_type | string | 否 | 分支类型过滤,固定值 "all" 表示返回全部集中管理分支 | - | - |
请求示例
{
"opr": "listBranch",
"switch_type": "all"
}
响应 Body
{
"data": {
"all": true,
"tree": [
{
"id": 0,
"name": "三楼办公环境",
"group_id": 0
}
]
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
| data | object | 返回数据根对象 |
| data.all | boolean | 是否返回全部分支(true=已加载完整列表) |
| data.tree | array[object] | 分支节点数组(每项为一个集中管理分支) |
| data.tree[].id | integer | 分支 id(0=本机/默认分支) |
| data.tree[].name | string | 分支显示名(如"三楼办公环境",环境不同会变化) |
| data.tree[].group_id | integer | 所属分组 id(默认 0) |
后续接口取值:本接口返回
data.tree[].id(分支 id)与data.tree[].name(分支名),供交换机管理、集中监控等按分支过滤的页面用作分支下拉/树选择数据源,取值路径$.data.tree[].id
2.18 接入点参数下拉列表
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | list_brief | - | - |
| branch_type | string | 否 | 分支类型,页面上下文决定 | - | - |
请求示例
{
"opr": "list_brief",
"branch_type": "wac"
}
响应 Body
{
"data": [
{
"id": 0,
"name": "NMC/NAC系列AP默认参数"
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array[object] | AP组下拉候选列表 |
| data[].id | integer | AP参数ID |
| data[].name | string | AP参数名称 |
| success | boolean | 请求是否成功 |
后续接口取值:本接口返回
data[].id与data[].name作为 AP 组下拉候选,供需要选择 AP 组的接口取用(如上面接口 的 data.apgrp_params.id/ data.apgrp_params.name),取值路径$.data[].id/$.data[].name
2.19 AP信道调整
接口名称: wl_ap_channelmodify
接口功能说明: 修改AP射频信道、带宽、发射功率
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定为 channelmodify |
| branch_id | integer | 是 | 分支ID,0 表示根分支 |
| data | object | 是 | 信道调整数据容器 |
| data.id | string | 是 | AP的ID |
| data.vap_ref | string | 否 | VAP引用ID(默认空字符串) |
| data.train_ref | string | 否 | 列车引用ID(默认空字符串) |
| data.cochannel_ref | string | 否 | 同频引用ID(默认空字符串) |
| data.hd_alias | string | 否 | 硬件别名 |
| data.pattern | string | 否 | 硬件型号pattern |
| data.software_version | string | 否 | 软件版本 |
| data.client_ap_enable | string/boolean | 否 | 是否启用客户端AP:"false" 或 false |
| data.client_ap_radio | string | 否 | 客户端AP射频(默认空字符串) |
| data.channel_rf1 | object | 是 | RF1信道配置(key为射频ID) |
| data.channel_rf1.1 | object | 是 | RF1射频1的配置 |
| data.channel_rf1.1.enable | boolean | 是 | 是否启用:true/false |
| data.channel_rf1.1.mode | integer | 是 | 射频模式(网络协议):1=b, 2=g, 3=b/g, 4=n, 5=b/g/n, 6=a, 7=a/n, 8=ac, 9=a/n/ac, 10=b/g/n/ax, 11=a/n/ac/ax, 12=b/g/n/ax/be, 13=a/n/ac/ax/be |
| data.channel_rf1.1.bandwidth | integer | 是 | 信道带宽:1=20 MHz, 2=40 MHz Plus, 3=40 MHz Minus, 4=自动(Auto), 5=80 MHz, 6=160 MHz, 7=240 MHz, 8=320 MHz |
| data.channel_rf1.1.channel | integer | 是 | 信道号,0=自动 |
| data.channel_rf1.1.transmit_power | object | 是 | 发射功率容器 |
| data.channel_rf1.1.transmit_power.value | string/integer | 是 | 发射功率值(字符串形式):0=自动(默认), 255=最大功率, 30=1000mw/30dBm, 27=500mw/27dBm, 25=316mw/25dBm, 23=200mw/23dBm, 22=158mw/22dBm, 21=125mw/21dBm, 20=100mw/20dBm, 19=79mw/19dBm, 18=63mw/18dBm, 17=50mw/17dBm, 16=40mw/16dBm, 15=32mw/15dBm, 14=25mw/14dBm, 13=20mw/13dBm, 12=16mw/12dBm, 11=13mw/11dBm, 10=10mw/10dBm, 9=8mw/9dBm, 8=6mw/8dBm, 7=5mw/7dBm, 6=4mw/6dBm, 5=3.5mw/5dBm, 4=3mw/4dBm, 3=2mw/3dBm |
| data.channel_rf2 | object | 否 | RF2信道配置(结构同 channel_rf1) |
| data.channel_rf2.2 | object | 否 | RF2射频2的配置(结构同 channel_rf1.1) |
请求示例
{
"opr": "channelmodify",
"branch_id": 0,
"data": {
"id": "4803767224631296",
"vap_ref": "",
"train_ref": "",
"cochannel_ref": "",
"hd_alias": "ap-370-t",
"pattern": "NAP-3700",
"software_version": "AP3.16.0 BUILD20250930-023556",
"client_ap_enable": "false",
"client_ap_radio": "",
"channel_rf1": {
"1": {
"enable": true,
"mode": 12,
"bandwidth": 1,
"channel": 4,
"transmit_power": {"value": "22"}
}
},
"channel_rf2": {
"2": {
"enable": true,
"mode": 9,
"bandwidth": 3,
"channel": 56,
"transmit_power": {"value": "27"}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
三、表单schema定义
1. wl_ap.add_normal_ap.json
使用接口:/index.php/wl_ap/add_normal_ap(2.4)、/index.php/wl_ap/modify(2.5)
{
"title": "新增/编辑接入点",
"description": "接入点管理 - 新增或编辑一台接入点的提交数据结构",
"x-api": {
"url": "/index.php/wl_ap",
"opr": {
"add": "add_normal_ap",
"edit": "modify"
},
"x-comment": "新增场景 opr=add_normal_ap,编辑场景 opr=modify,共用接口 /index.php/wl_ap。新增与编辑共用同一 data 结构(编辑场景以接入点详情回填的完整 data 为基础覆盖修改项)。调用方可选传入 confirmMsg=true 启用二次确认交互;branch_id 为可选上下文参数(中心端为 0)。"
},
"x-page": {
"path": "/wireless/NewAP",
"menu": "无线网络 → 发现新接入点",
"功能": "新增或修改一台接入点的完整配置(基础信息、部署方式、射频参数、WDS、隧道、转发、DHCP、有线口等)。"
},
"type": "object",
"properties": {
"opr": {
"type": "string",
"enum": ["add_normal_ap", "modify"],
"x-comment": "操作类型:新增传 add_normal_ap,编辑传 modify。"
},
"branch_id": {
"type": ["string", "integer"],
"x-comment": "分支 ID;中心端场景传 0(整数或字符串形式均可,文档类型 integer/string),分权分支场景传对应分支 ID。可选。"
},
"confirmMsg": {
"type": "boolean",
"x-comment": "可选。传 true 表示要求前端进行二次确认后提交。"
},
"data": {
"type": "object",
"properties": {
"ap_discovery": {
"type": "object",
"properties": {
"controller_domain": {
"type": "string",
"x-component": "ipv6",
"x-comment": "控制器域名 校验规则由公共校验项 `ipv6` 提供(见 x-component)。"
},
"controller_ip": {
"type": "string",
"x-component": "validateMultipleIPs",
"x-comment": "控制器IP;多行 IPv4/IPv6 地址列表,逗号或换行分隔,按行去重去空 trim;每行允许取值:IPv4 须合法且排除组播/保留/E 类/以 0 开头/全 0/全 1;IPv6 须合法且按 /64 前缀排除环回/全 0/前缀全 0/站点本地/组播/唯一本地 校验规则由公共校验项 `validateMultipleIPs` 提供(见 x-component)。"
},
"enable": {
"type": "boolean",
"x-comment": "启用云发现"
},
"enableWADiscover": {
"type": "boolean"
},
"local_backup_ip": {
"type": "string",
"x-component": "validateSingleIP",
"x-comment": "slave_controller_ip_domain;备控制器IP\\域名;每行允许取值:IPv4 须合法且不能全 0、E 类、组播、全 1、保留、以 0 开头;IPv6(按 /64 前缀)须合法且不能环回、全 0、前缀全 0、站点本地、组播、唯一本地 校验规则由公共校验项 `validateSingleIP` 提供(见 x-component)。"
},
"local_ip": {
"type": "string",
"x-component": "validateSingleIP",
"x-comment": "master_controller_ip_domain;主控制器IP\\域名;每行允许取值:IPv4 须合法且不能全 0、E 类、组播、全 1、保留、以 0 开头;IPv6(按 /64 前缀)须合法且不能环回、全 0、前缀全 0、站点本地、组播、唯一本地 校验规则由公共校验项 `validateSingleIP` 提供(见 x-component)。"
},
"sequenceNO": {
"type": "string",
"pattern": "^[0-9A-Za-z]{8,16}$",
"x-comment": "校验规则由公共校验项 `SequenceNO` 提供(见 x-component)。"
}
},
"x-control_chain": {
"enable": true
},
"x-comment": "接入点发现 仅当 enable 开启 时才需要/允许提交。"
},
"branch_type": {
"type": "string",
"x-comment": "分支类型"
},
"group": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dlink_type": {
"type": "string",
"x-comment": "下联设备类型"
},
"id": {
"type": "integer",
"x-numeric_range": {
"minimum": 0
},
"x-comment": "分组 ID;整形或字符串形式的标识符(正则 /^[\\w\\-]+$/)"
},
"multi_rf": {
"type": "string"
},
"path": {
"type": "string"
},
"type": {
"type": "string",
"x-comment": "符合 /^[\\w\\-]+$/,长度 1~95,样本 grp"
}
}
},
"x-comment": "所属组;AP 分组列表(数组,元素为 group 对象,通常仅一项)"
},
"hd_alias": {
"type": "string"
},
"id": {
"type": "string",
"x-readonly": true,
"x-comment": "ID 只读回显字段,由前端从接入点详情带入后原样回传。"
},
"mac": {
"type": "string",
"x-comment": "MAC地址。"
},
"name": {
"type": "string",
"pattern": "^[\\u4e00-\\u9fa5a-zA-Z\\d_\\-\\:\\s\\.\\/]*$",
"minLength": 1,
"maxLength": 95,
"x-comment": "AP名称"
},
"pattern": {
"type": "string",
"x-readonly": true,
"x-comment": "硬件型号;字节长度 min_length~max_length(默认 1~95) 只读回显字段,由前端从接入点详情带入后原样回传。"
},
"position": {
"type": "string",
"x-comment": "AP地理位置:[0-99]个字符,支持中文(简体,繁体),英文[a-zA-Z]字符,数字[0-9],和特殊符号[-:_./]及空格"
},
"sequenceNO": {
"type": "string",
"x-comment": "序列号"
},
"version": {
"type": "string",
"x-comment": "版本"
}
},
"x-comment": "业务数据对象",
"required": ["name"]
}
},
"required": ["data"],
"x-comment": "本表单对应接入点管理页面的「新增/编辑接入点」弹窗。顶层 data 下带 enable 开关的子对象(如 deploy/advance/wan_lan/ap_discovery 等),仅在开关为 true 时其内部字段才生效。提交前前端会对若干字段做标准化改写(见各字段 x-comment),服务端最终收到的以改写后的值为准。"
}
2. wl_apgroup.add.json
使用接口:/index.php/wl_apgroup/add(2.10)、/index.php/wl_apgroup/modify(2.12)
{
"title": "接入点分组",
"description": "接入点分组新增/编辑 — 字段契约(面向外部开放接口)",
"x-api": {
"url": "/index.php/wl_apgroup",
"opr": {
"add": "add",
"edit": "modify"
},
"x-comment": "新增与编辑为同一接口,提交时由调用方按场景传 opr:新增传 add、编辑传 modify。参数结构见 data。注意:本接口是「接入点分组」(AP 组,服务端固定 apg_type=1),不要与「区域新增/编辑」(opr=add_area / modify_area)及「接入点参数」(/index.php/wl_apgrp_params)等同类接口混淆。"
},
"x-page": {
"path": "/sdwlan/ap/APManage",
"menu": "无线管理 → 接入点 → 接入点管理(分组操作)",
"功能": "在接入点管理页面的分组树中新增或编辑一个接入点分组(AP 组),设置其名称、所属区域、接入点参数;编辑时名称、描述、所属区域、接入点参数均可修改。"
},
"type": "object",
"properties": {
"opr": {
"type": "string",
"enum": [
"add",
"modify"
],
"x-comment": "操作类型;新增传 add,编辑传 modify。(同一接口,按场景传值;无缺省回退值,必须显式传)"
},
"branch_id": {
"type": "integer",
"x-comment": "分支 ID(分权上下文)。非本表单编辑的字段,值由页面当前所处分支环境注入(0 表示当前登录分支)。对接方可选传,不传时按 0 处理。"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"x-comment": "分组 ID(字符串形态)。必填性随场景变化:新增(opr=add)时提交空串,由服务端生成新 ID,此时非必填;编辑(opr=modify)时必填,须提交从分组树查询接口取到的待修改分组 ID。取值来源:分组树查询接口返回的 $.data.tree[].id。"
},
"name": {
"type": "string",
"x-component": "nametextfield",
"x-required": true,
"x-comment": "接入点分组名称;新增与编辑均必填。名称的字符范围与长度约束由公共组件 nametextfield 统一提供(见 x-component),本契约不重复罗列。"
},
"desc": {
"type": "string",
"x-comment": "描述。注意:本表单中该字段不渲染给用户填写(界面上始终隐藏),提交时按接口文档回带原值(通常为空串),除非对接方明确需要,否则保持原样回传即可。"
},
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"x-comment": "所属区域 ID(区域树中 apg_type=2 的区域节点)。取值来源:区域树查询接口返回的 $.data.tree[].id。"
},
"text": {
"type": "string",
"x-comment": "所属区域完整路径(由区域树选择结果回带,用于界面显示)。如 \"/三楼办公环境/areatest\"。"
},
"display_text": {
"type": "string",
"x-comment": "去除根区域前缀后的显示路径(界面回带用)。仅编辑场景(opr=modify)在回带数据中出现;新增时为对接方按需回传的可选字段。"
}
},
"x-required": true,
"x-comment": "所属区域;新增时必选(未选择时前端会拦截提交)。对接方按区域 ID(path.id,区域节点)传值;path.text / path.display_text 为显示用回带文本,不参与业务判定。"
},
"apgrp_params": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
],
"x-comment": "接入点参数 ID,0 表示使用默认参数。取值来源:接入点参数简表接口返回的 $.data[].id。新增场景提交为数字(如 0),编辑场景页面回带为字符串(如 \"0\"),故类型允许 integer 或 string,服务端两者均接受。"
},
"name": {
"type": "string",
"x-comment": "接入点参数名称(界面回带显示用),如 \"NMC/NAC系列AP默认参数\"。"
}
},
"x-comment": "接入点参数(下拉选择,前端提交所选参数的完整对象 id + name)。注意:编辑已有分组时,若该分组已被射频防护策略引用,前端会禁止修改该选项(界面置灰并提示「当前接入点分组已被射频防护策略引用,不允许更改接入点参数。」),此时应回带原值不变。本字段的「可否修改」由页面环境(是否被策略引用)决定,不是提交参数本身。"
}
},
"required": [
"name",
"path"
],
"x-comment": "data 为整个分组配置对象。基础必填为 name、path;此外编辑场景(opr=modify)下 id 也为必填(见根级条件约束)。服务端固定按「AP 组」(apg_type=1)类型创建记录。编辑(opr=modify)时建议以「AP 组详情」查询返回的完整 data 为底、再覆盖要改的字段,避免因漏传而丢失未在界面上暴露的配置项。"
}
},
"allOf": [
{
"if": {
"properties": {
"opr": {
"const": "modify"
}
}
},
"then": {
"properties": {
"data": {
"required": [
"id"
]
}
}
}
}
],
"required": [
"opr",
"data"
],
"x-comment": "外部输入字段集合(data 内):id、name、desc、path(id/text/display_text)、apgrp_params(id/name)。另需在请求顶层传 opr(add/modify)与可选 branch_id:编辑场景(opr=modify)时 data.id 必填,新增场景(opr=add)时 data.id 传空串即可(见根级 allOf 条件约束)。本文件只描述表单字段契约;具体取值规则细节以服务端实际校验为准。"
}
3. wl_apgroup.add_area.json
使用接口:/index.php/wl_apgroup/add_area(2.11)、/index.php/wl_apgroup/modify_area(2.15)
{
"title": "区域表单",
"description": "AP 区域(无线区域)新增/编辑表单。用于在指定上级区域下新建区域,或修改已有区域的名称、描述、所属区域。提交时以对象整体提交(data 内所有字段)。服务端固定创建为「区域」类型记录。",
"x-api": {
"url": "/index.php/wl_apgroup",
"opr": {
"add": "add_area",
"edit": "modify_area"
},
"x-comment": "新增区域提交 opr=add_area,编辑区域提交 opr=modify_area(另有列表详情接口 opr=listDetail_area 仅用于编辑前回显数据,不属本表单提交动作)。本表单被「接入点管理」「交换机管理」等多个模块复用,提交地址随调用模块而变:接入点管理下为 /index.php/wl_apgroup,交换机管理下为 /index.php/wl_switch,物联网关管理下为 /index.php/wl_igw_group 且新增 opr 为 create_area;此处取「接入点管理」模块的接口为契约基准。对接方以实际调用模块的路由为准,opr 语义(add_area=新增、modify_area=编辑)各模块一致。"
},
"x-page": {
"path": "wireless/APList(接入点管理页面内「区域」弹窗)",
"menu": "接入点管理 → 左侧区域/分组树 → 新增区域 / 修改区域",
"功能": "在 AP 区域树中新增一个区域节点,或修改既有区域节点的名称、描述与所属区域。",
"x-comment": "本表单为页面内弹窗表单,不单独占路由;入口为「接入点管理」等页面的区域树右键/工具栏操作。"
},
"type": "object",
"properties": {
"opr": {
"type": "string",
"enum": [
"add_area",
"modify_area"
],
"x-comment": "操作类型;提交时作为顶层参数传入。新增传 add_area,编辑传 modify_area。"
},
"branch_id": {
"type": "integer",
"x-comment": "分支(多租户/分支机构)ID;由页面运行环境注入,非用户填写项。0 表示当前登录分支。取值来自分支列表接口,对接方可选传。",
"default": 0
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"x-readonly": true,
"x-comment": "区域 ID;仅编辑场景有效。新增时传空串(服务端生成新 id),编辑时原样回传所编辑区域的 ID。"
},
"name": {
"type": "string",
"x-component": "nametextfield",
"x-comment": "区域名称;必填。校验规则由公共组件 `nametextfield` 提供(见 x-component);具体正则/长度约束由「公共校验提取」环节统一注入,本文件不复制。"
},
"desc": {
"type": "string",
"x-comment": "区域描述;选填。校验规则由公共校验提供(描述合法性/字节长度上限);具体约束由「公共校验提取」环节统一注入,本文件不复制。"
},
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"x-comment": "所选上级区域的 ID(整数;字符串形态亦被服务端接受)。后端在创建时并不持久化该键,仅用于定位父级,服务端最终把新区域挂到当前分支根下。取值来自区域树查询接口的节点 id。"
},
"text": {
"type": "string",
"x-comment": "所选上级区域的完整路径文本(由区域树各级名称以路径方式拼接而成);仅用于界面回显,服务端以 path.id 为准。"
}
},
"x-comment": "所属区域;前端从区域树下拉中选中一个节点后,取该节点的 {id, text} 整体作为本字段值提交。前端将其视为必填(未选择无法提交),但服务端不将其作为必填参数(可选)。"
}
},
"required": [
"name"
]
}
},
"required": [
"opr",
"data"
]
}
射频控制策略接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
/index.php/rf_ctr_policy/add |
创建射频控制策略并配置适用 AP、关闭时间计划和排除无线网络 |
/index.php/wl_option/get_timeplan |
查询可选时间计划 |
/index.php/wl_network/list_wlan |
查询可选无线网络 |
/index.php/rf_ctr_policy/get_ap_tree |
查询接入点分组树 |
/index.php/rf_ctr_policy/list |
按名称搜索射频控制策略 |
/index.php/rf_ctr_policy/listDetail |
按策略标识查询策略详情 |
/index.php/rf_ctr_policy/modify |
修改射频控制策略及关联资源 |
/index.php/rf_ctr_policy/disable |
批量禁用射频控制策略 |
/index.php/rf_ctr_policy/enable |
批量启用射频控制策略 |
/index.php/rf_ctr_policy/delete |
批量删除射频控制策略 |
二、接口详细说明
2.1 新增射频控制策略
- 接口标识:
rf_ctr_policy_add - 功能说明: 创建射频控制策略并配置适用 AP、关闭时间计划和排除无线网络
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
data |
object | 是 | 业务数据 |
data.name |
string | 是 | 名称 |
data.desc |
string | 否 | 描述 |
data.ap_conf |
array | 是 | AP 节点配置 |
data.ap_conf[] |
object | 是 | AP 节点配置 |
data.ap_conf[].id |
integer | 是 | 标识 |
data.ap_conf[].type |
string | 是 | 类型 |
data.ap_conf[].platform |
integer | 是 | 平台类型 |
data.ap_conf[].key_id |
string | 是 | 树节点键 |
data.ap_conf[].name |
string | 是 | 名称;修改请求要求以 / 开头 |
data.enable |
boolean | 是 | 是否启用 |
data.close_time |
object | 是 | 关闭时间计划 |
data.close_time.id |
integer | 是 | 标识 |
data.exclude_wlan_id |
array | 是 | 排除无线网络 |
data.exclude_wlan_id[] |
object | 是 | 排除无线网络 |
data.exclude_wlan_id[].id |
integer | 是 | 标识 |
loading |
boolean | 是 | 是否显示加载状态 |
完整请求 Body
{
"opr": "add",
"data": {
"name": "test",
"desc": "",
"ap_conf": [
{
"id": 0,
"type": "branch",
"platform": 1,
"key_id": "branch_0",
"name": "本机"
},
{
"id": 1,
"type": "branch",
"platform": 1,
"key_id": "branch_1",
"name": "NAC1"
}
],
"enable": true,
"close_time": {
"id": 1
},
"exclude_wlan_id": [
{
"id": 3
},
{
"id": 4
}
]
},
"loading": true
}
完整响应 JSON
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 请求是否成功 |
2.2 获取时间计划
- 接口标识:
wl_option_get_timeplan - 功能说明: 查询可选时间计划
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
data |
object | 是 | 业务数据 |
data.real |
boolean | 是 | 是否仅返回真实可用项 |
完整请求 Body
{
"opr": "get_timeplan",
"data": {
"real": true
}
}
完整响应 JSON
{
"data": [
{
"value": 1,
"text": "全天"
},
{
"value": 2,
"text": "上班时间"
},
{
"value": 3,
"text": "下班时间"
},
{
"value": 4,
"text": "凌晨时间00:00至06:00"
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
array | 业务数据 |
data[] |
object | 业务数据 |
data[].value |
integer | 时间计划标识 |
data[].text |
string | 时间计划名称 |
success |
boolean | 请求是否成功 |
2.3 获取无线网络
- 接口标识:
wl_network_list_wlan - 功能说明: 查询可选无线网络
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
完整请求 Body
{
"opr": "list_wlan"
}
完整响应 JSON
{
"data": [
{
"id": 3,
"name": "NMC1_ONLY_E_W_T",
"wlan_type": "common",
"type": 1,
"type_enable": true,
"wlan_enable": true,
"auth_type": "wpa12"
},
{
"id": 4,
"name": "NAC1_ONLY_E_W_T",
"wlan_type": "common",
"type": 1,
"type_enable": true,
"wlan_enable": true,
"auth_type": "wpa12"
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
array | 业务数据 |
data[] |
object | 业务数据 |
data[].id |
integer | 标识 |
data[].name |
string | 名称 |
data[].wlan_type |
string | 无线网络类别 |
data[].type |
integer | 类型 |
data[].type_enable |
boolean | 类型是否启用 |
data[].wlan_enable |
boolean | 无线网络是否启用 |
data[].auth_type |
string | 认证类型 |
success |
boolean | 请求是否成功 |
2.4 获取接入点分组
- 接口标识:
rf_ctr_policy_get_ap_tree - 功能说明: 查询接入点分组树
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
exclude_id |
any | 否 | 需排除的策略标识;null 表示不排除 |
完整请求 Body
{
"opr": "get_ap_tree",
"exclude_id": null
}
完整响应 JSON
{
"data": {
"tree": [
{
"id": 0,
"count": 0,
"branch_id": 0,
"name": "本机",
"auth_style": 0,
"type": "branch",
"key_id": "branch_0",
"leaf": false,
"checkable": true,
"platform": 1,
"branch_name": "本机",
"branch_type": "wac",
"wac_type": 2,
"sub_mode": 0,
"children": [
{
"id": 0,
"count": 0,
"name": "默认组",
"branch_id": 0,
"leaf": true,
"type": "grp",
"key_id": "grp_0",
"apg_type": 1,
"platform": 1,
"branch_name": "本机",
"branch_type": "wac",
"wac_type": 2,
"auth_style": 0,
"is_area": false,
"is_switch": false,
"is_ap": true
}
],
"deletable": false,
"all_area_id": 1
},
{
"id": 1,
"count": 0,
"branch_id": 1,
"name": "NAC1",
"auth_style": 0,
"type": "branch",
"key_id": "branch_1",
"leaf": false,
"checkable": true,
"platform": 1,
"branch_name": "NAC1",
"branch_type": "wac",
"wac_type": 1,
"sub_mode": 0,
"children": [
{
"id": 524288,
"count": 0,
"name": "默认组",
"branch_id": 1,
"leaf": true,
"type": "grp",
"key_id": "grp_524288",
"apg_type": 1,
"platform": 1,
"branch_name": "NAC1",
"branch_type": "wac",
"wac_type": 1,
"auth_style": 0,
"is_area": false,
"is_switch": false,
"is_ap": true
}
],
"all_area_id": 524289
}
],
"all": true,
"checkable": true
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
object | 业务数据 |
data.tree |
array | AP 节点树 |
data.tree[] |
object | AP 节点树 |
data.tree[].id |
integer | 标识 |
data.tree[].count |
integer | 节点下 AP 数量 |
data.tree[].branch_id |
integer | 分支标识 |
data.tree[].name |
string | 名称 |
data.tree[].auth_style |
integer | 认证样式 |
data.tree[].type |
string | 类型 |
data.tree[].key_id |
string | 树节点键 |
data.tree[].leaf |
boolean | 是否叶子节点 |
data.tree[].checkable |
boolean | 是否可勾选 |
data.tree[].platform |
integer | 平台类型 |
data.tree[].branch_name |
string | 分支名称 |
data.tree[].branch_type |
string | 分支设备类型 |
data.tree[].wac_type |
integer | WAC 类型 |
data.tree[].sub_mode |
integer | 子模式 |
data.tree[].children |
array | 子节点 |
data.tree[].children[] |
object | 子节点 |
data.tree[].children[].id |
integer | 标识 |
data.tree[].children[].count |
integer | 节点下 AP 数量 |
data.tree[].children[].name |
string | 名称 |
data.tree[].children[].branch_id |
integer | 分支标识 |
data.tree[].children[].leaf |
boolean | 是否叶子节点 |
data.tree[].children[].type |
string | 类型 |
data.tree[].children[].key_id |
string | 树节点键 |
data.tree[].children[].apg_type |
integer | AP 分组类型 |
data.tree[].children[].platform |
integer | 平台类型 |
data.tree[].children[].branch_name |
string | 分支名称 |
data.tree[].children[].branch_type |
string | 分支设备类型 |
data.tree[].children[].wac_type |
integer | WAC 类型 |
data.tree[].children[].auth_style |
integer | 认证样式 |
data.tree[].children[].is_area |
boolean | 是否区域节点 |
data.tree[].children[].is_switch |
boolean | 是否交换机节点 |
data.tree[].children[].is_ap |
boolean | 是否 AP 节点 |
data.tree[].deletable |
boolean | 是否可删除 |
data.tree[].all_area_id |
integer | 全部区域标识 |
data.all |
boolean | 是否返回全部节点 |
data.checkable |
boolean | 是否可勾选 |
success |
boolean | 请求是否成功 |
2.5 搜索射频控制策略
- 接口标识:
rf_ctr_policy_list - 功能说明: 按名称搜索射频控制策略
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
start |
integer | 是 | 分页起始偏移量 |
limit |
integer | 是 | 分页记录上限 |
search |
string | 是 | 名称搜索关键字 |
完整请求 Body
{
"opr": "list",
"start": 0,
"limit": 50,
"search": "test"
}
完整响应 JSON
{
"data": [
{
"id": 1,
"name": "test",
"desc": null,
"ap_conf": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": 1,
"branch_name": "",
"branch_id": 0,
"name": null,
"key_id": "branch_0",
"wac_type": 2
},
{
"id": 1,
"type": "branch",
"path": "/NAC1",
"platform": 1,
"branch_name": "NAC1",
"branch_id": 1,
"name": null,
"key_id": "branch_1",
"wac_type": 1
}
],
"close_time": {
"id": 1,
"name": "全天"
},
"exclude_wlan_id": [
{
"id": 3,
"name": "NMC1_ONLY_E_W_T"
},
{
"id": 4,
"name": "NAC1_ONLY_E_W_T"
}
],
"enable": true,
"creator": "admin"
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
array | 业务数据 |
data[] |
object | 业务数据 |
data[].id |
integer | 标识 |
data[].name |
string | 名称 |
data[].desc |
any | 描述 |
data[].ap_conf |
array | AP 节点配置 |
data[].ap_conf[] |
object | AP 节点配置 |
data[].ap_conf[].id |
integer | 标识 |
data[].ap_conf[].type |
string | 类型 |
data[].ap_conf[].path |
string | 展示路径;以 / 开头 |
data[].ap_conf[].platform |
integer | 平台类型 |
data[].ap_conf[].branch_name |
string | 分支名称 |
data[].ap_conf[].branch_id |
integer | 分支标识 |
data[].ap_conf[].name |
any | 名称;修改请求要求以 / 开头 |
data[].ap_conf[].key_id |
string | 树节点键 |
data[].ap_conf[].wac_type |
integer | WAC 类型 |
data[].close_time |
object | 关闭时间计划 |
data[].close_time.id |
integer | 标识 |
data[].close_time.name |
string | 名称 |
data[].exclude_wlan_id |
array | 排除无线网络 |
data[].exclude_wlan_id[] |
object | 排除无线网络 |
data[].exclude_wlan_id[].id |
integer | 标识 |
data[].exclude_wlan_id[].name |
string | 名称 |
data[].enable |
boolean | 是否启用 |
data[].creator |
string | 创建人 |
total |
integer | 记录总数 |
success |
boolean | 请求是否成功 |
2.6 获取射频控制策略详情
- 接口标识:
rf_ctr_policy_listDetail - 功能说明: 按策略标识查询策略详情
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
data |
object | 是 | 业务数据 |
data.id |
integer | 是 | 标识 |
loading |
boolean | 是 | 是否显示加载状态 |
完整请求 Body
{
"opr": "listDetail",
"data": {
"id": 1
},
"loading": true
}
完整响应 JSON
{
"data": {
"id": 1,
"name": "test",
"desc": null,
"ap_conf": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": 1,
"branch_name": "",
"branch_id": 0,
"name": null,
"key_id": "branch_0",
"wac_type": 2
},
{
"id": 1,
"type": "branch",
"path": "/NAC1",
"platform": 1,
"branch_name": "NAC1",
"branch_id": 1,
"name": null,
"key_id": "branch_1",
"wac_type": 1
}
],
"close_time": {
"id": 1,
"name": "全天"
},
"exclude_wlan_id": [
{
"id": 3,
"name": "NMC1_ONLY_E_W_T"
},
{
"id": 4,
"name": "NAC1_ONLY_E_W_T"
}
],
"enable": true,
"creator": "admin"
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
object | 业务数据 |
data.id |
integer | 标识 |
data.name |
string | 名称 |
data.desc |
any | 描述 |
data.ap_conf |
array | AP 节点配置 |
data.ap_conf[] |
object | AP 节点配置 |
data.ap_conf[].id |
integer | 标识 |
data.ap_conf[].type |
string | 类型 |
data.ap_conf[].path |
string | 展示路径;以 / 开头 |
data.ap_conf[].platform |
integer | 平台类型 |
data.ap_conf[].branch_name |
string | 分支名称 |
data.ap_conf[].branch_id |
integer | 分支标识 |
data.ap_conf[].name |
any | 名称;修改请求要求以 / 开头 |
data.ap_conf[].key_id |
string | 树节点键 |
data.ap_conf[].wac_type |
integer | WAC 类型 |
data.close_time |
object | 关闭时间计划 |
data.close_time.id |
integer | 标识 |
data.close_time.name |
string | 名称 |
data.exclude_wlan_id |
array | 排除无线网络 |
data.exclude_wlan_id[] |
object | 排除无线网络 |
data.exclude_wlan_id[].id |
integer | 标识 |
data.exclude_wlan_id[].name |
string | 名称 |
data.enable |
boolean | 是否启用 |
data.creator |
string | 创建人 |
success |
boolean | 请求是否成功 |
2.7 修改射频控制策略
- 接口标识:
rf_ctr_policy_modify - 功能说明: 修改射频控制策略及关联资源
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
data |
object | 是 | 业务数据 |
data.name |
string | 是 | 名称 |
data.desc |
any | 否 | 描述 |
data.ap_conf |
array | 是 | AP 节点配置 |
data.ap_conf[] |
object | 是 | AP 节点配置 |
data.ap_conf[].id |
integer | 是 | 标识 |
data.ap_conf[].type |
string | 是 | 类型 |
data.ap_conf[].platform |
integer | 是 | 平台类型 |
data.ap_conf[].key_id |
string | 是 | 树节点键 |
data.ap_conf[].name |
string | 是 | 名称;修改请求要求以 / 开头 |
data.enable |
boolean | 是 | 是否启用 |
data.close_time |
object | 是 | 关闭时间计划 |
data.close_time.id |
integer | 是 | 标识 |
data.exclude_wlan_id |
array | 是 | 排除无线网络 |
data.exclude_wlan_id[] |
object | 是 | 排除无线网络 |
data.exclude_wlan_id[].id |
integer | 是 | 标识 |
data.id |
integer | 是 | 标识 |
loading |
boolean | 是 | 是否显示加载状态 |
完整请求 Body
{
"opr": "modify",
"data": {
"name": "test",
"desc": null,
"ap_conf": [
{
"id": 0,
"type": "branch",
"platform": 1,
"key_id": "branch_0",
"name": "/本机"
},
{
"id": 1,
"type": "branch",
"platform": 1,
"key_id": "branch_1",
"name": "/NAC1"
}
],
"enable": true,
"close_time": {
"id": 1
},
"exclude_wlan_id": [
{
"id": 3
},
{
"id": 4
}
],
"id": 1
},
"loading": true
}
完整响应 JSON
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 请求是否成功 |
2.8 禁用射频控制策略
- 接口标识:
rf_ctr_policy_disable - 功能说明: 批量禁用射频控制策略
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
data |
array | 是 | 业务数据 |
data[] |
object | 是 | 业务数据 |
data[].id |
integer | 是 | 标识 |
完整请求 Body
{
"opr": "disable",
"data": [
{
"id": 1
}
]
}
完整响应 JSON
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 请求是否成功 |
2.9 启用射频控制策略
- 接口标识:
rf_ctr_policy_enable - 功能说明: 批量启用射频控制策略
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
data |
array | 是 | 业务数据 |
data[] |
object | 是 | 业务数据 |
data[].id |
integer | 是 | 标识 |
完整请求 Body
{
"opr": "enable",
"data": [
{
"id": 1
}
]
}
完整响应 JSON
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 请求是否成功 |
2.10 删除射频控制策略
- 接口标识:
rf_ctr_policy_delete - 功能说明: 批量删除射频控制策略
完整请求 Body 参数表
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
opr |
string | 是 | 操作名称 |
data |
array | 是 | 业务数据 |
data[] |
object | 是 | 业务数据 |
data[].id |
integer | 是 | 标识 |
完整请求 Body
{
"opr": "delete",
"data": [
{
"id": 1
}
]
}
完整响应 JSON
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 请求是否成功 |
本地用户管理接口
一、接口概览
| 序号 | 接口名称 | 接口路径 | 功能说明 |
|---|---|---|---|
| 1 | 用户/组组织树查询 | /index.php/auth_localuser/list_tree |
获取本地用户组织树(按节点懒加载) |
| 2 | 用户/组列表查询 | /index.php/auth_localuser/list |
查询指定组下的用户/组列表(默认根组) |
| 3 | 新增用户组 | /index.php/auth_localuser/addgrp |
在指定父组下新增用户组 |
| 4 | 编辑用户组 | /index.php/auth_localuser/modifygrp |
修改用户组的名称、描述、父组等 |
| 5 | 新增用户 | /index.php/auth_localuser/addusr |
在指定组下新增本地用户 |
| 6 | 编辑用户 | /index.php/auth_localuser/modifyusr |
修改用户基本信息、密码、所属组等 |
| 7 | 删除用户/组 | /index.php/auth_localuser/delete |
批量删除用户或组 |
| 8 | 启用用户/组 | /index.php/auth_localuser/enable |
批量启用用户或组 |
| 9 | 禁用用户/组 | /index.php/auth_localuser/disable |
批量禁用用户或组 |
| 10 | 用户/组详情 | /index.php/auth_localuser/listDetail |
查询指定用户或组的详细信息 |
二、接口详细说明
2.1 auth_localuser_list_tree — 用户/组组织树查询
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | list_tree | ||
node |
string | 是 | 树节点 id,"root" 表示根节点加载;后续取上一级返回的 id |
/index.php/auth_localuser/list_tree |
$.data[].id |
branch_id |
integer | 是 | 分支 ID,0 表示本机 | ||
branch_type |
string | 否 | 分支类型,"wac" 表示本机控制器 |
后续接口取值:接口2、3、4、5、6、7、8、9、10 需此接口的节点 id 作为父组或当前组标识,取值路径
$.data[].id
请求示例
{"opr":"list_tree","node":"root","branch_id":0}
响应 Body
{"data":[{"id":"13701867045104946371","all":true,"text":"default","leaf":true,"edit":true,"request_to_organization":true,"type":"organization","branch_id":0,"path":"/","_id":"2","branch_type":"wac","branch_name":"本机"}],"all":true,"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
array[object] | 树节点数组 |
data[].id |
string | 节点 ID,作为子节点加载时的 node 参数 |
data[].text |
string | 节点显示名 |
data[].all |
boolean | 是否包含全部用户 |
data[].leaf |
boolean | 是否为叶子节点 |
data[].edit |
boolean | 是否可编辑 |
data[].type |
string | 节点类型,固定值 "organization" |
data[].path |
string | 节点路径 |
data[]._id |
string | 内部序号 |
data[].branch_id |
integer | 分支 ID |
data[].branch_type |
string | 分支类型 |
data[].branch_name |
string | 分支名称 |
data[].request_to_organization |
boolean | 是否申请到组织节点 |
all |
boolean | 是否返回全部 |
success |
boolean | 操作成功标识 |
2.2 auth_localuser_list — 用户/组列表查询
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | list | ||
start |
integer | 是 | 分页起始位置,默认 0 | ||
limit |
integer | 是 | 每页数量,默认 50 | ||
search |
object | 是 | 搜索条件对象 | ||
search.group |
object | 是 | 组筛选对象 | ||
search.group.id |
string | 是 | 组 ID,"root" 表示根组 |
/index.php/auth_localuser/list_tree |
$.data[].id |
search.name |
string | 否 | 按用户名搜索 | ||
sort |
string | 否 | 排序字段,默认 "name" |
||
direction |
string | 否 | 排序方向,"ASC" 或 "DESC" |
||
branch_id |
integer | 是 | 分支 ID,0 表示本机 | ||
branch_type |
string | 否 | 分支类型,"wac" |
后续接口取值:接口5、6、7、8、9、10 均需此接口的 id 作为操作对象,取值路径
$.data[].id;编辑用户(接口6)还需 oldData 字段(如 name/realname/expiration/status/desc/type/user_type/logintime)
请求示例
{"opr":"list","start":0,"limit":50,"search":{"group":{"id":"root"}},"sort":"name","direction":"ASC","branch_id":0,"branch_type":"wac"}
响应 Body
{"data":[{"id":"13701867045104946371","name":"default","expiration":"","status":-1,"desc":"default group","type":1,"logintime":"","default":true,"branch_id":0}],"passwd_strength":{"enable_local":false,"password_len":1,"no_username":false,"no_weak_password":false,"password_complex":{"enable":false,"items":[],"satisfy_required":4},"passwd_strength":0},"total":1,"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
array[object] | 用户/组列表 |
data[].id |
string | 记录 ID,组或用户唯一标识 |
data[].name |
string | 名称(组名或用户登录名) |
data[].desc |
string | 描述 |
data[].expiration |
string | 到期时间,空字符串表示永不过期 |
data[].status |
integer | 状态:-1=默认组,1=启用,0=禁用 |
data[].type |
integer | 类型:1=组,0=用户 |
data[].logintime |
string | 最后登录时间,空表示从未登录 |
data[].default |
boolean | 是否为默认组 |
data[].branch_id |
integer | 分支 ID |
passwd_strength |
object | 密码强度策略 |
passwd_strength.enable_local |
boolean | 是否启用本地密码策略 |
passwd_strength.password_len |
integer | 密码最小长度 |
passwd_strength.no_username |
boolean | 是否禁止使用用户名作为密码 |
passwd_strength.no_weak_password |
boolean | 是否禁止弱密码 |
passwd_strength.passwd_strength |
integer | 密码强度等级 |
passwd_strength.password_complex |
object | 密码复杂度配置 |
passwd_strength.password_complex.enable |
boolean | 是否启用复杂度校验 |
passwd_strength.password_complex.items |
array[string] | 复杂度项,如 number/upper_case/lower_case |
passwd_strength.password_complex.satisfy_required |
integer | 需满足项数 |
total |
integer | 总记录数 |
success |
boolean | 操作成功标识 |
2.3 auth_localuser_addgrp — 新增用户组
请求表单schema
本接口使用表单 schema:auth_localuser.addgrp.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | addgrp | ||
data |
object | 是 | 新增组数据 | ||
data.id |
string | 是 | 新增时固定空字符串 | ||
data.name |
string | 是 | 组名 | ||
data.desc |
string | 否 | 组描述 | ||
data.path |
object | 是 | 父组路径对象 | ||
data.path.id |
string | 是 | 父组 ID | /index.php/auth_localuser/list_tree |
$.data[].id |
data.path.text |
string | 是 | 父组路径文本,如 "/default" |
/index.php/auth_localuser/list_tree |
$.data[].path |
data.need_decode |
boolean | 否 | 是否需要解码,默认 true | ||
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
后续接口取值:新增成功后通过接口2 list 重新加载列表可拿到新组 id
请求示例
{"opr":"addgrp","data":{"id":"","name":"testgrp","desc":"ttt","path":{"id":"13701867045104946371","text":"/default"},"need_decode":true},"branch_id":0,"branch_type":"wac"}
响应 Body
{"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 操作成功标识 |
2.4 auth_localuser_modifygrp — 编辑用户组
请求表单schema
本接口使用表单 schema:auth_localuser.addgrp.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | modifygrp | ||
data |
object | 是 | 修改组数据 | ||
data.id |
string | 是 | 组 ID | /index.php/auth_localuser/list |
$.data[].id |
data.branch_id |
string | 否 | 组所属分支 ID | ||
data.name |
string | 是 | 组名 | ||
data.desc |
string | 否 | 组描述 | ||
data.path |
object | 是 | 父组路径对象 | ||
data.path.id |
string | 是 | 父组 ID | /index.php/auth_localuser/list_tree |
$.data[].id |
data.path.text |
string | 是 | 父组路径文本 | /index.php/auth_localuser/list_tree |
$.data[].path |
data.subgroup |
string | 否 | 子组数量 | ||
data.usrcount |
string | 否 | 用户数量 | ||
data.need_decode |
boolean | 否 | 是否需要解码 | ||
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
⚠️ modify 提交基础:建议以接口10 listDetail 返回的完整 data 对象为底,再覆盖要改的字段,避免丢字段
⚠️ 根组下的 default 组不允许修改,会返回
success=false并提示"根组下的default组不能被修改"
后续接口取值:本接口不直接被其他接口取值
请求示例
{"opr":"modifygrp","data":{"id":"13701867045104946371","branch_id":"0","name":"default","desc":"default group","path":{"id":"13701867045104946371","text":"/"},"subgroup":"0","usrcount":"0","need_decode":true},"branch_id":0,"branch_type":"wac"}
响应 Body
{"msg":["根组下的default组不能被修改"],"success":false}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
msg |
array[string] | 错误信息数组,操作成功时无 |
success |
boolean | 操作成功标识 |
2.5 auth_localuser_addusr — 新增用户
请求表单schema
本接口使用表单 schema:auth_localuser.addusr.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | addusr | ||
data |
object | 是 | 新增用户数据 | ||
data.id |
string | 是 | 新增时固定空字符串 | ||
data.usr |
object | 是 | 用户信息对象 | ||
data.usr.enable |
boolean | 是 | 是否启用 | ||
data.usr.user_type |
string | 是 | 用户类型,0=本地用户,1=邮箱绑定用户,2=手机账号用户 | ||
data.usr.name |
string | 是 | 用户名 | ||
data.usr.show_name |
string | 否 | 显示名 | ||
data.usr.desc |
string | 否 | 描述 | ||
data.usr.group |
object | 是 | 所属组对象 | ||
data.usr.group.id |
string | 是 | 组 ID | /index.php/auth_localuser/list_tree |
$.data[].id |
data.usr.group.text |
string | 是 | 组路径文本 | /index.php/auth_localuser/list_tree |
$.data[].path |
data.usr.psw |
string | 是 | 密码(加密串) | ||
data.usr.confirm_psw |
string | 是 | 确认密码(加密串) | ||
data.usr.changepsw |
boolean | 否 | 下次登录是否需要修改密码 | ||
data.usr.cert |
object/null | 否 | 证书信息,新增时一般为 null | ||
data.usr.expiration |
string | 是 | 过期类型,specified=指定时间,never=永不过期 | ||
data.usr.never |
boolean | 是 | 是否永不过期 | ||
data.usr.specified |
object | 是 | 指定过期时间对象 | ||
data.usr.specified.enable |
boolean | 是 | 是否启用指定过期 | ||
data.usr.specified.time |
string | 是 | 过期时间,格式 YYYY-MM-DD | ||
data.need_decode |
boolean | 否 | 是否需要解码 | ||
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
后续接口取值:新增成功后通过接口2 list 重新加载可拿到新用户 id
请求示例
{"opr":"addusr","data":{"id":"","usr":{"enable":true,"user_type":"0","name":"test","show_name":"test","desc":"testtt","group":{"id":"13701867045104946371","text":"/default"},"psw":"SFN0Nzl9LXc=","confirm_psw":"SFN0Nzl9LXc=","changepsw":true,"cert":null,"expiration":"specified","never":false,"specified":{"enable":true,"time":"2026-09-30"}},"need_decode":true},"branch_id":0,"branch_type":"wac"}
响应 Body
{"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 操作成功标识 |
2.6 auth_localuser_modifyusr — 编辑用户
请求表单schema
本接口使用表单 schema:auth_localuser.modifyusr.json(完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | modifyusr | ||
data |
object | 是 | 修改用户数据 | ||
data.active |
string | 是 | 是否激活状态,true/false | ||
data.id |
string | 是 | 用户 ID | /index.php/auth_localuser/list |
$.data[].id |
data.usr |
object | 是 | 用户信息对象 | ||
data.usr.enable |
boolean | 是 | 是否启用 | ||
data.usr.user_type |
string | 是 | 用户类型 | ||
data.usr.name |
string | 是 | 用户名 | ||
data.usr.show_name |
string | 是 | 显示名 | ||
data.usr.desc |
string | 否 | 描述 | ||
data.usr.group |
object | 是 | 所属组对象 | ||
data.usr.group.id |
string | 是 | 组 ID | /index.php/auth_localuser/list_tree |
$.data[].id |
data.usr.group.text |
string | 是 | 组路径文本 | /index.php/auth_localuser/list_tree |
$.data[].path |
data.usr.expiration |
string | 是 | 过期类型 | ||
data.usr.never |
boolean | 是 | 是否永不过期 | ||
data.usr.specified |
object | 是 | 指定过期时间对象 | ||
data.usr.specified.enable |
boolean | 是 | 是否启用指定过期 | ||
data.usr.specified.time |
string | 是 | 过期时间 | ||
data.usr.cert |
object/null | 否 | 证书信息 | ||
data.usr.reset |
object | 否 | 密码重置对象 | ||
data.usr.reset.enable |
boolean | 否 | 是否重置密码 | ||
data.usr.reset.psw |
string | 否 | 新密码(加密串) | ||
data.usr.reset.confirm_psw |
string | 否 | 确认新密码(加密串) | ||
data.usr.reset.changepsw |
boolean | 否 | 下次登录是否需要修改密码 | ||
data.need_decode |
boolean | 否 | 是否需要解码 | ||
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
⚠️ modify 提交基础:建议以接口10 listDetail 返回的完整 data 对象为底,再覆盖要改的字段,避免丢字段
后续接口取值:本接口不直接被其他接口取值
请求示例
{"opr":"modifyusr","data":{"active":"false","id":"890357037717088838","usr":{"enable":true,"user_type":"2","name":"154****4573","show_name":"154****4573","desc":"test","group":{"id":"12826448936059818020","text":"/default/testgrp"},"expiration":"specified","never":false,"specified":{"enable":true,"time":"2026-09-30"},"cert":null,"reset":{"enable":true,"psw":"M1M7JTlCc28=","confirm_psw":"M1M7JTlCc28=","changepsw":false}},"need_decode":true},"branch_id":0,"branch_type":"wac"}
响应 Body
{"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 操作成功标识 |
2.7 auth_localuser_delete — 删除用户/组
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | delete | ||
data |
array[object] | 是 | 待删除记录数组 | ||
data[].id |
string | 是 | 记录 ID | /index.php/auth_localuser/list |
$.data[].id |
data[].name |
string | 否 | 名称 | /index.php/auth_localuser/list |
$.data[].name |
data[].expiration |
string | 否 | 过期时间 | /index.php/auth_localuser/list |
$.data[].expiration |
data[].status |
integer | 否 | 状态 | /index.php/auth_localuser/list |
$.data[].status |
data[].desc |
string | 否 | 描述 | /index.php/auth_localuser/list |
$.data[].desc |
data[].type |
integer | 否 | 类型,1=组,0=用户 | /index.php/auth_localuser/list |
$.data[].type |
data[].logintime |
string | 否 | 登录时间 | /index.php/auth_localuser/list |
$.data[].logintime |
data[].default |
boolean | 否 | 是否默认组 | /index.php/auth_localuser/list |
$.data[].default |
data[].realname |
string | 否 | 真实姓名(用户) | /index.php/auth_localuser/listDetail |
$.data.usr.show_name |
data[].user_type |
string | 否 | 用户类型(用户) | /index.php/auth_localuser/listDetail |
$.data.usr.user_type |
data[].branch_id |
integer | 否 | 分支 ID | ||
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
后续接口取值:本接口不直接被其他接口取值
请求示例
{"opr":"delete","data":[{"id":"12826448936059818020","name":"testgrp","expiration":"","status":-1,"desc":"ttt","type":1,"logintime":"","default":false,"branch_id":0}],"branch_id":0,"branch_type":"wac"}
响应 Body
{"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 操作成功标识 |
2.8 auth_localuser_enable — 启用用户/组
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | enable | ||
data |
array[object] | 是 | 待启用记录数组 | ||
data[].id |
string | 是 | 记录 ID | /index.php/auth_localuser/list |
$.data[].id |
data[].type |
integer | 是 | 类型,1=组,0=用户 | /index.php/auth_localuser/list |
$.data[].type |
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
后续接口取值:本接口不直接被其他接口取值
请求示例
{"opr":"enable","data":[{"id":"10841553426573193764","type":0}],"branch_id":0,"branch_type":"wac"}
响应 Body
{"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 操作成功标识 |
2.9 auth_localuser_disable — 禁用用户/组
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | disable | ||
data |
array[object] | 是 | 待禁用记录数组 | ||
data[].id |
string | 是 | 记录 ID | /index.php/auth_localuser/list |
$.data[].id |
data[].type |
integer | 是 | 类型,1=组,0=用户 | /index.php/auth_localuser/list |
$.data[].type |
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
后续接口取值:本接口不直接被其他接口取值
请求示例
{"opr":"disable","data":[{"id":"18020588380933092773","type":0},{"id":"10841553426573193764","type":0}],"branch_id":0,"branch_type":"wac"}
响应 Body
{"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | 操作成功标识 |
2.10 auth_localuser_listDetail — 用户/组详情
请求 Body
| 参数 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
opr |
string | 是 | listDetail | ||
data |
object | 是 | 详情查询条件 | ||
data.type |
integer | 是 | 类型,1=组,0=用户 | /index.php/auth_localuser/list |
$.data[].type |
data.id |
string | 是 | 记录 ID | /index.php/auth_localuser/list |
$.data[].id |
data.all |
boolean | 否 | 是否全部 | ||
data.text |
string | 否 | 显示文本 | ||
data.leaf |
boolean | 否 | 是否叶子 | ||
data.edit |
boolean | 否 | 是否可编辑 | ||
data.request_to_organization |
boolean | 否 | 是否申请到组织 | ||
data.branch_id |
integer | 否 | 分支 ID | ||
data.path |
string | 否 | 路径 | ||
data._id |
string | 否 | 内部序号 | ||
data.branch_type |
string | 否 | 分支类型 | ||
data.branch_name |
string | 否 | 分支名称 | ||
data.expanded |
boolean | 否 | 是否展开 | ||
data.iconCls |
string | 否 | 图标样式 | ||
data.name |
string | 否 | 名称(用户场景) | /index.php/auth_localuser/list |
$.data[].name |
data.desc |
string | 否 | 描述(用户场景) | /index.php/auth_localuser/list |
$.data[].desc |
data.expiration |
string | 否 | 过期时间(用户场景) | /index.php/auth_localuser/list |
$.data[].expiration |
data.logintime |
string | 否 | 登录时间(用户场景) | /index.php/auth_localuser/list |
$.data[].logintime |
data.realname |
string | 否 | 真实姓名(用户场景) | ||
data.status |
integer | 否 | 状态(用户场景) | /index.php/auth_localuser/list |
$.data[].status |
data.user_type |
string | 否 | 用户类型(用户场景) | ||
branch_id |
integer | 是 | 分支 ID | ||
branch_type |
string | 否 | 分支类型 |
请求示例
{"opr":"listDetail","data":{"type":1,"id":"13701867045104946371","all":true,"text":"default","leaf":true,"edit":true,"request_to_organization":true,"branch_id":0,"path":"/","_id":"2","branch_type":"wac","branch_name":"本机","expanded":false,"iconCls":"sf-ico troop"},"branch_id":0,"branch_type":"wac"}
响应 Body
{"data":{"name":"default","desc":"default group","path":{"id":"13701867045104946371","text":"/"},"id":"13701867045104946371","subgroup":0,"usrcount":0,"branch_id":0},"success":true}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data |
object | 详情数据(组场景或用户场景) |
data.id |
string | 记录 ID |
data.name |
string | 名称(组场景) |
data.desc |
string | 描述(组场景) |
data.path |
object | 父组路径对象(组场景) |
data.path.id |
string | 父组 ID |
data.path.text |
string | 父组路径文本 |
data.subgroup |
integer | 子组数量(组场景) |
data.usrcount |
integer | 用户数量(组场景) |
data.branch_id |
integer | 分支 ID |
data.usr |
object | 用户信息(用户场景) |
data.usr.name |
string | 用户名 |
data.usr.show_name |
string | 显示名 |
data.usr.desc |
string | 描述 |
data.usr.enable |
boolean | 是否启用 |
data.usr.user_type |
string | 用户类型 |
data.usr.expiration |
string | 过期类型,specified/never |
data.usr.never |
boolean | 是否永不过期 |
data.usr.specified |
object | 指定过期配置 |
data.usr.specified.enable |
boolean | 是否启用指定过期 |
data.usr.specified.time |
string | 过期时间 |
data.usr.group |
object | 所属组 |
data.usr.group.id |
string | 组 ID |
data.usr.group.text |
string | 组路径文本 |
data.usr.cert |
object/null | 证书信息 |
data.active |
boolean | 是否激活(用户场景) |
success |
boolean | 操作成功标识 |
三、表单schema定义
1. auth_localuser.addgrp.json
使用接口:/index.php/auth_localuser/addgrp(2.3)、/index.php/auth_localuser/modifygrp(2.4)
{
"title": "编辑用户组",
"description": "编辑用户组 — 前端校验规则(面向外部开放接口)",
"x-api": {
"url": "/index.php/auth_localuser",
"comment": "本地用户模块的统一接口;新增用户组与编辑用户组共用同一 url,靠顶层 opr 区分",
"opr": {
"add": "addgrp",
"edit": "modifygrp"
}
},
"x-page": {
"path": "/auth/user/LocalUsr",
"menu": "认证配置 → 用户管理 → 本地用户",
"功能": "在本地用户组织树上新增/编辑用户组:填写组名称、描述,并从组织树中选取父组作为归属路径"
},
"type": "object",
"required": [
"opr",
"data"
],
"properties": {
"opr": {
"type": "string",
"enum": [
"addgrp",
"modifygrp"
],
"x-comment": "操作类型;提交时作为顶层参数传入。新增用户组固定传 addgrp,编辑用户组固定传 modifygrp,与 x-api.opr 一一对应。⚠️ 同一 url 下另有新增/编辑用户(addusr/modifyusr)、删除、启用禁用等接口,请按本值区分,勿混淆"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"x-comment": "组 ID。新增场景固定传空字符串 \"\";编辑场景必传,建议直接回填组织树/列表接口返回的组 id,不要自行生成"
},
"branch_id": {
"type": "string",
"x-comment": "组所属分支 ID。前端不为此表单单独维护,提交时由页面按当前所选组织树分支统一注入,新增/编辑都会携带"
},
"name": {
"type": "string",
"x-component": "nametextfield",
"x-comment": "组名称;必填。校验规则由公共组件 nametextfield 提供(见 x-component);具体正则/长度约束由「公共校验提取」环节统一注入,本文件不复制"
},
"desc": {
"type": "string",
"x-component": "desctextfield",
"x-comment": "组描述;可选。校验规则由公共组件 desctextfield 提供(见 x-component);具体正则/长度约束由「公共校验提取」环节统一注入,本文件不复制"
},
"path": {
"type": "object",
"description": "父组路径对象,由组织树选择器返回",
"required": [
"id",
"text"
],
"properties": {
"id": {
"type": "string",
"x-comment": "父组 ID;必填。取自组织树查询接口返回的节点 id"
},
"text": {
"type": "string",
"x-comment": "父组路径文本;必填。取自组织树查询接口返回的节点 path,形如 \"/default\" 或 \"/\""
}
},
"x-comment": "父组路径;必填。由组织树节点选择产生,是当前组在组织树上的挂载位置。⚠️ 新增时此项决定新组的归属父组;编辑时若改动此项,等价于把该组及其子组一起迁移到新父组下"
},
"subgroup": {
"type": "string",
"default": "-",
"x-comment": "子组数量;只读展示值。列表/详情接口回传,前端不允许编辑,编辑场景随提交原样回带;新增场景不需要传"
},
"usrcount": {
"type": "string",
"default": "-",
"x-comment": "组内用户数量;只读展示值。列表/详情接口回传,前端不允许编辑,编辑场景随提交原样回带;新增场景不需要传"
},
"need_decode": {
"type": "boolean",
"x-force_write_on_submit": true,
"x-comment": "是否需要解码;可选(后端接口文档列为 data 内字段)。前端提交时会固定写入 true,外部对接方按 true 传入即可"
}
},
"required": [
"name",
"path",
"path.id",
"path.text"
]
},
"branch_id": {
"type": "integer",
"x-comment": "当前所在分支 ID(顶层参数,不在 data 内)。由页面按当前所选组织树分支统一注入到请求根部,外部对接方需自行提供所操作分支的 ID"
},
"branch_type": {
"type": "string",
"x-comment": "当前所在分支类型(顶层参数,不在 data 内)。由页面按当前所选组织树分支统一注入到请求根部,与 branch_id 成对出现,用于标识 wac(本地控制器)或 msg(分支网关)形态"
}
}
}
2. auth_localuser.addusr.json
使用接口:/index.php/auth_localuser/addusr(2.5)
{
"title": "本地用户 - 新增用户(本地账号 / 邮箱绑定 / 手机账号)",
"description": "本地用户管理「新增用户」弹窗的合并契约,覆盖三种用户形态:本地用户(user_type=0)、邮箱绑定用户(user_type=1)、手机账号用户(user_type=2)。三者共用同一接口 /index.php/auth_localuser 与同一 opr=addusr,服务端以 data.usr.user_type 分流,因此本文件用 user_type 作为判别字段,将公共字段与三形态差异收敛到同一份契约中。手机账号新增表单不包含初始密码(psw/confirm_psw)——手机账号的初始密码由自动激活流程设置,新增时不提交。",
"x-api": {
"url": "/index.php/auth_localuser",
"opr": {
"add": "addusr"
},
"x-comment": "三种形态新增均提交 opr=\"addusr\",请求根层参数为 {opr, data, branch_id, branch_type},其中 data 即本文件 data 节点。user_type 是唯一的形态判别字段:0=本地用户、1=邮箱绑定用户、2=手机账号用户。手机账号形态下 name 可省略,服务端以手机号(show_name)兜底,且不提交密码。注意勿与同名近邻接口混淆:用户组增改为 addgrp/modifygrp,用户编辑为 modifyusr,字段集不同。"
},
"x-page": {
"path": "/auth/user/LocalUsr",
"menu": "用户管理 → 本地用户",
"功能": "在本地用户列表中新增一个用户。三种形态:本地用户(配置用户名/显示名/密码/证书/过期时间)、邮箱绑定用户(用户名即邮箱,用于 802.1x 免密码认证)、手机账号用户(以手机号为账号,新增后可通过自动激活流程设置初始密码)。"
},
"type": "object",
"properties": {
"opr": {
"type": "string",
"enum": [
"addusr"
],
"description": "提交操作类型。新增三种形态均使用 \"addusr\"。"
},
"branch_id": {
"type": [
"integer",
"string"
],
"x-readonly": true,
"x-comment": "分支 ID。由页面上下文注入(中心端多分支场景下标识目标分支),非表单字段;独立控制器场景为 0 或不传。作为请求根层参数,与 data 平级。"
},
"branch_type": {
"type": "string",
"x-readonly": true,
"x-comment": "分支类型。由页面上下文注入,用于区分部署形态(如 wac 本地控制器、msg 分支网关)。作为请求根层参数,与 branch_id 成对出现;取不到时不携带该字段。"
},
"data": {
"type": "object",
"description": "表单数据主体,新增用户的全部业务字段都挂在本对象下。",
"required": [
"id",
"usr"
],
"properties": {
"id": {
"type": "string",
"x-readonly": true,
"x-comment": "记录 ID。新增场景固定提交空字符串 \"\",由服务端生成。取自表单顶层的隐藏字段 id,随 data 一并提交。"
},
"need_decode": {
"type": "boolean",
"default": true,
"x-force_write_on_submit": true,
"x-readonly": true,
"x-comment": "提交时前端固定写入 true,表示 data 中的密码字段为前端 Base64 编码后的密文,服务端需先解码再校验与存储。仅本地用户 / 邮箱绑定用户形态会实际携带密文密码;手机账号形态无密码字段,该值对结果无实质影响。"
},
"usr": {
"type": "object",
"description": "用户主体信息,受页面顶层「启用」开关整体控制(开关关闭时不提交本对象,即不新增用户)。字段集随 user_type 形态变化,差异见下",
"required": [
"enable",
"user_type",
"group",
"expiration",
"never",
"specified"
],
"properties": {
"enable": {
"type": "boolean",
"default": true,
"x-comment": "是否启用该用户,由表单顶部「启用」开关控制:勾选为 true。三种形态共用。"
},
"user_type": {
"type": "string",
"enum": [
"0",
"1",
"2"
],
"x-comment": "★ 形态判别字段,前端以隐藏字段固定写入(提交时序列化为字符串)。0=本地用户(本地账号),1=外来(邮箱绑定)用户,2=手机账号(自动激活)用户。服务端据此决定校验规则与后续处理分支。本字段是消费方选择字段集/校验规则的唯一依据。"
},
"name": {
"type": "string",
"maxLength": 64,
"x-component": "LocalUserName",
"x-required": true,
"x-comment": "用户名。长度 64 字符以内且不能为空,字符集校验由公共校验器 LocalUserName 提供(支持中文、英文字母、数字、特殊字符 +;=()-.@、空格及下划线;不允许 \\/:*?\"<>| 与逗号与 #)。本地用户形态:必填,提交前前端做小写归一化(含大写字母时整体转小写)。邮箱绑定形态:必填,该值同时作为邮箱地址使用。手机账号形态:服务端在用户名空缺时自动取手机号(show_name)兜底。"
},
"show_name": {
"type": "string",
"x-comment": "★ 语义随形态变化,是三种形态差异最大的字段:① 本地用户(user_type=0)——显示名,选填,maxLength 95,字符集校验同 LocalUserName。② 邮箱绑定用户(user_type=1)——邮箱,选填,maxLength 64,填写时按电子邮箱地址格式校验(pattern 见 x-field-rules),提交前做 trim。③ 手机账号用户(user_type=2)——手机号码,必填,仅允许数字、首位不能为 0 且不能以 '-' 开头、长度 3–13 位;该值即登录账号。关键约束:未激活用户(data.active 为字符串 'false')的手机号必须与用户名 name 完全一致。",
"x-field-rules": {
"email-pattern": "^(\\\\w+)([\\\\-+.][\\\\w]+)*@(\\\\w[\\\\-\\\\w]*\\\\.){1,5}([A-Za-z]){2,6}$"
}
},
"desc": {
"type": "string",
"x-component": "desctextfield",
"x-comment": "描述。选填,三种形态共用。校验规则由公共组件 desctextfield 提供:最长 99 字符,带默认占位提示「选填」。"
},
"group": {
"type": "object",
"description": "所属组。必填,前端从分组下拉树中取所选节点的完整对象提交;未选择时提交空对象 {}。三种形态共用。",
"required": [
"id",
"text"
],
"properties": {
"id": {
"type": "string",
"x-comment": "所属组的节点 id。必填。根节点 id 为字符串 \"root\",部分消息分支场景下根节点 id 为 \"13701867045104946371\"。"
},
"text": {
"type": "string",
"x-comment": "所属组的完整路径文本,形如 /a/b/c;部分场景下为 \"/default\"。必填。"
}
}
},
"psw": {
"type": "string",
"minLength": 1,
"maxLength": 39,
"x-component": "Psw",
"x-required": true,
"x-comment": "初始密码。⚠️ 仅本地用户(user_type=0)与邮箱绑定用户(user_type=1)形态存在本字段且必填;手机账号用户(user_type=2)新增弹窗不包含密码字段,其初始密码在自动激活流程中设置,本字段不应提交。基础格式校验由公共校验器 Psw 提供;若站点启用本地用户密码强度校验,还额外按密码强度策略(长度、必须包含的字符种类、是否可用用户名等)校验。提交前做 Base64 编码(配合 need_decode=true),服务端收到密文;仅当 psw 与 confirm_psw 均非空时才编码,编码失败时两者被置空。"
},
"confirm_psw": {
"type": "string",
"minLength": 1,
"maxLength": 39,
"x-equals": "data.usr.psw",
"x-required": true,
"x-comment": "确认密码。与 psw 同存同亡:仅本地用户 / 邮箱绑定用户形态必填,手机账号形态不提交。必须与 psw 完全相等(前端与服务端均校验,比对编码前的原始值),提交前同样做 Base64 编码。"
},
"changepsw": {
"type": [
"boolean",
"integer"
],
"default": false,
"x-comment": "安全选项:登录时是否必须修改初始密码。勾选为 true。本地用户 / 邮箱绑定用户形态为 checkbox,值为 boolean;手机账号形态若传入则为整型 0/1(0=不强制,1=强制),本弹窗不提交该字段,缺失时服务端按默认值 0 回填。对接方可显式传 0 或 1,不传等同 0。"
},
"cert": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"x-comment": "用户/组 ID(来源 list 接口 $.data[].id)"
},
"usrcount": {
"type": "string",
"x-comment": "用户/组数量描述"
},
"nation": {
"type": "string",
"x-comment": "国家代码,如 CN"
},
"state": {
"type": "string",
"x-comment": "省份"
},
"city": {
"type": "string",
"x-comment": "城市"
},
"company": {
"type": "string",
"x-comment": "公司"
},
"depart": {
"type": "string",
"x-comment": "部门"
},
"issueto": {
"type": "string",
"x-comment": "颁发对象(必填)"
},
"rsalength": {
"type": "integer",
"x-comment": "RSA 密钥长度(必填),如 1024"
},
"mail": {
"type": "string",
"x-comment": "邮箱"
},
"cert_psw": {
"type": "string",
"x-comment": "证书密码"
},
"expire": {
"type": "object",
"x-comment": "过期配置(必填)",
"properties": {
"type": {
"type": "string",
"x-comment": "过期类型,如 \"10\""
},
"time": {
"type": "string",
"x-comment": "截止日期,如 \"2036-08-30\""
}
}
}
},
"x-comment": "证书信息对象。子字段结构依据后端文档 §15「批量生成用户证书」的 data.cert 定义。"
},
{
"type": "null",
"x-comment": "未生成证书时为 null(新增用户时一般为 null)。"
}
],
"x-comment": "证书信息。⚠️ 仅本地用户(user_type=0)与邮箱绑定用户(user_type=1)形态存在本字段:新增时必须「生成证书」后才能提交,新增时通常提交 null、通过「生成证书」签发后为包含上述字段的对象;Msg 部署形态下该字段隐藏。手机账号用户(user_type=2)形态无证书字段——其证书在自动激活阶段生成。"
},
"expiration": {
"type": "string",
"enum": [
"never",
"specified"
],
"x-required": true,
"x-comment": "过期类型。必填,取值 never=永不过期、specified=指定时间。与 never / specified.enable 为同一选择的不同表述,三者取值需保持同步。三种形态共用。"
},
"never": {
"type": "boolean",
"x-comment": "过期时间「永不过期」选项:选中为 true,选中「指定时间」时为 false。与 expiration 表达同一语义。三种形态共用。"
},
"specified": {
"type": "object",
"description": "过期时间「指定时间」选项。仅当 expiration=specified 时生效(此时 enable=true 且需填 time)。三种形态共用。",
"x-control_chain": {
"expiration": "specified"
},
"properties": {
"enable": {
"type": "boolean",
"x-comment": "「指定时间」选项的选中状态:选择「指定时间」时为 true,选择「永不」时为 false。注意:该子项在表单侧未设置固定提交值,其上报与否取决于所用日期参数名,请以服务端为准。"
},
"time": {
"type": "string",
"format": "date",
"x-required": true,
"x-comment": "指定的过期时间点。当 expiration=specified 时必填,仅可选择日期(不含时分秒),取值需满足:不早于控制器当前时间(服务端当天 00:00),且不晚于系统允许的最大日期限制。"
}
}
},
"reset": {
"type": "object",
"x-comment": "密码重置对象。仅编辑(modifyusr)场景使用;本新增表单不产生该字段。列出仅为说明与编辑表单的差异。",
"properties": {
"enable": {
"type": "boolean",
"x-comment": "是否重置密码。"
},
"psw": {
"type": "string",
"x-comment": "新密码(Base64 编码串)。"
},
"confirm_psw": {
"type": "string",
"x-comment": "确认新密码(Base64 编码串),需与 reset.psw 相等。"
},
"changepsw": {
"type": "boolean",
"x-comment": "下次登录是否需要修改密码。"
}
}
}
}
}
}
}
},
"required": [
"opr",
"data",
"branch_id"
],
"x-comment": "合并契约使用说明:① 判别依据是 data.usr.user_type(0/1/2),消费方据此选择字段集与校验规则——不要把本文件的「要求」当成对三种形态同时成立;② 三种形态的字段差异矩阵见 x-variants;③ 公共字段(enable/user_type/desc/group/expiration/never/specified)三形态完全一致,已在 properties 中给出统一约束;④ 新增场景下表单底部有提交前钩子,当前实现直接放行,无前端阻断式校验;⑤ 密码类字段(psw/confirm_psw)在提交前由前端 Base64 编码,并以 data.need_decode=true 通知服务端解码,仅本地用户与邮箱绑定用户形态适用。",
"x-variants": {
"discriminator": "data.usr.user_type",
"0": {
"name": "本地用户(本地账号)",
"name": "必填,且提交前小写归一化",
"show_name": "显示名,选填,maxLength 95",
"psw": "必填,1–39",
"confirm_psw": "必填,等于 psw",
"changepsw": "boolean",
"cert": "必填(需先生成证书),可 null",
"expiration": "必填(never+specified.time 亦为必需)"
},
"1": {
"name": "邮箱绑定用户(外来用户)",
"name": "必填,同时作为邮箱地址",
"show_name": "邮箱,选填,maxLength 64,email 正则校验",
"psw": "必填,1–39",
"confirm_psw": "必填,等于 psw",
"changepsw": "boolean",
"cert": "必填(需先生成证书),可 null",
"expiration": "必填"
},
"2": {
"name": "手机账号用户(自动激活)",
"name": "服务端以手机号兜底(opr=addusr)",
"show_name": "手机号码,必填,纯数字/首位非0/长度 3–13",
"psw": "不提交(初始密码由自动激活流程设置)",
"confirm_psw": "不提交",
"changepsw": "本弹窗不提交;传入为 0/1 整型,缺失按 0 回填",
"cert": "不提交(证书在自动激活阶段生成)",
"expiration": "必填",
"x-comment": "手机账号与普通用户共用同一套用户主体字段规则,服务端按业务分支区分处理:手机账号支持自动激活,会额外生成 802.1x 无线网络自动配置工具(下载入口仅在证书生成后显示)。未激活用户的手机号必须与用户名一致。"
}
}
}
3. auth_localuser.modifyusr.json
使用接口:/index.php/auth_localuser/modifyusr(2.6)
{
"title": "编辑本地用户",
"description": "编辑本地用户 — 前端校验规则(面向外部开放接口)",
"x-api": {
"url": "/index.php/auth_localuser",
"opr": {
"add": "modifyusr",
"edit": "modifyusr",
"list": "listDetail"
},
"x-comment": "编辑本地用户固定使用 opr=modifyusr。⚠️ 本次编辑是两步交互:先以 opr=listDetail 请求用户详情(返回的 data 作为表单初值),再以 opr=modifyusr 提交保存;两个 opr 都指向同一接口。新增本地用户走 opr=addusr、用户组编辑走 opr=modifygrp,均为同一接口下的邻近操作,请勿混淆。"
},
"x-page": {
"path": "认证 → 本地用户(列表页内“编辑用户”弹窗)",
"menu": "认证 → 本地用户",
"功能": "编辑一个已存在的本地用户的基本信息(用户名、显示名、描述、所属组、过期时间、证书)、可选重置密码"
},
"type": "object",
"properties": {
"opr": {
"type": "string",
"enum": [
"modifyusr"
],
"x-comment": "操作类型;编辑本地用户固定传 \"modifyusr\""
},
"data": {
"type": "object",
"properties": {
"active": {
"type": "string",
"enum": [
"true",
"false"
],
"x-required": true,
"x-readonly": true,
"x-comment": "用户激活状态,字符串 \"true\"/\"false\"。由用户详情/列表数据回带,前端不编辑,提交时原样带回。服务端当前未读取该字段(仅回带),但接口文档要求携带,建议按文档回传。"
},
"id": {
"type": "string",
"x-required": true,
"x-readonly": true,
"x-comment": "用户 ID。由列表接口返回后回传,不在编辑弹窗内编辑;外部调用方需先从用户列表取得该 ID 再提交。"
},
"need_decode": {
"type": "boolean",
"x-comment": "固定传 true,表示请求内的密码字段按加密串处理"
},
"usr": {
"type": "object",
"x-required": true,
"x-comment": "用户信息对象;所有表单字段都挂在本对象下,由表单最外层「启用」开关统一控制是否提交",
"properties": {
"enable": {
"type": "boolean",
"default": true,
"x-required": true,
"x-comment": "是否启用该用户;必填。由表单最外层「启用」开关控制,编辑场景以回带值为初值。"
},
"user_type": {
"type": "string",
"x-required": true,
"x-readonly": true,
"x-comment": "用户类型;必填。决定编辑时打开哪种用户表单(0=本地用户 1=邮箱绑定用户 2=手机账号用户);由列表数据回带,不在编辑弹窗内编辑。"
},
"name": {
"type": "string",
"maxLength": 64,
"x-component": "LocalUserName",
"x-control_chain": {
"usr.enable": true
},
"x-required": true,
"x-comment": "用户名;必填。校验规则由公共校验器 `LocalUserName` 提供(见 x-component)。原样未改动时不做二次校验,改动后才校验。长度为 64(证书生成工具只支持 64 个字符,超出会报错)。"
},
"show_name": {
"type": "string",
"maxLength": 95,
"x-component": "LocalUserName",
"x-control_chain": {
"usr.enable": true
},
"x-required": true,
"x-comment": "显示名;必填。校验规则由公共校验器 `LocalUserName` 提供(见 x-component)。"
},
"desc": {
"type": "string",
"x-component": "desctextfield",
"x-control_chain": {
"usr.enable": true
},
"x-comment": "描述;选填。校验规则由公共组件 `desctextfield` 提供(见 x-component),其具体正则与长度约束以该组件实现为准。"
},
"group": {
"type": "object",
"x-required": true,
"x-control_chain": {
"usr.enable": true
},
"x-comment": "所属组;必填。由用户组树选择,提交的是所选组节点的完整对象。",
"properties": {
"id": {
"type": "string",
"x-required": true,
"x-comment": "组 ID;必填。来源于用户组树(组节点的 id),根路径固定为 \"root\"。"
},
"text": {
"type": "string",
"x-required": true,
"x-comment": "组路径文本;必填。来源于用户组树(组节点从根到该节点的完整路径文本,形如 /default/testgrp)。"
}
}
},
"expiration": {
"type": "string",
"enum": [
"never",
"specified"
],
"x-control_chain": {
"usr.enable": true
},
"x-required": true,
"x-comment": "过期时间类型;单选,取值 never=永不过期、specified=指定时间。与下文的 never / specified 子对象配套使用。"
},
"never": {
"type": "boolean",
"x-control_chain": {
"usr.enable": true,
"usr.expiration": "never"
},
"x-required": true,
"x-comment": "是否永不过期;仅在过期时间类型为 never(永不)时生效,此时应传 true。"
},
"specified": {
"type": "object",
"x-control_chain": {
"usr.enable": true,
"usr.expiration": "specified"
},
"x-required": true,
"x-comment": "指定过期时间;仅在过期时间类型为 specified(指定时间)时生效。",
"properties": {
"enable": {
"type": "boolean",
"x-required": true,
"x-comment": "是否启用指定过期;选择 specified 时传 true。"
},
"time": {
"type": "string",
"format": "date",
"x-required": true,
"x-comment": "指定过期日期;必填(选 specified 时)。日期格式(如 2026-09-30),不得早于服务器当前日期。"
}
}
},
"cert": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"x-comment": "用户/组 ID(来源 list 接口 $.data[].id)"
},
"usrcount": {
"type": "string",
"x-comment": "用户/组数量描述"
},
"nation": {
"type": "string",
"x-comment": "国家代码,如 CN"
},
"state": {
"type": "string",
"x-comment": "省份"
},
"city": {
"type": "string",
"x-comment": "城市"
},
"company": {
"type": "string",
"x-comment": "公司"
},
"depart": {
"type": "string",
"x-comment": "部门"
},
"issueto": {
"type": "string",
"x-comment": "颁发对象(必填)"
},
"rsalength": {
"type": "integer",
"x-comment": "RSA 密钥长度(必填),如 1024"
},
"mail": {
"type": "string",
"x-comment": "邮箱"
},
"cert_psw": {
"type": "string",
"x-comment": "证书密码"
},
"expire": {
"type": "object",
"x-comment": "过期配置(必填)",
"properties": {
"type": {
"type": "string",
"x-comment": "过期类型,如 \"10\""
},
"time": {
"type": "string",
"x-comment": "截止日期,如 \"2036-08-30\""
}
}
}
},
"x-comment": "证书信息对象。子字段结构依据后端文档 §15「批量生成用户证书」的 data.cert 定义。"
},
{
"type": "null",
"x-comment": "未生成证书时为 null(新增用户时一般为 null)。"
}
],
"x-comment": "证书信息。选填:新增时通常为 null;通过「生成证书」操作签发后为包含上述字段的对象。本表单默认提交 null。"
},
"reset": {
"type": "object",
"x-control_chain": {
"usr.enable": true,
"usr.reset.enable": true
},
"x-comment": "重置密码;选填。仅在「重置密码」开关(reset.enable)为 true 时提交(对应文档标注「否」=非必填);开启后新密码与确认密码必填。",
"properties": {
"enable": {
"type": "boolean",
"x-comment": "是否重置密码;由表单内「重置密码」开关控制。"
},
"psw": {
"type": "string",
"maxLength": 39,
"x-component": "Psw",
"x-required": true,
"x-comment": "新密码(加密串);仅在重置密码开启时必填(x-required 表示「重置开关为 true 时必填」)。密码强度规则由后端下发,校验来源见 x-component;密码长度下限由服务端下发的密码策略(password_len)决定;前端「生成随机密码」时取该策略值,不足 8 位按 8 位处理。"
},
"confirm_psw": {
"type": "string",
"maxLength": 39,
"x-equals": "usr.reset.psw",
"x-required": true,
"x-comment": "确认新密码(加密串);仅在重置密码开启时必填,且必须与 psw 完全相等,否则提示「两次输入的密码不一致」;长度上限与 psw 一致(39)。"
},
"changepsw": {
"type": "boolean",
"default": false,
"x-comment": "安全选项:是否登录时必须修改初始密码;默认 false。"
}
}
}
}
}
},
"required": [
"active",
"id",
"usr"
]
},
"branch_id": {
"type": "integer",
"x-required": true,
"x-comment": "分支 ID;由页面当前选中的用户组节点带出。独立控制器场景固定为 0;中心端场景为所选分支的实际 ID。"
},
"branch_type": {
"type": "string",
"x-comment": "分支类型;由页面当前选中的树节点带出,中心端场景下随所有请求附加(如 wac、msg)。非本表单字段,属页面上下文参数。"
}
},
"required": [
"opr",
"data",
"branch_id"
]
}
有线终端白名单接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/whitelist/list | 查询有线终端白名单列表 |
| /index.php/obj_macgroup/index | 获取可选的 MAC 地址库列表 |
| /index.php/whitelist/add | 新增有线终端白名单条目 |
| /index.php/whitelist/delete | 删除有线终端白名单条目 |
| /index.php/whitelist/listDetail | 获取有线终端白名单详情 |
二、接口详细说明
2.1 whitelist_list
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 list |
| start | integer | 否 | 分页起始偏移,默认 0 |
| limit | integer | 否 | 每页条数,默认返回全部 |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50
}
响应 Body
{
"data": [
{
"id": "1",
"name": "TestWhiteList_Auto",
"desc": "",
"group_id": "默认白名单",
"apply_srv_type": "ARP防御"
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 白名单记录列表 |
| data[].id | string | 白名单记录 ID |
| data[].name | string | 白名单名称 |
| data[].desc | string | 描述 |
| data[].group_id | string | MAC 地址库名称 |
| data[].apply_srv_type | string | 生效业务名称,多个业务时以逗号分隔 |
| total | integer | 总记录数 |
| success | boolean | 接口调用是否成功 |
2.2 obj_macgroup_index
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 index |
| filterCol | array | 否 | 过滤字段列表,如 ["name"] |
| start | integer | 否 | 分页起始偏移 |
| sort | string | 否 | 排序字段 |
| limit | integer | 否 | 每页条数 |
| filter | string | 否 | 过滤关键词 |
请求示例
{
"filterCol": [
"name"
],
"opr": "index",
"start": 0,
"sort": "",
"limit": 100,
"filter": ""
}
响应 Body
{
"data": [
{
"id": 1,
"name": "默认黑名单",
"leaf": true,
"deletetable": true,
"creator": "system",
"is_system": 1,
"group_type": 1
},
{
"id": 2,
"name": "默认白名单",
"leaf": true,
"deletetable": true,
"creator": "system",
"is_system": 1,
"group_type": 1
},
{
"id": 3,
"name": "默认重点用户",
"leaf": true,
"deletetable": true,
"creator": "system",
"is_system": 1,
"group_type": 1
},
{
"id": 4,
"name": "111",
"leaf": true,
"deletetable": true,
"creator": "admin",
"is_system": 0,
"group_type": 1
},
{
"id": 5,
"name": "免认证",
"leaf": true,
"deletetable": true,
"creator": "admin",
"is_system": 0,
"group_type": 1
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | MAC 地址库记录列表 |
| data[].id | integer | MAC 地址库 ID |
| data[].name | string | MAC 地址库名称 |
| data[].leaf | boolean | 是否叶子节点 |
| data[].deletetable | boolean | 是否可删除 |
| data[].creator | string | 创建者 |
| data[].is_system | integer | 是否系统内置 |
| data[].group_type | integer | 地址库类型 |
| success | boolean | 接口调用是否成功 |
2.3 whitelist_add
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 add |
| data | object | 是 | 白名单数据对象 |
| data.id | string | 否 | 新增时传空字符串 "" |
| data.name | string | 是 | 白名单名称,不能为空 |
| data.desc | string | 否 | 描述,可为空 |
| data.group_id | array | 是 | MAC 地址库列表,省略时记录创建但 MAC 地址库为空,功能上建议始终传入 |
| data.group_id[].id | integer | 是 | MAC 地址库 ID,来自 /index.php/obj_macgroup/index |
| data.group_id[].name | string | 是 | MAC 地址库名称,来自 /index.php/obj_macgroup/index |
| data.apply_srv_type | array | 是 | 生效业务列表,不能为空 |
| data.apply_srv_type[].text | string | 是 | 业务显示名称 |
| data.apply_srv_type[].value | string | 是 | 业务值;ARP防御="2"、DHCP防御="3"、终端安全策略="4"、攻击源定位="5" |
请求示例
{
"opr": "add",
"data": {
"id": "",
"name": "TestWhiteList_Auto",
"desc": "自动化测试",
"group_id": [
{
"name": "默认白名单",
"id": 2
}
],
"apply_srv_type": [
{
"text": "ARP防御",
"value": "2"
}
]
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口调用是否成功 |
字段值格式说明
data.group_id[].id从 MAC 地址库列表接口返回的 integer 类型直接使用。data.group_id[].name从 MAC 地址库列表接口返回的 string 类型直接使用。data.apply_srv_type[].value请求示例使用字符串枚举值;详情接口返回 integer 枚举值,若从详情回填到新增/编辑类请求中,需要按接口期望转换为字符串。
2.4 whitelist_delete
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 delete |
| data | array | 是 | 待删除记录列表,建议传列表接口返回的完整记录对象 |
| data[].id | string | 是 | 白名单 ID,来自 /index.php/whitelist/list |
| data[].name | string | 否 | 白名单名称 |
| data[].desc | string | 否 | 描述 |
| data[].group_id | string | 否 | MAC 地址库名称 |
| data[].apply_srv_type | string | 否 | 生效业务名称 |
请求示例
{
"opr": "delete",
"data": [
{
"id": "1",
"name": "TestWhiteList_Auto",
"desc": "",
"group_id": "默认白名单",
"apply_srv_type": "ARP防御"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口调用是否成功 |
字段值格式说明
- 删除接口的
data[]与白名单列表接口的data[]记录结构一致,可按白名单名称过滤后整体引用。 data[].id省略时服务端可能仍返回success=true,但记录未被删除,建议始终传入完整记录对象。
2.5 whitelist_listDetail
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 listDetail |
| data | object | 是 | 查询详情所需的白名单记录信息 |
| data.id | string | 是 | 白名单记录 ID,来自 /index.php/whitelist/list |
| data.name | string | 是 | 白名单名称,来自 /index.php/whitelist/list 或用户输入 |
| data.desc | string | 否 | 描述,可为空 |
| data.group_id | string | 是 | MAC 地址库名称,来自 /index.php/whitelist/list |
| data.apply_srv_type | string | 是 | 生效业务名称,来自 /index.php/whitelist/list,多个业务以逗号分隔 |
请求示例
{
"opr": "listDetail",
"data": {
"id": "1",
"name": "test",
"desc": "",
"group_id": "默认白名单",
"apply_srv_type": "ARP防御,DHCP防御,终端安全策略,攻击源定位"
}
}
响应 Body
{
"data": {
"id": "1",
"name": "test",
"desc": "",
"group_id": [
{
"id": 2,
"name": "默认白名单"
}
],
"apply_srv_type": [
{
"value": 2,
"text": "ARP防御"
},
{
"value": 3,
"text": "DHCP防御"
},
{
"value": 4,
"text": "终端安全策略"
},
{
"value": 5,
"text": "攻击源定位"
}
]
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 白名单详情对象 |
| data.id | string | 白名单记录 ID |
| data.name | string | 白名单名称 |
| data.desc | string | 描述 |
| data.group_id | array | MAC 地址库对象列表 |
| data.group_id[].id | integer | MAC 地址库 ID |
| data.group_id[].name | string | MAC 地址库名称 |
| data.apply_srv_type | array | 生效业务对象列表 |
| data.apply_srv_type[].value | integer | 生效业务枚举值 |
| data.apply_srv_type[].text | string | 生效业务显示名称 |
| success | boolean | 接口调用是否成功 |
字段值格式说明
- 请求 Body 中
data.group_id为 MAC 地址库名称字符串,响应 Body 中data.group_id为对象数组。 - 请求 Body 中
data.apply_srv_type为逗号分隔的业务名称字符串,响应 Body 中data.apply_srv_type为对象数组。 - 详情接口请求依赖列表接口的记录信息,按白名单名称过滤后可整体引用列表记录对象。
流速限制策略接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/auth_ratelimit/listTime | 查询流速限制策略可选生效时间 |
| /index.php/auth_ratelimit/add | 新增流速限制策略 |
| /index.php/auth_ratelimit/list | 查询流速限制策略列表 |
| /index.php/auth_ratelimit/listDetail | 获取流速限制策略详情 |
| /index.php/auth_ratelimit/modify | 修改流速限制策略 |
| /index.php/auth_ratelimit/enable | 启用流速限制策略 |
| /index.php/auth_ratelimit/disable | 禁用流速限制策略 |
| /index.php/auth_ratelimit/delete | 删除流速限制策略 |
二、接口详细说明
2.1 查询生效时间选项
- 接口名称:
auth_ratelimit_listTime
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 listTime |
请求示例
{
"opr": "listTime"
}
响应 Body
{
"data": [
{
"text": "全天",
"id": 1
},
{
"text": "上班时间",
"id": 2
},
{
"text": "下班时间",
"id": 3
},
{
"text": "凌晨时间00:00至06:00",
"id": 4
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 生效时间选项列表 |
| data[].text | string | 生效时间名称 |
| data[].id | integer | 生效时间 ID |
| success | boolean | 请求是否成功 |
2.2 新增流速限制策略
- 接口名称:
auth_ratelimit_add
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 add |
| data | object | 是 | 策略数据对象 |
| data.id | string | 是 | 新增时固定为空字符串 |
| data.flow | object | 是 | 流速限制配置对象 |
| data.flow.enable | boolean | 是 | 是否启用策略 |
| data.flow.name | string | 是 | 策略名称 |
| data.flow.desc | string | 否 | 策略描述 |
| data.flow.time | object | 是 | 生效时间配置 |
| data.flow.time.timeSelect | object | 是 | 时间选择对象 |
| data.flow.time.timeSelect.text | string | 是 | 时间名称,从 listTime 接口获取 |
| data.flow.time.timeSelect.id | integer | 是 | 时间 ID,从 listTime 接口获取 |
| data.flow.receive | object | 否 | 接收速率限制配置 |
| data.flow.receive.enable | boolean | 否 | 是否启用接收速率限制 |
| data.flow.receive.rate | number | 否 | 接收速率值 |
| data.flow.receive.unit | string | 否 | 接收速率单位,如 Mbps |
| data.flow.send | object | 否 | 发送速率限制配置 |
| data.flow.send.enable | boolean | 否 | 是否启用发送速率限制 |
| data.flow.send.rate | number | 否 | 发送速率值 |
| data.flow.send.unit | string | 否 | 发送速率单位,如 Mbps |
请求示例
{
"opr": "add",
"data": {
"id": "",
"flow": {
"enable": true,
"name": "test_rate_limit_policy",
"desc": "测试流速限制策略",
"time": {
"timeSelect": {
"text": "全天",
"id": 1
}
},
"receive": {
"enable": true,
"rate": 10,
"unit": "Mbps"
},
"send": {
"enable": true,
"rate": 10,
"unit": "Mbps"
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.3 查询流速限制策略列表
- 接口名称:
auth_ratelimit_list
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 list |
| start | integer | 是 | 起始索引,默认 0 |
| limit | integer | 是 | 每页数量,默认 50 |
| sort | string | 否 | 排序字段,如 name |
| direction | string | 否 | 排序方向,如 ASC 或 DESC |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"sort": "name",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"id": 1,
"name": "test_rate_limit_policy",
"desc": "测试流速限制策略",
"state": 1,
"send": "10 Mbps",
"receive": "10 Mbps",
"default": false,
"creator": "admin",
"with_mosaic": false
}
],
"total": 1,
"uplimit": {
"SIG-5100": 16,
"SFG-2500": 16
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 策略列表 |
| data[].id | integer | 策略 ID |
| data[].name | string | 策略名称 |
| data[].desc | string | 策略描述 |
| data[].state | integer | 状态,1 表示启用,0 表示禁用 |
| data[].send | string | 发送速率展示值 |
| data[].receive | string | 接收速率展示值 |
| data[].default | boolean | 是否为默认策略 |
| data[].creator | string | 创建者 |
| data[].with_mosaic | boolean | 是否启用马赛克 |
| total | integer | 总记录数 |
| uplimit | object | 不同设备型号的策略数量上限 |
| success | boolean | 请求是否成功 |
2.4 获取流速限制策略详情
- 接口名称:
auth_ratelimit_listDetail
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 listDetail |
| data | object | 是 | 策略列表记录对象,用于定位详情 |
| data.id | integer | 是 | 策略 ID,从 list 接口获取 |
| data.name | string | 是 | 策略名称,从 list 接口获取 |
| data.desc | string | 否 | 策略描述,从 list 接口获取 |
| data.state | integer | 是 | 策略状态,从 list 接口获取 |
| data.send | string | 是 | 发送速率展示值,从 list 接口获取 |
| data.receive | string | 是 | 接收速率展示值,从 list 接口获取 |
| data.default | boolean | 是 | 是否为默认策略,从 list 接口获取 |
| data.creator | string | 是 | 创建者,从 list 接口获取 |
| data.with_mosaic | boolean | 是 | 是否启用马赛克,从 list 接口获取 |
请求示例
{
"opr": "listDetail",
"data": {
"id": 2,
"name": "test_ls",
"desc": "",
"state": 1,
"send": "不限制",
"receive": "不限制",
"default": false,
"creator": "admin",
"with_mosaic": false
}
}
响应 Body
{
"data": {
"id": 2,
"flow": {
"enable": true,
"name": "test_ls",
"desc": "",
"receive": {
"unit": "Mbps",
"rate": "",
"enable": false
},
"send": {
"unit": "Mbps",
"rate": "",
"enable": false
},
"time": {
"timeSelect": {
"id": 1
}
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 策略详情对象 |
| data.id | integer | 策略 ID |
| data.flow | object | 流速限制配置对象 |
| data.flow.enable | boolean | 是否启用策略 |
| data.flow.name | string | 策略名称 |
| data.flow.desc | string | 策略描述 |
| data.flow.receive | object | 接收速率限制配置 |
| data.flow.receive.unit | string | 接收速率单位 |
| data.flow.receive.rate | string | 接收速率值;空字符串表示不限制 |
| data.flow.receive.enable | boolean | 是否启用接收速率限制 |
| data.flow.send | object | 发送速率限制配置 |
| data.flow.send.unit | string | 发送速率单位 |
| data.flow.send.rate | string | 发送速率值;空字符串表示不限制 |
| data.flow.send.enable | boolean | 是否启用发送速率限制 |
| data.flow.time | object | 生效时间配置 |
| data.flow.time.timeSelect | object | 时间选择对象 |
| data.flow.time.timeSelect.id | integer | 时间 ID |
| success | boolean | 请求是否成功 |
2.5 修改流速限制策略
- 接口名称:
auth_ratelimit_modify
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 modify |
| data | object | 是 | 修改数据对象 |
| data.id | string | 是 | 策略 ID,从 list 接口或 listDetail 接口获取;示例中为字符串格式 |
| data.flow | object | 是 | 流速限制配置对象,通常基于 listDetail 响应回填后修改 |
| data.flow.enable | boolean | 是 | 是否启用策略 |
| data.flow.name | string | 是 | 策略名称 |
| data.flow.desc | string | 是 | 策略描述;可传空字符串 |
| data.flow.time | object | 是 | 生效时间配置 |
| data.flow.time.timeSelect | object | 是 | 时间选择对象 |
| data.flow.time.timeSelect.id | integer | 是 | 时间 ID |
| data.flow.receive | object | 是 | 接收速率限制配置 |
| data.flow.receive.enable | boolean | 是 | 是否启用接收速率限制 |
| data.flow.receive.rate | string | 否 | 接收速率值;空字符串表示不限制 |
| data.flow.receive.unit | string | 是 | 接收速率单位,如 Mbps |
| data.flow.send | object | 是 | 发送速率限制配置 |
| data.flow.send.enable | boolean | 是 | 是否启用发送速率限制 |
| data.flow.send.rate | string | 否 | 发送速率值;空字符串表示不限制 |
| data.flow.send.unit | string | 是 | 发送速率单位,如 Mbps |
请求示例
{
"opr": "modify",
"data": {
"id": "2",
"flow": {
"enable": true,
"name": "test_ls",
"desc": "des",
"time": {
"timeSelect": {
"id": 1
}
},
"receive": {
"enable": false,
"rate": "",
"unit": "Mbps"
},
"send": {
"enable": false,
"rate": "",
"unit": "Mbps"
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.6 启用流速限制策略
- 接口名称:
auth_ratelimit_enable
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 enable |
| data | array | 是 | 策略列表数组 |
| data[].id | integer | 是 | 策略 ID,从 list 接口获取 |
| data[].name | string | 是 | 策略名称,从 list 接口获取 |
请求示例
{
"opr": "enable",
"data": [
{
"id": 1,
"name": "test_rate_limit_policy"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.7 禁用流速限制策略
- 接口名称:
auth_ratelimit_disable
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 disable |
| data | array | 是 | 策略列表数组 |
| data[].id | integer | 是 | 策略 ID,从 list 接口获取 |
| data[].name | string | 是 | 策略名称,从 list 接口获取 |
请求示例
{
"opr": "disable",
"data": [
{
"id": 1,
"name": "test_rate_limit_policy"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.8 删除流速限制策略
- 接口名称:
auth_ratelimit_delete
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 delete |
| data | array | 是 | 策略列表数组,直接传入 list 接口返回的完整记录对象 |
| data[].id | integer | 是 | 策略 ID |
| data[].name | string | 是 | 策略名称 |
| data[].desc | string | 否 | 策略描述 |
| data[].state | integer | 否 | 策略状态 |
| data[].send | string | 否 | 发送速率展示值 |
| data[].receive | string | 否 | 接收速率展示值 |
| data[].default | boolean | 否 | 是否为默认策略 |
| data[].creator | string | 否 | 创建者 |
| data[].with_mosaic | boolean | 否 | 是否启用马赛克 |
请求示例
{
"opr": "delete",
"data": [
{
"id": 1,
"name": "test_rate_limit_policy",
"desc": "测试流速限制策略",
"state": 1,
"send": "10 Mbps",
"receive": "10 Mbps",
"default": false,
"creator": "admin",
"with_mosaic": false
}
]
}
响应 Body
{
"succList": [
"test_rate_limit_policy"
],
"errorList": [],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| succList | array | 成功删除的策略名称列表 |
| errorList | array | 删除失败的策略名称列表 |
| success | boolean | 操作是否成功 |
用户审计策略接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/audit_role/list | 查询用户审计策略列表 |
| /index.php/audit_role/add | 新增用户审计策略 |
| /index.php/audit_role/modify | 修改用户审计策略 |
| /index.php/audit_role/enable | 启用用户审计策略 |
| /index.php/audit_role/disable | 禁用用户审计策略 |
| /index.php/audit_role/delete | 删除用户审计策略 |
| /index.php/audit_role/listDetail | 获取用户审计策略详情 |
二、接口详细说明
2.1 audit_role_list(查询用户审计策略列表)
- Content-Type:
application/json
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 list |
| start | number | 是 | 分页起始位置,默认 0 |
| limit | number | 是 | 每页数量,默认 50 |
| sort | string | 否 | 排序字段,默认 name |
| direction | string | 否 | 排序方向,默认 ASC |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"sort": "name",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"id": 50,
"name": "test_audit_policy",
"desc": "测试审计策略",
"state": 1,
"creator": "admin"
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 用户审计策略列表 |
| data[].id | integer | 策略 ID,用于查询详情、编辑、启用、禁用、删除 |
| data[].name | string | 策略名称,用户可感知的定位字段 |
| data[].desc | string | 策略描述 |
| data[].state | integer | 状态:1=启用,0=禁用 |
| data[].creator | string | 创建者 |
| total | integer | 总数量 |
| success | boolean | 请求是否成功 |
2.2 audit_role_add(新增用户审计策略)
- Content-Type:
application/json
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 add |
| data | object | 是 | 新增策略数据 |
| data.id | string | 否 | 新增时固定为空字符串 |
| data.strategy | object | 是 | 完整策略配置对象 |
| data.strategy.enable | boolean | 是 | 是否启用策略 |
| data.strategy.name | string | 是 | 策略名称 |
| data.strategy.desc | string | 否 | 策略描述 |
| data.strategy.sendcontent | object | 是 | HTTP 外发内容审计配置 |
| data.strategy.sendcontent.webbs | boolean | 是 | 是否审计 WebBBS |
| data.strategy.sendcontent.webmail | boolean | 是 | 是否审计 WebMail |
| data.strategy.sendcontent.attachment | boolean | 是 | 是否审计附件 |
| data.strategy.sendcontent.text | boolean | 是 | 是否审计文本 |
| data.strategy.sendcontent.weibo | object | 是 | 微博审计配置 |
| data.strategy.sendcontent.weibo.enable | boolean | 是 | 是否启用微博审计 |
| data.strategy.sendcontent.weibo.attachment | boolean | 是 | 是否审计微博附件 |
| data.strategy.accessite | object | 是 | 访问网站/下载审计配置 |
| data.strategy.accessite.urltype | array | 是 | URL 分类列表 |
| data.strategy.accessite.urltype[].id | string | 是 | URL 分类 ID |
| data.strategy.accessite.urltype[].type | string | 是 | URL 分类类型 |
| data.strategy.accessite.urltype[].path | string | 是 | URL 分类路径 |
| data.strategy.accessite.addr | boolean | 是 | 是否审计地址 |
| data.strategy.accessite.content | boolean | 是 | 是否审计内容 |
| data.strategy.accessite.filename | boolean | 是 | 是否审计文件名 |
| data.strategy.email | object | 是 | 邮件审计配置 |
| data.strategy.email.smtp | boolean | 是 | 是否审计 SMTP |
| data.strategy.email.pop3 | boolean | 是 | 是否审计 POP3 |
| data.strategy.ftp | object | 是 | FTP 审计配置 |
| data.strategy.ftp.upload | boolean | 是 | 是否审计 FTP 上传 |
| data.strategy.ftp.download | boolean | 是 | 是否审计 FTP 下载 |
| data.strategy.telnet | object | 是 | Telnet 审计配置 |
| data.strategy.telnet.command | boolean | 是 | 是否审计 Telnet 命令 |
| data.strategy.app | object | 是 | 网络应用审计配置 |
| data.strategy.app.other | boolean | 是 | 是否审计其他应用 |
| data.strategy.app.unknown | boolean | 是 | 是否审计未知应用 |
| data.strategy.flowandtime | object | 是 | 流量与上网时长配置 |
| data.strategy.flowandtime.flow | boolean | 是 | 是否启用流量审计 |
| data.strategy.flowandtime.time | object | 是 | 上网时长审计配置 |
| data.strategy.flowandtime.time.enable | boolean | 是 | 是否启用时长审计 |
| data.strategy.flowandtime.time.exclude | boolean | 是 | 是否排除指定时长 |
请求示例
{
"opr": "add",
"data": {
"id": "",
"strategy": {
"enable": true,
"name": "test_audit_policy",
"desc": "测试审计策略",
"sendcontent": {
"webbs": false,
"webmail": false,
"attachment": false,
"text": false,
"weibo": {
"enable": false,
"attachment": false
}
},
"accessite": {
"urltype": [
{
"id": "root",
"type": "root",
"path": "/"
}
],
"addr": false,
"content": false,
"filename": false
},
"email": {
"smtp": false,
"pop3": false
},
"ftp": {
"upload": false,
"download": false
},
"telnet": {
"command": false
},
"app": {
"other": false,
"unknown": false
},
"flowandtime": {
"flow": false,
"time": {
"enable": false,
"exclude": false
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.3 audit_role_modify(修改用户审计策略)
- Content-Type:
application/json
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 modify |
| data | object | 是 | 修改策略数据 |
| data.id | string | 是 | 策略 ID,从列表接口按策略名称获取 |
| data.strategy | object | 是 | 完整策略配置对象,可从详情接口获取后修改目标字段 |
| data.strategy.enable | boolean | 是 | 是否启用策略 |
| data.strategy.name | string | 是 | 策略名称 |
| data.strategy.desc | string | 是 | 策略描述 |
| data.strategy.sendcontent | object | 是 | HTTP 外发内容审计配置 |
| data.strategy.sendcontent.webbs | boolean | 是 | 是否审计 WebBBS |
| data.strategy.sendcontent.webmail | boolean | 是 | 是否审计 WebMail |
| data.strategy.sendcontent.attachment | boolean | 是 | 是否审计附件 |
| data.strategy.sendcontent.text | boolean | 是 | 是否审计文本 |
| data.strategy.sendcontent.weibo | object | 是 | 微博审计配置 |
| data.strategy.sendcontent.weibo.enable | boolean | 是 | 是否启用微博审计 |
| data.strategy.sendcontent.weibo.attachment | boolean | 是 | 是否审计微博附件 |
| data.strategy.accessite | object | 是 | 访问网站/下载审计配置 |
| data.strategy.accessite.urltype | array | 是 | URL 分类列表 |
| data.strategy.accessite.urltype[].id | string | 是 | URL 分类 ID |
| data.strategy.accessite.urltype[].type | string | 是 | URL 分类类型 |
| data.strategy.accessite.urltype[].path | string | 是 | URL 分类路径 |
| data.strategy.accessite.addr | boolean | 是 | 是否审计地址 |
| data.strategy.accessite.content | boolean | 是 | 是否审计内容 |
| data.strategy.accessite.filename | boolean | 是 | 是否审计文件名 |
| data.strategy.email | object | 是 | 邮件审计配置 |
| data.strategy.email.smtp | boolean | 是 | 是否审计 SMTP |
| data.strategy.email.pop3 | boolean | 是 | 是否审计 POP3 |
| data.strategy.ftp | object | 是 | FTP 审计配置 |
| data.strategy.ftp.upload | boolean | 是 | 是否审计 FTP 上传 |
| data.strategy.ftp.download | boolean | 是 | 是否审计 FTP 下载 |
| data.strategy.telnet | object | 是 | Telnet 审计配置 |
| data.strategy.telnet.command | boolean | 是 | 是否审计 Telnet 命令 |
| data.strategy.app | object | 是 | 网络应用审计配置 |
| data.strategy.app.other | boolean | 是 | 是否审计其他应用 |
| data.strategy.app.unknown | boolean | 是 | 是否审计未知应用 |
| data.strategy.flowandtime | object | 是 | 流量与上网时长配置 |
| data.strategy.flowandtime.flow | boolean/object | 是 | 流量审计配置;详情返回为对象,修改示例中可传布尔值 |
| data.strategy.flowandtime.time | object | 是 | 上网时长审计配置 |
| data.strategy.flowandtime.time.enable | boolean | 是 | 是否启用时长审计 |
| data.strategy.flowandtime.time.exclude | boolean | 是 | 是否排除指定时长 |
请求示例
{
"opr": "modify",
"data": {
"id": "50",
"strategy": {
"enable": true,
"name": "test_sj",
"desc": "des",
"sendcontent": {
"webbs": false,
"webmail": false,
"attachment": false,
"text": false,
"weibo": {
"enable": false,
"attachment": false
}
},
"accessite": {
"urltype": [
{
"id": "root",
"type": "root",
"path": "全部"
}
],
"addr": false,
"content": false,
"filename": false
},
"email": {
"smtp": false,
"pop3": false
},
"ftp": {
"upload": false,
"download": false
},
"telnet": {
"command": false
},
"app": {
"other": false,
"unknown": false
},
"flowandtime": {
"flow": false,
"time": {
"enable": false,
"exclude": false
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.4 audit_role_enable(启用用户审计策略)
- Content-Type:
application/json
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 enable |
| data | array | 是 | 待启用策略数组 |
| data[].id | integer | 是 | 策略 ID,从列表接口按策略名称获取 |
| data[].name | string | 是 | 策略名称,从列表接口按策略名称获取 |
请求示例
{
"opr": "enable",
"data": [
{
"id": 50,
"name": "test_audit_policy"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.5 audit_role_disable(禁用用户审计策略)
- Content-Type:
application/json
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 disable |
| data | array | 是 | 待禁用策略数组 |
| data[].id | integer | 是 | 策略 ID,从列表接口按策略名称获取 |
| data[].name | string | 是 | 策略名称,从列表接口按策略名称获取 |
请求示例
{
"opr": "disable",
"data": [
{
"id": 50,
"name": "test_audit_policy"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.6 audit_role_delete(删除用户审计策略)
- Content-Type:
application/json
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 delete |
| data | array | 是 | 待删除策略数组 |
| data[].id | integer | 是 | 策略 ID,从列表接口按策略名称获取 |
| data[].name | string | 是 | 策略名称,从列表接口按策略名称获取 |
请求示例
{
"opr": "delete",
"data": [
{
"id": 50,
"name": "test_audit_policy"
}
]
}
响应 Body
{
"succList": [
"test_audit_policy"
],
"errorList": [],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| succList | array | 成功删除的策略名称列表 |
| errorList | array | 删除失败的策略名称列表 |
| success | boolean | 请求是否成功 |
2.7 audit_role_listDetail(获取用户审计策略详情)
- Content-Type:
application/json
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 listDetail |
| data | object | 是 | 查询详情所需的策略基础信息 |
| data.id | integer | 是 | 策略 ID,从列表接口按策略名称获取 |
| data.name | string | 是 | 策略名称,从列表接口按策略名称获取 |
| data.desc | string | 否 | 策略描述,从列表接口获取 |
| data.state | integer | 是 | 策略状态,从列表接口获取 |
| data.creator | string | 是 | 创建者,从列表接口获取 |
请求示例
{
"opr": "listDetail",
"data": {
"id": 50,
"name": "test_sj",
"desc": "",
"state": 1,
"creator": "admin"
}
}
响应 Body
{
"data": {
"id": 50,
"strategy": {
"enable": true,
"name": "test_sj",
"desc": "",
"sendcontent": {
"webbs": false,
"webmail": false,
"attachment": false,
"text": false,
"weibo": {
"enable": false,
"attachment": false
}
},
"accessite": {
"addr": false,
"content": false,
"disabled": true,
"filename": false,
"urltype": [
{
"id": "root",
"type": "root",
"path": "全部"
}
]
},
"email": {
"smtp": false,
"pop3": false
},
"ftp": {
"upload": false,
"download": false
},
"telnet": {
"command": false
},
"app": {
"other": false,
"unknown": false
},
"flowandtime": {
"flow": {
"enable": false,
"have": true
},
"time": {
"enable": false,
"exclude": false
}
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 策略详情数据 |
| data.id | integer | 策略 ID |
| data.strategy | object | 完整策略配置对象 |
| data.strategy.enable | boolean | 是否启用策略 |
| data.strategy.name | string | 策略名称 |
| data.strategy.desc | string | 策略描述 |
| data.strategy.sendcontent | object | HTTP 外发内容审计配置 |
| data.strategy.sendcontent.webbs | boolean | 是否审计 WebBBS |
| data.strategy.sendcontent.webmail | boolean | 是否审计 WebMail |
| data.strategy.sendcontent.attachment | boolean | 是否审计附件 |
| data.strategy.sendcontent.text | boolean | 是否审计文本 |
| data.strategy.sendcontent.weibo | object | 微博审计配置 |
| data.strategy.sendcontent.weibo.enable | boolean | 是否启用微博审计 |
| data.strategy.sendcontent.weibo.attachment | boolean | 是否审计微博附件 |
| data.strategy.accessite | object | 访问网站/下载审计配置 |
| data.strategy.accessite.addr | boolean | 是否审计地址 |
| data.strategy.accessite.content | boolean | 是否审计内容 |
| data.strategy.accessite.disabled | boolean | 访问网站审计是否禁用 |
| data.strategy.accessite.filename | boolean | 是否审计文件名 |
| data.strategy.accessite.urltype | array | URL 分类列表 |
| data.strategy.accessite.urltype[].id | string | URL 分类 ID |
| data.strategy.accessite.urltype[].type | string | URL 分类类型 |
| data.strategy.accessite.urltype[].path | string | URL 分类路径 |
| data.strategy.email | object | 邮件审计配置 |
| data.strategy.email.smtp | boolean | 是否审计 SMTP |
| data.strategy.email.pop3 | boolean | 是否审计 POP3 |
| data.strategy.ftp | object | FTP 审计配置 |
| data.strategy.ftp.upload | boolean | 是否审计 FTP 上传 |
| data.strategy.ftp.download | boolean | 是否审计 FTP 下载 |
| data.strategy.telnet | object | Telnet 审计配置 |
| data.strategy.telnet.command | boolean | 是否审计 Telnet 命令 |
| data.strategy.app | object | 网络应用审计配置 |
| data.strategy.app.other | boolean | 是否审计其他应用 |
| data.strategy.app.unknown | boolean | 是否审计未知应用 |
| data.strategy.flowandtime | object | 流量与上网时长配置 |
| data.strategy.flowandtime.flow | object | 流量审计配置 |
| data.strategy.flowandtime.flow.enable | boolean | 是否启用流量审计 |
| data.strategy.flowandtime.flow.have | boolean | 是否具备流量审计能力 |
| data.strategy.flowandtime.time | object | 上网时长审计配置 |
| data.strategy.flowandtime.time.enable | boolean | 是否启用时长审计 |
| data.strategy.flowandtime.time.exclude | boolean | 是否排除指定时长 |
| success | boolean | 请求是否成功 |
MAC表项限制接口
一、接口概览
| 序号 | 接口路径 | 功能说明 |
|---|---|---|
| 1 | /index.php/switch_mac_limit/list | 查询所有MAC限速策略 |
| 2 | /index.php/switch_mac_limit/add | 创建新的MAC限速策略 |
| 3 | /index.php/switch_mac_limit/enable | 启用MAC限速策略 |
| 4 | /index.php/switch_mac_limit/disable | 禁用MAC限速策略 |
| 5 | /index.php/switch_mac_limit/delete | 删除MAC限速策略 |
| 6 | /index.php/wl_ap/listCenterSwitch | 查询可选择交换机列表(树形结构) |
| 7 | /index.php/switch_isolate_group/getSwitchPortTable | 查询指定交换机的端口列表 |
二、接口详细说明
2.1 MAC限速列表
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "list" |
| start | integer | 否 | 分页起始位置,默认 0 |
| limit | integer | 否 | 每页条数,默认 50 |
| sort | string | 否 | 排序字段 |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50
}
响应 Body
{
"data": [
{
"id": 1,
"name": "TestMacLimit",
"enable": 0,
"desc": "测试MAC限速",
"port_arr": [],
"switch_arr": [],
"creator": "admin"
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | MAC限速策略列表数组 |
| data[].id | integer | 策略ID(启用/禁用/删除时需要) |
| data[].name | string | 策略名称(用户视角取值Key) |
| data[].enable | integer | 启用状态:0=禁用,1=启用 |
| data[].desc | string | 描述 |
| data[].port_arr | array | 关联端口数组 |
| data[].switch_arr | array | 关联交换机数组 |
| data[].creator | string | 创建者 |
| total | integer | 总记录数 |
| success | boolean | 请求是否成功 |
后续接口取值: 接口3-5需要 $.data[?(@.name==#policyName#)].id
2.2 新增MAC限速
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "add" |
| data | object | 是 | 策略数据对象 |
| data.enable | boolean | 否 | 启用状态,默认 true |
| data.id | string | 否 | 新增时传空字符串 "" |
| data.name | string | 是 | 策略名称(服务端强制必填) |
| data.desc | string | 否 | 描述 |
| data.limit_max | integer | 否 | MAC地址最大数量限制 |
| data.action | integer | 否 | 动作类型:0=仅告警,1=阻断 |
| data.switchs | array | 否 | 交换机对象数组(从交换机列表获取) |
| data.ports | array | 否 | 端口对象数组(从端口列表获取) |
ports 数组元素字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 端口ID(如 "2") |
| type | string | 是 | 端口类型(如 "trunk_m") |
| path | string | 是 | 端口路径,格式:{交换机名称}-port{端口号} |
| switch_id | string | 是 | 所属交换机ID |
| name | string | 是 | 端口名称(如 "2") |
| port_id | integer | 是 | 物理端口号 |
| port_type | string | 是 | 端口类型标识(如 "sig") |
| type_no | integer | 是 | 端口类型编号 |
| hardware_ver | string | 是 | 硬件版本(如 "CAP-S5128") |
| is_stack | boolean | 是 | 是否堆叠端口 |
请求示例
{
"opr": "add",
"data": {
"enable": true,
"id": "",
"name": "test",
"desc": "",
"ports": [
{
"id": "2",
"type": "trunk_m",
"path": "D4_68_BA_11_31_60-port2",
"switch_id": "4803766304178224",
"name": "2",
"port_id": 2,
"port_type": "sig",
"type_no": 1,
"hardware_ver": "CAP-S5128",
"is_stack": false,
"software_version": ""
}
],
"limit_max": 10,
"action": 0
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.3 启用MAC限速
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "enable" |
| data | object | 是 | 包含ID数组的对象 |
| data.id | array | 是 | 策略ID数组,从接口2.1获取 |
请求示例
{
"opr": "enable",
"data": {
"id": [1]
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.4 禁用MAC限速
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "disable" |
| data | object | 是 | 包含ID数组的对象 |
| data.id | array | 是 | 策略ID数组,从接口2.1获取 |
请求示例
{
"opr": "disable",
"data": {
"id": [1]
}
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [],
"successCount": 0,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 失败列表 |
| errorCount | integer | 失败数量 |
| succList | array | 成功列表 |
| successCount | integer | 成功数量 |
| success | boolean | 请求是否成功 |
2.5 删除MAC限速
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "delete" |
| data | object | 是 | 包含ID数组的对象 |
| data.id | array | 是 | 策略ID数组,从接口2.1获取 |
请求示例
{
"opr": "delete",
"data": {
"id": [1]
}
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [],
"successCount": 0,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 失败列表 |
| errorCount | integer | 失败数量 |
| succList | array | 成功列表 |
| successCount | integer | 成功数量 |
| success | boolean | 请求是否成功 |
2.6 查询可选择交换机
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "listCenterSwitch" |
| branch_id | integer | 否 | 分支ID,默认 0 |
| node | string | 否 | 节点标识,默认 "root" |
| filter_low_version | boolean | 否 | 是否过滤低版本,默认 true |
| url | string | 否 | URL路径,默认 "/index.php/wl_ap" |
请求示例
{
"opr": "listCenterSwitch",
"branch_id": 0,
"node": "root",
"filter_low_version": true,
"url": "/index.php/wl_ap"
}
响应 Body
{
"tree": [
{
"id": 0,
"count": 0,
"branch_id": 0,
"name": "本机",
"auth_style": 0,
"type": "branch",
"branch_type": "wac",
"leaf": false,
"checkable": false,
"children": [
{
"id": 101,
"count": 0,
"name": "默认组",
"branch_id": 0,
"leaf": false,
"checkable": false,
"type": "grp",
"auth_style": 0,
"key_id": "grp_101",
"is_area": false,
"is_switch": true,
"children": [
{
"is_sense_switch": false,
"sense_status": false,
"id": "4803766304178224",
"ext_board": null,
"support_ext_board_list": [],
"is_chassis": false,
"is_stack": false,
"hardware_ver": "CAP-S5128",
"auth_style": 0,
"is_forward": false,
"name": "D4_68_BA_11_31_60",
"type": "ap",
"mac": "00-11-11-00-00-25",
"leaf": true,
"branch_id": 0,
"stkinfo": "STK1",
"voice": false,
"software_version": "",
"sw_work_mode": 1,
"key_id": "ap_4803766304178224",
"count": 0
}
]
}
],
"key_id": "branch_0",
"deletable": false,
"all_area_id": 100
}
],
"all": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| tree | array | 交换机树形结构数组 |
| tree[].id | integer | 分支ID |
| tree[].name | string | 分支名称(用户视角取值Key) |
| tree[].children | array | 子节点数组 |
| tree[].children[].id | integer | 组ID |
| tree[].children[].name | string | 组名称(用户视角取值Key) |
| tree[].children[].children | array | 交换机节点数组 |
| tree[].children[].children[].id | string | 交换机ID(add接口需要) |
| tree[].children[].children[].name | string | 交换机名称(用户视角取值Key) |
| tree[].children[].children[].mac | string | 交换机MAC地址 |
| tree[].children[].children[].hardware_ver | string | 硬件版本 |
| tree[].children[].children[].is_stack | boolean | 是否堆叠 |
| all | boolean | 是否返回全部数据 |
取值公式:$.tree[?(@.name==#branchName#)].children[?(@.name==#groupName#)].children[?(@.name==#switchName#)].id
2.7 查询可选择端口
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "getSwitchPortTable" |
| branch_id | integer | 否 | 分支ID,默认 0 |
| data | object | 是 | 查询参数对象 |
| data.id | string | 是 | 交换机ID(从接口2.6获取) |
| data.from | string | 否 | 来源标识,默认 "reserve" |
| data.include_stackport | boolean | 否 | 是否包含堆叠端口,默认 true |
请求示例
{
"opr": "getSwitchPortTable",
"branch_id": 0,
"data": {
"id": "4803766304178224",
"from": "reserve",
"include_stackport": true
}
}
响应 Body
{
"data": {
"ports": [
{
"is_agr": false,
"vlan_text": "Access: 1",
"lan_port_id": 1,
"poe_support": true,
"ap_exist": true,
"id": "1",
"port": "D4_68_BA_11_31_60-port1",
"desc": "",
"status": 0,
"is_sense_port": false,
"lldp_conf": null,
"interface_type": "2",
"mode": "0",
"type_no": 1,
"ext_board_id": 0,
"type": 0,
"vlan_support": "1",
"is_dhcp_trust_port": "0",
"member_id": 0,
"slot_id": 0,
"is_looptest_vlan_ref": false,
"is_linked_port": false,
"ecn_ref": false,
"pfc_ref": false,
"selected": true
}
],
"agrs": [],
"mlagp": []
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 返回数据对象 |
| data.ports | array | 端口列表数组 |
| data.ports[].id | string | 端口ID(add接口需要) |
| data.ports[].port | string | 端口路径,格式:{交换机名称}-port{端口号} |
| data.ports[].lan_port_id | integer | 物理端口号(对应 port_id) |
| data.ports[].type_no | integer | 端口类型编号 |
| data.ports[].type | integer | 端口类型:0=普通端口,1=聚合端口 |
| data.ports[].is_agr | boolean | 是否聚合端口 |
| data.ports[].vlan_text | string | VLAN信息文本 |
| data.ports[].poe_support | boolean | 是否支持PoE |
| data.ports[].status | integer | 端口状态 |
| data.agrs | array | 聚合端口列表 |
| data.mlagp | array | MLAG端口列表 |
| success | boolean | 请求是否成功 |
取值公式:$.data.ports[?(@.id==#portName#)]或$.data.ports[?(@.lan_port_id==#portNumber#)]
SNMP配置接口
一、接口概览
| 序号 | 接口路径 | 功能说明 |
|---|---|---|
| 1 | /index.php/sw_snmp_planning/list | 查询SNMP策略列表 |
| 2 | /index.php/sw_snmp_planning/listDetail | 查询单条SNMP策略完整配置 |
| 3 | /index.php/sw_snmp_planning/listCenterSwitchStackErg | 获取SNMP配置生效范围内的交换机树形结构 |
二、接口详细说明
1. SNMP配置列表
请求 Body
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "list" |
| start | integer | 否 | 分页起始位置,默认 0 |
| limit | integer | 否 | 每页数量,默认 50 |
| search | string | 否 | 名称搜索关键词 |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"search": ""
}
响应 Body
{
"data": [
{
"id": 2,
"name": "old_record",
"enable": true,
"v1v2_enable": true,
"v1v2_name": "zxt_test",
"v3_enable": true,
"v3_name": "zxt_test",
"traps_count": 4,
"switch_arr": ["12109276337260789808", "10670249220982636592"]
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | SNMP策略列表 |
| data[].id | integer | 策略ID(系统标识) |
| data[].name | string | 策略名称(用户可感知) |
| data[].enable | boolean | 是否启用 |
| data[].v1v2_enable | boolean | 是否启用v1/v2 |
| data[].v1v2_name | string | v1/v2团体名 |
| data[].v3_enable | boolean | 是否启用v3 |
| data[].v3_name | string | v3用户名 |
| data[].traps_count | integer | Trap数量 |
| data[].switch_arr | array[string] | 生效交换机ID列表 |
| total | integer | 总记录数 |
| success | boolean | 操作成功标识 |
后续接口取值:接口2、5、6、7、8均需此接口的id,取值路径 $.data[?(@.name==#策略名称#)].id
2. SNMP配置详情
请求 Body
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "listDetail" |
| data.id | integer | 是 | 策略ID,省略返回"记录不存在" |
请求示例
{
"opr": "listDetail",
"data": {
"id": 1
}
}
响应 Body
{
"data": {
"id": 1,
"name": "old_record",
"enable": true,
"switchs": [
{
"id": "12109276337260789808",
"type": "ap",
"path": "/本机/默认组/RS3300-28T-4F",
"branch_id": 0,
"hardware_ver": "RS3300-28T-4F"
}
],
"lldp": null,
"v1v2": {
"enable": true,
"name": "zxt_test",
"visit_host": "all",
"all": true,
"specific": {
"enable": false,
"value": null
},
"access_rights": 1
},
"v3": {
"enable": true,
"content": "noAuth",
"name": "zxt_test",
"identity": {
"enable": true,
"algorithm": "sha",
"password": "admin123",
"confirm_password": "admin123"
},
"data_encrypt": {
"enable": true,
"algorithm": "des",
"password": "Qwer1234",
"confirm_password": "Qwer1234"
},
"user_rights": 2
},
"traps": [
{
"enable": true,
"name": "zxt_test_1",
"ip": "10.220.1.99",
"port": 162,
"id": 1
}
]
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.id | integer | 策略ID |
| data.name | string | 策略名称 |
| data.enable | boolean | 是否启用 |
| data.switchs | array | 生效交换机列表(完整对象) |
| data.switchs[].id | string | 交换机ID |
| data.switchs[].type | string | 节点类型,固定值 "ap" |
| data.switchs[].path | string | 交换机路径 |
| data.switchs[].branch_id | integer | 分支ID |
| data.switchs[].hardware_ver | string | 硬件版本 |
| data.lldp | object/null | LLDP配置 |
| data.v1v2 | object | SNMP v1/v2配置 |
| data.v1v2.enable | boolean | 是否启用v1/v2 |
| data.v1v2.name | string | 团体名 |
| data.v1v2.visit_host | string | 访问主机类型:"all" 或 "specific" |
| data.v1v2.all | boolean | 是否允许所有主机 |
| data.v1v2.access_rights | integer | 访问权限:1=只读,2=读写 |
| data.v3 | object | SNMP v3配置 |
| data.v3.enable | boolean | 是否启用v3 |
| data.v3.content | string | 上下文 |
| data.v3.name | string | 用户名 |
| data.v3.user_rights | integer | 用户权限:1=只读,2=读写 |
| data.v3.identity | object | 身份认证配置 |
| data.v3.data_encrypt | object | 数据加密配置 |
| data.traps | array | Trap配置列表 |
| data.traps[].id | integer/string | Trap ID,新增时为空字符串 |
| data.traps[].name | string | Trap名称 |
| data.traps[].ip | string | Trap目标IP |
| data.traps[].port | integer | Trap端口 |
| data.traps[].enable | boolean | 是否启用 |
| success | boolean | 操作成功标识 |
后续接口取值:接口5编辑时建议以此接口完整data对象作为提交基础,避免字段丢失
3. SNMP生效交换机树查询
请求 Body
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "listCenterSwitchStackErg" |
| data.parent | string | 是 | 父节点标识,默认 "root" |
| data.req_page | string | 是 | 请求页面标识,固定值 "snmp" |
请求示例
{
"opr": "listCenterSwitchStackErg",
"data": {
"parent": "root",
"req_page": "snmp"
}
}
响应 Body
{
"data": {
"tree": [
{
"id": 0,
"count": 0,
"branch_id": 0,
"name": "本机",
"auth_style": 0,
"type": "branch",
"branch_type": "wac",
"leaf": false,
"checkable": true,
"key_id": "branch_0",
"deletable": false,
"all": false,
"all_area_id": 100,
"children": [
{
"id": 101,
"count": 0,
"name": "默认组",
"branch_id": 0,
"leaf": false,
"type": "grp",
"auth_style": 0,
"key_id": "grp_101",
"is_area": false,
"is_switch": true,
"all": false,
"children": [
{
"is_sense_switch": false,
"sense_status": true,
"id": "12109276337260789808",
"ext_board": [],
"support_ext_board_list": [],
"is_chassis": false,
"is_stack": false,
"hardware_ver": "RS3300-28T-4F",
"auth_style": 0,
"is_forward": false,
"name": "RS3300-28T-4F",
"type": "ap",
"mac": "A8-0C-CA-AB-C9-79",
"leaf": true,
"branch_id": 0,
"stkinfo": "STK2",
"voice": false,
"software_version": "SW3.9 BUILD20251011-101822",
"sw_work_mode": 1,
"key_id": "ap_12109276337260789808",
"count": 0,
"checkable": true
},
{
"is_sense_switch": false,
"sense_status": true,
"id": "10670249220982636592",
"ext_board": [],
"support_ext_board_list": [],
"is_chassis": false,
"is_stack": false,
"hardware_ver": "RS3300-52T-4F",
"auth_style": 0,
"is_forward": false,
"name": "RS3300-52T-4F_down",
"type": "ap",
"mac": "94-14-57-22-11-8F",
"leaf": true,
"branch_id": 0,
"stkinfo": "STK2",
"voice": false,
"software_version": "SW3.9 BUILD20251011-093513",
"sw_work_mode": 1,
"key_id": "ap_10670249220982636592",
"count": 0,
"checkable": true
}
]
}
]
}
],
"all": true
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.tree | array | 树形结构根节点列表 |
| data.tree[].id | integer | 分支ID |
| data.tree[].name | string | 分支名称(如"本机") |
| data.tree[].type | string | 节点类型:"branch"(分支节点) |
| data.tree[].branch_id | integer | 分支标识 |
| data.tree[].children | array | 分组列表(grp节点) |
| data.tree[].children[].id | integer | 分组ID |
| data.tree[].children[].name | string | 分组名称(如"默认组") |
| data.tree[].children[].type | string | 节点类型:"grp"(分组节点) |
| data.tree[].children[].children | array | 交换机列表(ap节点) |
| data.tree[].children[].children[].id | string | 交换机ID(必取字段) |
| data.tree[].children[].children[].name | string | 交换机名称(必取字段) |
| data.tree[].children[].children[].branch_id | integer | 分支ID(必取字段) |
| data.tree[].children[].children[].type | string | 节点类型(必取字段),固定值 "ap" |
| data.tree[].children[].children[].mac | string | 交换机MAC地址 |
| data.tree[].children[].children[].hardware_ver | string | 硬件版本 |
| data.tree[].children[].children[].software_version | string | 软件版本 |
| data.tree[].children[].children[].is_chassis | boolean | 是否机箱式交换机 |
| data.tree[].children[].children[].is_stack | boolean | 是否堆叠交换机 |
| data.all | boolean | 是否全量返回 |
| success | boolean | 操作成功标识 |
树形结构层级关系:tree[branch] → children[grp] → children[ap]
后续接口取值:接口4新增时需要从此树中获取交换机信息,需通过分组名称和交换机名称双重定位
交换机ARP防御接口
一、接口概览
| 序号 | 接口路径 | 接口功能说明 |
|---|---|---|
| 1 | /index.php/sw_arp_security/list | 查询交换机ARP防御策略列表 |
| 2 | /index.php/wl_smart_rf/listCenterSwitch | 获取可选交换机树形列表 |
| 3 | /index.php/sw_dhcp_security/get_port_grp_by_switchs | 根据交换机获取端口组列表 |
| 4 | /index.php/switch_dhcp_snooping/getSwitchPortTable | 获取交换机端口详细信息 |
| 5 | /index.php/sw_arp_security/add | 新增交换机ARP防御策略 |
| 6 | /index.php/sw_arp_security/modify | 修改交换机ARP防御策略 |
| 7 | /index.php/sw_arp_security/delete | 删除交换机ARP防御策略 |
| 8 | /index.php/sw_arp_security/enable | 启用交换机ARP防御策略 |
| 9 | /index.php/sw_arp_security/disable | 禁用交换机ARP防御策略 |
二、接口详细说明
2.1 查询列表
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "list" |
| start | integer | 否 | 分页起始位置,默认 0 |
| limit | integer | 否 | 每页条数,默认 50 |
| sort | string | 否 | 排序字段,如 "name" |
| direction | string | 否 | 排序方向,"ASC" 或 "DESC" |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"sort": "name",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"id": 2,
"name": "test_sw_arp_capture",
"desc": "",
"enable": true,
"switchs": "/本机/默认组/00_E2_22_00_F3_33,/本机/默认组/RS3300-28T-4F",
"creator": "admin"
}
],
"total": 1,
"sms_notify": false,
"app_notify": false,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 策略列表数组 |
| data[].id | integer | 策略ID,后续操作的关键字段 |
| data[].name | string | 策略名称 |
| data[].desc | string | 策略描述 |
| data[].enable | boolean | 是否启用 |
| data[].switchs | string | 关联交换机路径(逗号分隔) |
| data[].creator | string | 创建者 |
| total | integer | 总记录数 |
| success | boolean | 操作是否成功 |
2.2 交换机树
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "listCenterSwitch" |
| parent | string | 是 | 固定值 "root" |
| show_port | string | 是 | 固定值 "no" |
| is_filter_tree | boolean | 是 | 固定值 true |
| req_page | string | 是 | 固定值 "arp_security" |
| rec_id | string | 否 | 编辑时传入当前记录id,新增时传空字符串 "" |
| hide_msg | boolean | 否 | 固定值 true |
| support_stack | boolean | 否 | 固定值 true |
| filter_low_version | boolean | 否 | 固定值 true |
请求示例
{
"opr": "listCenterSwitch",
"parent": "root",
"show_port": "no",
"is_filter_tree": true,
"req_page": "arp_security",
"rec_id": "",
"hide_msg": true,
"support_stack": true,
"filter_low_version": true
}
响应 Body
{
"data": {
"tree": [
{
"id": 0,
"count": 0,
"branch_id": 0,
"name": "本机",
"type": "branch",
"branch_type": "wac",
"leaf": false,
"children": [
{
"id": 2,
"name": "默认组",
"branch_id": 0,
"leaf": false,
"type": "grp",
"is_switch": true,
"children": [
{
"id": "63650732212158512",
"hardware_ver": "RS3300-28T-4F",
"name": "00_E2_22_00_F3_33",
"type": "ap",
"mac": "00-E2-22-00-F3-33",
"leaf": true,
"branch_id": 0,
"software_version": "SW3.9.1 BUILD20260511-015949"
}
]
}
]
}
],
"all": false
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.tree | array | 树形结构数据 |
| data.tree[].children | array | 子节点列表 |
| data.tree[].children[].children | array | 交换机列表 |
| data.tree[].children[].children[].id | string | 交换机设备ID(关键字段) |
| data.tree[].children[].children[].name | string | 交换机名称 |
| data.tree[].children[].children[].hardware_ver | string | 硬件版本 |
| data.tree[].children[].children[].type | string | 设备类型,固定值 "ap" |
| data.tree[].children[].children[].branch_id | integer | 分支ID |
| success | boolean | 操作是否成功 |
2.3 获取SW端口组
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "get_port_grp_by_switchs" |
| start | integer | 否 | 分页起始位置,默认 0 |
| limit | integer | 否 | 每页条数,默认 100 |
| filterCol | array | 否 | 过滤字段列表 |
| sort | string | 否 | 排序字段 |
| filter | string | 否 | 过滤条件 |
| switchs | array | 是 | 交换机列表(来自接口2.2) |
| switchs[].id | string | 是 | 交换机设备ID |
| switchs[].name | string | 是 | 交换机名称 |
| switchs[].type | string | 是 | 设备类型,固定值 "ap" |
| switchs[].hardware_ver | string | 是 | 硬件版本 |
| switchs[].path | string | 是 | 交换机路径 |
请求示例
{
"start": 0,
"limit": 100,
"filterCol": ["name"],
"opr": "get_port_grp_by_switchs",
"sort": "",
"filter": "",
"switchs": [
{
"hardware_ver": "CAP-S5128",
"id": "15305687916624216112",
"type": "ap",
"path": "/本机/默认组/NMC1_SW1",
"name": "NMC1_SW1"
}
]
}
响应 Body
{
"data": [
{
"id": "2",
"index_id": "1",
"name": "NMC1_PORT_GROUP",
"desc": "",
"ports": null,
"port_member": "[{\"ap_id\":\"15305687916624216112\",\"port_type\":1,\"port_id\":1,\"path\":\"NMC1_SW1-port1\"}]",
"creator": "admin",
"ports_array": [
{
"switch_id": "15305687916624216112",
"port_id": 1,
"type": 1
}
],
"port_name": "NMC1_SW1-port1,NMC1_SW1-port2",
"sw_member_port": [
{
"sw_name": "NMC1_SW1",
"ports": ["NMC1_SW1-port1", "NMC1_SW1-port2"]
}
],
"sw_work_modes": [1],
"sw_hardware_ver": ["CAP-S5128"],
"is_cu_switch": false
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 端口组列表 |
| data[].id | string | 端口组ID |
| data[].name | string | 端口组名称 |
| data[].desc | string | 端口组描述 |
| data[].ports_array | array | 端口成员数组 |
| data[].ports_array[].switch_id | string | 交换机ID |
| data[].ports_array[].port_id | integer | 端口ID |
| data[].ports_array[].type | integer | 端口类型 |
| data[].sw_member_port | array | 交换机端口成员信息 |
| data[].sw_member_port[].sw_name | string | 交换机名称 |
| data[].sw_member_port[].ports | array | 端口名称列表 |
| success | boolean | 操作是否成功 |
2.4 获取SW端口列表
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "getSwitchPortTable" |
| branch_id | integer | 否 | 分支ID,默认 0 |
| data.id | string | 是 | 交换机设备ID(来自接口2.2) |
| data.from | string | 是 | 来源标识,如 "arp_trust_port" |
请求示例
{
"opr": "getSwitchPortTable",
"branch_id": 0,
"data": {
"id": "15305687916624216112",
"from": "arp_trust_port"
}
}
响应 Body
{
"data": {
"ports": [
{
"id": "1",
"port": "NMC1_SW1-port1",
"desc": "",
"status": 0,
"type": 0,
"lan_port_id": 1,
"vlan_text": "Access: 1",
"vlan_support": "1",
"mode": "0",
"interface_type": "2",
"type_no": 1,
"is_agr": false,
"poe_support": true,
"ap_exist": true,
"is_dhcp_trust_port": "0",
"is_sense_port": false,
"is_looptest_vlan_ref": false,
"is_linked_port": false,
"selected": true
}
],
"agrs": [],
"mlagp": []
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.ports | array | 端口列表 |
| data.ports[].id | string | 端口ID |
| data.ports[].port | string | 端口名称 |
| data.ports[].desc | string | 端口描述 |
| data.ports[].type | integer | 端口类型(0: 普通端口, 1: 光口) |
| data.ports[].lan_port_id | integer | 物理端口号 |
| data.ports[].vlan_text | string | VLAN信息文本 |
| data.ports[].is_agr | boolean | 是否聚合端口 |
| data.ports[].is_dhcp_trust_port | string | 是否DHCP信任端口 |
| data.agrs | array | 聚合端口列表 |
| data.mlagp | array | MLAG端口列表 |
| success | boolean | 操作是否成功 |
2.5 新增
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "add" |
| data | object | 是 | 策略数据对象 |
| data.enable | boolean | 否 | 是否启用,默认 true |
| data.id | string | 是 | 新增时传空字符串 "" |
| data.name | string | 是 | 策略名称,不能为空 |
| data.desc | string | 否 | 策略描述 |
| data.switchs | array | 否 | 关联交换机列表(来自接口2.2) |
| data.switchs[].id | string | 是 | 交换机设备ID |
| data.switchs[].name | string | 是 | 交换机名称 |
| data.switchs[].type | string | 是 | 固定值 "ap" |
| data.switchs[].hardware_ver | string | 是 | 硬件版本 |
| data.switchs[].path | string | 是 | 交换机路径 |
| data.flood_defense | object | 否 | ARP泛洪防御配置 |
| data.flood_defense.msg_speed_limit | object | 否 | 报文限速配置 |
| data.flood_defense.msg_speed_limit.enable | boolean | 否 | 是否启用报文限速 |
| data.flood_defense.msg_speed_limit.limit_list | array | 否 | 限速配置列表 |
| data.flood_defense.msg_speed_limit.limit_list[].ports_group | array | 否 | 端口组列表(来自接口2.3) |
| data.flood_defense.msg_speed_limit.limit_list[].upper_num | integer | 否 | 上限阈值 |
| data.flood_defense.mac_limit_enable | object | 否 | 终端MAC限速配置 |
| data.flood_defense.mac_limit_enable.enable | boolean | 否 | 是否启用 |
| data.flood_defense.mac_limit_enable.limit_list | array | 否 | 限速配置列表 |
| data.flood_defense.ports_isolation | object | 否 | 端口隔离配置 |
| data.flood_defense.ports_isolation.enable | boolean | 否 | 是否启用端口隔离 |
| data.flood_defense.msg_discard | object | 否 | 免费ARP报文丢弃配置 |
| data.flood_defense.msg_discard.enable | boolean | 否 | 是否启用 |
| data.flood_defense.msg_discard.msg_discard_port | array | 否 | 丢弃端口组列表 |
| data.flood_defense.num_limit | object | 否 | ARP表项数量限制配置 |
| data.flood_defense.num_limit.enable | boolean | 否 | 是否启用 |
| data.flood_defense.num_limit.num_limit_list | array | 否 | 限制配置列表 |
| data.flood_defense.ip_scanning | object | 否 | IP探测攻击检测配置 |
| data.flood_defense.ip_scanning.enable | boolean | 否 | 是否启用 |
| data.flood_defense.ip_scanning.ip_scanning_port | array | 否 | 检测端口组列表 |
| data.flood_defense.ip_scanning.ip_scanning_period | integer | 否 | 检测周期(秒) |
| data.flood_defense.ip_scanning.ip_scanning_threshold | integer | 否 | 上限阈值 |
| data.flood_defense.ip_scanning.ip_scanning_host | array/null | 否 | 信任IP列表 |
| data.spoofing_defense | object | 否 | ARP欺骗防御配置 |
| data.spoofing_defense.update_detect | boolean | 否 | 仅学习本机ARP请求的应答 |
| data.spoofing_defense.legality_detect | boolean | 否 | ARP合法性检测 |
| data.spoofing_defense.dhcp_bind_detect | object | 否 | DHCP绑定检测配置 |
| data.spoofing_defense.dhcp_bind_detect.enable | boolean | 否 | 是否启用 |
| data.spoofing_defense.dhcp_bind_detect.port | object | 否 | 端口配置 |
| data.spoofing_defense.dhcp_bind_detect.port.vlan_port | array | 否 | VLAN端口列表(来自接口2.4) |
| data.spoofing_defense.prevent_gw_cheat | object | 否 | 防网关欺骗配置 |
| data.spoofing_defense.prevent_gw_cheat.enable | boolean | 否 | 是否启用 |
| data.spoofing_defense.prevent_gw_cheat.list | array | 否 | 网关列表 |
| data.alarm_config | array | 否 | 告警事件配置列表 |
| data.alarm_config[].sort_index | integer | 否 | 排序索引 |
| data.alarm_config[].alarm_name | string | 否 | 告警名称 |
| data.alarm_config[].operator | object | 否 | 处理方式配置 |
| data.sms_notify | object | 否 | 短信告警配置 |
| data.sms_notify.enable | boolean | 否 | 是否启用 |
| data.sms_notify.sms_content.content | string | 否 | 短信内容模板 |
| data.sms_notify.phone_list | array | 否 | 手机号码列表 |
| data.app_notify | object | 否 | APP告警配置 |
| data.app_notify.enable | boolean | 否 | 是否启用 |
请求示例
{
"opr": "add",
"data": {
"enable": true,
"id": "",
"name": "test",
"desc": "",
"switchs": [
{
"hardware_ver": "CAP-S5128",
"id": "15305687916624216112",
"type": "ap",
"path": "/本机/默认组/NMC1_SW1",
"name": "NMC1_SW1"
}
],
"flood_defense": {
"msg_speed_limit": {
"enable": true,
"limit_list": [
{
"ports_group": [
{
"name": "NMC1_PORT_GROUP",
"id": "2",
"index_id": "1",
"sw_member_port": [
{
"sw_name": "NMC1_SW1",
"ports": ["NMC1_SW1-port1", "NMC1_SW1-port2"]
}
],
"ports_array": [
{"switch_id": "15305687916624216112", "port_id": 1, "type": 1}
]
}
],
"upper_num": 50
}
]
},
"mac_limit_enable": {"enable": true, "limit_list": []},
"ports_isolation": {"enable": false},
"msg_discard": {"enable": true, "msg_discard_port": []},
"num_limit": {"enable": false, "num_limit_list": []},
"ip_scanning": {
"enable": true,
"ip_scanning_port": [],
"ip_scanning_period": 10,
"ip_scanning_threshold": 1000,
"ip_scanning_host": null
}
},
"spoofing_defense": {
"update_detect": false,
"legality_detect": false,
"dhcp_bind_detect": {
"enable": true,
"port": {
"ports": [],
"vlan_port": [
{
"id": "1",
"type": "trunk_m",
"path": "NMC1_SW1-port1",
"switch_id": "15305687916624216112",
"name": "1",
"port_id": 1,
"port_type": "sig",
"type_no": 1,
"hardware_ver": "CAP-S5128"
}
]
}
},
"prevent_gw_cheat": {"enable": false, "list": []}
},
"alarm_config": [
{
"sort_index": 0,
"alarm_name": "msg_speed_limit",
"operator": {
"method": [{"text": "关闭端口", "value": "block"}],
"rate": 5,
"unit": "minute"
}
}
],
"sms_notify": {
"enable": false,
"sms_content": {"content": "<sw_group>的交换机<switch>发生ARP安全/DHCP安全事件"},
"phone_list": []
},
"app_notify": {"enable": false}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.6 编辑
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "modify" |
| data.id | integer | 是 | 策略ID(来自接口2.1) |
| data.name | string | 是 | 策略名称 |
| data.desc | string | 否 | 策略描述 |
| data.enable | boolean | 否 | 是否启用 |
| data.switchs | array | 否 | 关联交换机列表(结构同新增) |
| data.flood_defense | object | 否 | ARP泛洪防御配置(结构同新增) |
| data.spoofing_defense | object | 否 | ARP欺骗防御配置(结构同新增) |
| data.alarm_config | array | 否 | 告警事件配置列表 |
| data.sms_notify | object | 否 | 短信告警配置 |
| data.app_notify | object | 否 | APP告警配置 |
请求示例
{
"opr": "modify",
"data": {
"enable": true,
"id": 2,
"name": "test_sw_arp_capture",
"desc": "接口抓取测试编辑",
"switchs": [
{
"hardware_ver": "RS3300-28T-4F",
"id": "63650732212158512",
"type": "ap",
"path": "/本机/默认组/00_E2_22_00_F3_33",
"name": "00_E2_22_00_F3_33"
}
],
"flood_defense": {
"msg_speed_limit": {"enable": false, "limit_list": []},
"mac_limit_enable": {"enable": false, "limit_list": []},
"ports_isolation": {"enable": false},
"msg_discard": {"enable": false, "msg_discard_port": []},
"num_limit": {"enable": false, "num_limit_list": []},
"ip_scanning": {
"enable": false,
"ip_scanning_port": [],
"ip_scanning_period": 10,
"ip_scanning_threshold": 1000,
"ip_scanning_host": null
}
},
"spoofing_defense": {
"update_detect": false,
"legality_detect": false,
"dhcp_bind_detect": {"enable": false, "port": {"ports": [], "vlan_port": []}},
"prevent_gw_cheat": {"enable": false, "list": []}
},
"alarm_config": [],
"sms_notify": {
"enable": false,
"sms_content": {"content": "<sw_group>的交换机<switch>发生ARP安全/DHCP安全事件"},
"phone_list": []
},
"app_notify": {"enable": false}
}
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [],
"successCount": 0,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 失败列表 |
| errorCount | integer | 失败数量 |
| succList | array | 成功列表 |
| successCount | integer | 成功数量 |
| success | boolean | 操作是否成功 |
2.7 删除
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "delete" |
| data.id | array | 是 | 策略ID数组(来自接口2.1) |
请求示例
{
"opr": "delete",
"data": {
"id": [2]
}
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [],
"successCount": 0,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 失败列表 |
| errorCount | integer | 失败数量 |
| succList | array | 成功列表 |
| successCount | integer | 成功数量 |
| success | boolean | 操作是否成功 |
2.8 启用
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "enable" |
| data.id | array | 是 | 策略ID数组(来自接口2.1) |
请求示例
{
"opr": "enable",
"data": {
"id": [2]
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.9 禁用
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "disable" |
| data.id | array | 是 | 策略ID数组(来自接口2.1) |
请求示例
{
"opr": "disable",
"data": {
"id": [2]
}
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [],
"successCount": 0,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 失败列表 |
| errorCount | integer | 失败数量 |
| succList | array | 成功列表 |
| successCount | integer | 成功数量 |
| success | boolean | 操作是否成功 |
欺骗检测接口
一、接口概览
| 序号 | 接口路径 | 功能说明 |
|---|---|---|
| 1 | /index.php/sc_wl_cheat_defense/list | 查询欺骗检测策略列表(安全配置模块) |
| 2 | /index.php/sc_wl_cheat_defense/scTree | 获取可选网关(分组)树 |
| 3 | /index.php/sc_wl_cheat_defense/add | 新增欺骗检测策略(安全配置模块) |
| 4 | /index.php/sc_wl_cheat_defense/modify | 修改欺骗检测策略(安全配置模块) |
| 5 | /index.php/sc_wl_cheat_defense/set_status | 启用或禁用策略(支持批量) |
| 6 | /index.php/sc_wl_cheat_defense/delete | 删除欺骗检测策略(支持批量) |
| 7 | /index.php/wl_cheat_defense/list | 查询欺骗检测配置(NAC特有) |
| 8 | /index.php/wl_cheat_defense/modify | 修改欺骗检测配置(NAC特有) |
二、接口详细说明
1. 查询列表(安全配置)
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "list" |
| start | integer | 否 | 分页起始,默认0 |
| limit | integer | 否 | 每页条数,默认不限 |
| sort | string | 否 | 排序字段,如 "name" |
| direction | string | 否 | 排序方向,"ASC" 或 "DESC" |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"sort": "name",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"id": 1,
"name": "TestDeceptionDetect_Auto",
"enable": true,
"desc": "",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": null,
"branch_name": "本机",
"branch_id": null,
"name": null
}
],
"creator": "admin"
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 策略列表 |
| data[].id | integer | 策略ID |
| data[].name | string | 策略名称 |
| data[].enable | boolean | 是否启用 |
| data[].desc | string | 描述 |
| data[].controller | array | 网关列表 |
| data[].controller[].id | integer | 网关ID |
| data[].controller[].type | string | 节点类型 |
| data[].controller[].path | string | 网关路径 |
| data[].controller[].platform | integer | 平台标识 |
| data[].controller[].branch_name | string | 分支名称 |
| data[].controller[].branch_id | integer | 分支ID |
| data[].creator | string | 创建者 |
| total | integer | 总记录数 |
| success | boolean | 操作是否成功 |
2. 获取网关树
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "scTree" |
| parent | string | 是 | 固定值 "root" |
| data.config_id | integer/null | 否 | 编辑时传入当前策略id,新增时传 null |
请求示例
{
"opr": "scTree",
"parent": "root",
"data": {
"config_id": null
}
}
响应 Body
{
"data": [
{
"id": 0,
"name": "本机",
"text": "本机",
"type": "branch",
"branch_type": "wac",
"leaf": true,
"platform": 1,
"version": "NMC3.16.5",
"sub_mode": 0
},
{
"id": 2,
"name": "vnmc105",
"text": "vnmc105",
"type": "branch",
"branch_type": "wac",
"leaf": true,
"platform": 1,
"version": "vNMC3.16.4",
"sub_mode": 0
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 网关列表 |
| data[].id | integer | 网关ID |
| data[].name | string | 网关名称 |
| data[].text | string | 显示文本 |
| data[].type | string | 节点类型 |
| data[].branch_type | string | 分支类型 |
| data[].leaf | boolean | 是否叶子节点 |
| data[].platform | integer | 平台标识 |
| data[].version | string | 版本号 |
| data[].sub_mode | integer | 子模式标识 |
| success | boolean | 操作是否成功 |
3. 新增策略(安全配置)
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "add" |
| data.cheat_defense.enable | boolean | 否 | 是否启用,默认 true |
| data.cheat_defense.id | string | 否 | 新增时传空字符串 "" |
| data.cheat_defense.name | string | 是 | 策略名称,不能为空 |
| data.cheat_defense.desc | string | 否 | 描述,可为空 |
| data.cheat_defense.controller | array | 是 | 网关(分组)列表,省略则 controller=[](功能无意义) |
| data.cheat_defense.controller[].id | integer | 是 | 网关ID,来自 scTree |
| data.cheat_defense.controller[].type | string | 是 | 节点类型,如 "branch" |
| data.cheat_defense.controller[].path | string | 是 | 网关路径,如 "/本机" |
| data.cheat_defense.controller[].platform | integer | 否 | 平台标识,如 1 |
| data.cheat_defense.attack_detection | object | 否 | 欺骗检测配置,省略时服务端使用默认值 |
| data.cheat_defense.attack_detection.bssid | boolean | 否 | 启用BSSID冲突干扰检测,默认 true |
| data.cheat_defense.attack_detection.fake.enable | boolean | 否 | 启用无线欺骗攻击检测,默认 false |
| data.cheat_defense.attack_detection.fake.illegal.warn | boolean | 否 | 处理方式:告警通知,默认 true |
| data.cheat_defense.attack_detection.fake.illegal.add_to_blacklist.enable | boolean | 否 | 加入动态黑名单,默认 false |
| data.cheat_defense.attack_detection.fake.illegal.add_to_blacklist.freeze_time.value | integer | 否 | 冻结时间数值,默认 30 |
| data.cheat_defense.attack_detection.fake.illegal.add_to_blacklist.freeze_time.unit | string | 否 | 冻结时间单位,固定 "minute" |
⚠️ controller 字段标注为必填:省略后服务端返回 success=true 但 controller=[],策略无法关联任何网关,功能无意义。
请求示例
{
"opr": "add",
"data": {
"cheat_defense": {
"enable": true,
"id": "",
"name": "TestDeceptionDetect_Auto",
"desc": "",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": 1
}
],
"attack_detection": {
"bssid": true,
"fake": {
"enable": false,
"illegal": {
"warn": true,
"add_to_blacklist": {
"enable": false,
"freeze_time": {
"value": 30,
"unit": "minute"
}
}
}
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
4. 编辑策略(安全配置)
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "modify" |
| data.cheat_defense.id | integer | 是 | 策略ID,来自列表接口 |
| data.cheat_defense.enable | boolean | 否 | 是否启用 |
| data.cheat_defense.name | string | 是 | 策略名称 |
| data.cheat_defense.desc | string | 否 | 描述 |
| data.cheat_defense.controller | array | 是 | 网关(分组)列表(功能必需) |
| data.cheat_defense.controller[].id | integer | 是 | 网关ID |
| data.cheat_defense.controller[].type | string | 是 | 节点类型 |
| data.cheat_defense.controller[].path | string | 是 | 网关路径 |
| data.cheat_defense.controller[].platform | integer | 否 | 平台标识 |
| data.cheat_defense.attack_detection | object | 否 | 欺骗检测配置 |
| data.cheat_defense.attack_detection.bssid | boolean | 否 | 启用BSSID冲突干扰检测 |
| data.cheat_defense.attack_detection.fake.enable | boolean | 否 | 启用无线欺骗攻击检测 |
| data.cheat_defense.attack_detection.fake.illegal.warn | boolean | 否 | 处理方式:告警通知 |
| data.cheat_defense.attack_detection.fake.illegal.add_to_blacklist.enable | boolean | 否 | 加入动态黑名单 |
| data.cheat_defense.attack_detection.fake.illegal.add_to_blacklist.freeze_time.value | integer | 否 | 冻结时间数值 |
| data.cheat_defense.attack_detection.fake.illegal.add_to_blacklist.freeze_time.unit | string | 否 | 冻结时间单位,固定 "minute" |
请求示例
{
"opr": "modify",
"data": {
"cheat_defense": {
"enable": true,
"id": 1,
"name": "TestDeceptionDetect_Auto",
"desc": "修改后的描述",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": 1
}
],
"attack_detection": {
"bssid": true,
"fake": {
"enable": true,
"illegal": {
"warn": true,
"add_to_blacklist": {
"enable": false,
"freeze_time": {
"value": 30,
"unit": "minute"
}
}
}
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
5. 设置状态(启用/禁用)
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "set_status" |
| data | array | 是 | 策略对象数组,支持批量 |
| data[].id | integer | 是 | 策略ID,来自列表接口 |
| data[].name | string | 是 | 策略名称,来自列表接口 |
| enable | boolean | 是 | true=启用,false=禁用;省略时默认 false |
⚠️ enable 字段标注为必填:省略后服务端返回 success=true 但策略被设为禁用(默认 false),行为与预期不符,建议始终显式传入。
请求示例(启用)
{
"opr": "set_status",
"data": [
{
"id": 1,
"name": "TestDeceptionDetect_Auto"
}
],
"enable": true
}
请求示例(禁用)
{
"opr": "set_status",
"data": [
{
"id": 1,
"name": "TestDeceptionDetect_Auto"
}
],
"enable": false
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
6. 删除策略
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "delete" |
| data | array | 是 | 策略完整对象数组,支持批量删除 |
| data[].id | integer | 是 | 策略ID,来自列表接口 |
| data[].name | string | 是 | 策略名称 |
| data[].enable | boolean | 否 | 启用状态(随列表对象传入) |
| data[].desc | string | 否 | 描述(随列表对象传入) |
| data[].controller | array | 否 | 网关列表(随列表对象传入) |
| data[].creator | string | 否 | 创建者(随列表对象传入) |
请求示例
{
"opr": "delete",
"data": [
{
"id": 1,
"name": "TestDeceptionDetect_Auto",
"enable": true,
"desc": "",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": null,
"branch_name": "本机",
"branch_id": null,
"name": null
}
],
"creator": "admin"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
7. 显示欺骗检测(NAC)
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "list" |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"attack_detection": {
"enable": true,
"illegal": {
"warn": true,
"add_to_blacklist": {
"enable": false,
"freeze_time": {
"value": 30,
"unit": "minute"
}
}
}
},
"interference_detection": {
"bssid": true,
"neighbor": {
"enable": true,
"params": {
"threshold": -75
}
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 欺骗检测配置对象 |
| data.attack_detection | object | 攻击检测配置 |
| data.attack_detection.enable | boolean | 是否启用攻击检测 |
| data.attack_detection.illegal.warn | boolean | 是否告警通知 |
| data.attack_detection.illegal.add_to_blacklist.enable | boolean | 是否加入动态黑名单 |
| data.attack_detection.illegal.add_to_blacklist.freeze_time.value | integer | 冻结时间数值 |
| data.attack_detection.illegal.add_to_blacklist.freeze_time.unit | string | 冻结时间单位 |
| data.interference_detection | object | 干扰检测配置 |
| data.interference_detection.bssid | boolean | 是否启用BSSID冲突干扰检测 |
| data.interference_detection.neighbor | object | 邻居检测配置 |
| data.interference_detection.neighbor.enable | boolean | 是否启用邻居检测 |
| data.interference_detection.neighbor.params.threshold | integer | 邻居检测阈值 |
| success | boolean | 操作是否成功 |
8. 修改欺骗检测(NAC)
请求 Body 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "modify" |
| data.attack_detection | object | 否 | 攻击检测配置 |
| data.attack_detection.enable | boolean | 否 | 是否启用攻击检测 |
| data.attack_detection.illegal.warn | boolean | 否 | 是否告警通知 |
| data.attack_detection.illegal.add_to_blacklist.enable | boolean | 否 | 是否加入动态黑名单 |
| data.attack_detection.illegal.add_to_blacklist.freeze_time.value | integer | 否 | 冻结时间数值 |
| data.attack_detection.illegal.add_to_blacklist.freeze_time.unit | string | 否 | 冻结时间单位 |
| data.interference_detection | object | 否 | 干扰检测配置 |
| data.interference_detection.bssid | boolean | 否 | 是否启用BSSID冲突干扰检测 |
请求示例
{
"opr": "modify",
"data": {
"attack_detection": {
"enable": true,
"illegal": {
"warn": true,
"add_to_blacklist": {
"enable": false,
"freeze_time": {
"value": 30,
"unit": "minute"
}
}
}
},
"interference_detection": {
"bssid": true
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
网关ARP防御接口
一、接口概览
| 序号 | 接口路径 | 功能说明 |
|---|---|---|
| 1 | /index.php/sc_wac_arp_defense/list | 查询网关ARP防御策略列表 |
| 2 | /index.php/sc_wac_arp_defense/scTree | 获取可选的控制器/网关分组树 |
| 3 | /index.php/sc_wac_arp_defense/add | 新增网关ARP防御策略 |
| 4 | /index.php/sc_wac_arp_defense/listDetail | 查询单条策略完整配置 |
| 5 | /index.php/sc_wac_arp_defense/modify | 修改网关ARP防御策略 |
| 6 | /index.php/sc_wac_arp_defense/set_status | 批量启用或禁用策略 |
| 7 | /index.php/sc_wac_arp_defense/delete | 删除一条或多条策略 |
| 8 | /index.php/wac_arp_defense/list | NAC显示控制器ARP防御配置 |
| 9 | /index.php/wac_arp_defense/modify | NAC修改控制器ARP防御配置 |
二、接口详细说明
2.1 网关策略列表
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "list" |
| start | integer | 否 | 分页起始,默认0 |
| limit | integer | 否 | 每页条数,默认50 |
| sort | string | 否 | 排序字段,如 "name" |
| direction | string | 否 | 排序方向,"ASC" 或 "DESC" |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"sort": "name",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"id": 1,
"name": "test_gateway_arp_capture",
"enable": true,
"desc": "接口抓取测试",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": null,
"branch_name": "本机",
"branch_id": null,
"name": null
}
],
"is_default": false
}
],
"total": 1,
"other_uplimit": {
"limit_arp_trust_gateway_num": {
"SIG-5100": 16,
"SFG-2500": 16
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 策略列表 |
| data[].id | integer | 策略ID |
| data[].name | string | 策略名称 |
| data[].enable | boolean | 是否启用 |
| data[].desc | string | 描述 |
| data[].controller | array | 关联的控制器/网关分组列表 |
| data[].is_default | boolean | 是否为默认策略 |
| total | integer | 总记录数 |
| success | boolean | 操作是否成功 |
2.2 网关分组树
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "scTree" |
| parent | string | 否 | 父节点,默认 "root" |
| data.config_id | integer/null | 否 | 配置ID,编辑时传入当前策略id,新增时传 null |
请求示例
{
"opr": "scTree",
"parent": "root",
"data": {
"config_id": null
}
}
响应 Body
{
"data": [
{
"id": 0,
"name": "本机",
"text": "本机",
"type": "branch",
"branch_type": "wac",
"leaf": true,
"platform": 1,
"version": "NMC3.16.5",
"sub_mode": 0
},
{
"id": 2,
"name": "vnmc105",
"text": "vnmc105",
"type": "branch",
"branch_type": "wac",
"leaf": true,
"platform": 1,
"version": "vNMC3.16.4",
"sub_mode": 0
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 控制器/网关分组列表 |
| data[].id | integer | 分组ID |
| data[].name | string | 分组名称 |
| data[].text | string | 显示文本(同name) |
| data[].type | string | 节点类型,如 "branch" |
| data[].branch_type | string | 分支类型,如 "wac" |
| data[].leaf | boolean | 是否为叶子节点 |
| data[].platform | integer | 平台类型 |
| data[].version | string | 版本号 |
| success | boolean | 操作是否成功 |
2.3 新增网关策略
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "add" |
| data.strategy_data.name | string | 是 | 策略名称,不能为空 |
| data.strategy_data.enable | boolean | 否 | 是否启用,默认 true |
| data.strategy_data.id | string | 否 | 新增时传空字符串 "" |
| data.strategy_data.desc | string | 否 | 描述 |
| data.strategy_data.controller | array | 否 | 关联的控制器/网关分组列表 |
| data.strategy_data.controller[].id | integer | 否 | 分组ID,来自接口2 |
| data.strategy_data.controller[].type | string | 否 | 节点类型,如 "branch" |
| data.strategy_data.controller[].path | string | 否 | 分组路径,如 "/本机" |
| data.strategy_data.controller[].platform | integer | 否 | 平台类型,来自接口2 |
| data.strategy_data.gateway_cheat_defense | object | 否 | 网关欺骗防御配置 |
| data.strategy_data.gateway_cheat_defense.net.enable | boolean | 否 | 是否启用网关欺骗防御 |
| data.strategy_data.gateway_cheat_defense.net.wac_arp_trust_obj | array | 否 | 网关IP/MAC绑定列表 |
| data.strategy_data.gateway_cheat_defense.net.arp_is_add_black.enable | boolean | 否 | 是否将可疑网关加入黑名单 |
| data.strategy_data.gateway_cheat_defense.net.arp_is_add_black.arp_black_time.value | string | 否 | 冻结时间值 |
| data.strategy_data.gateway_cheat_defense.net.arp_is_add_black.arp_black_time.unit | string | 否 | 冻结时间单位,固定 "min" |
请求示例
{
"opr": "add",
"data": {
"strategy_data": {
"enable": true,
"id": "",
"name": "test_gateway_arp_capture",
"desc": "接口抓取测试",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": 1
}
],
"gateway_cheat_defense": {
"net": {
"enable": false,
"wac_arp_trust_obj": [],
"arp_is_add_black": {
"enable": false,
"arp_black_time": {
"value": "",
"unit": "min"
}
}
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.4 网关策略详情
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "listDetail" |
| data.id | integer | 是 | 策略ID,来自接口1 |
请求示例
{
"opr": "listDetail",
"data": {
"id": 1
}
}
响应 Body
{
"data": {
"strategy_data": {
"id": 1,
"enable": true,
"name": "test_gateway_arp_capture",
"desc": "接口抓取测试",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": null,
"branch_name": "本机",
"branch_id": null,
"name": null
}
],
"gateway_cheat_defense": {
"net": {
"enable": false,
"wac_arp_trust_obj": [],
"arp_is_add_black": {
"enable": false,
"arp_black_time": {
"value": null,
"unit": "min"
}
}
}
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.strategy_data | object | 完整的策略数据对象 |
| data.strategy_data.id | integer | 策略ID |
| data.strategy_data.name | string | 策略名称 |
| data.strategy_data.enable | boolean | 是否启用 |
| data.strategy_data.desc | string | 描述 |
| data.strategy_data.controller | array | 关联的控制器/网关分组列表 |
| data.strategy_data.gateway_cheat_defense | object | 网关欺骗防御配置 |
| success | boolean | 操作是否成功 |
2.5 编辑网关策略
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "modify" |
| data.strategy_data.id | string | 是 | 策略ID(字符串类型),来自接口4 |
| data.strategy_data.name | string | 是 | 策略名称 |
| data.strategy_data.enable | boolean | 否 | 是否启用 |
| data.strategy_data.desc | string | 否 | 描述 |
| data.strategy_data.controller | array | 否 | 控制器/网关分组列表 |
| data.strategy_data.gateway_cheat_defense | object | 否 | 网关欺骗防御配置(结构同新增) |
⚠️ 类型转换注意: 编辑时 id 字段类型为字符串(如 "1"),与 listDetail 响应中的整数类型不同,需注意类型转换。
请求示例
{
"opr": "modify",
"data": {
"strategy_data": {
"enable": true,
"id": "1",
"name": "test_gateway_arp_capture",
"desc": "接口抓取测试已编辑",
"controller": [
{
"id": 0,
"type": "branch",
"path": "/本机",
"platform": null,
"branch_name": "本机",
"branch_id": null,
"name": null
}
],
"gateway_cheat_defense": {
"net": {
"enable": false,
"wac_arp_trust_obj": [],
"arp_is_add_black": {
"enable": false,
"arp_black_time": {
"value": "",
"unit": "min"
}
}
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.6 启用/禁用网关策略
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "set_status" |
| data | array | 是 | 目标策略列表 |
| data[].id | integer | 是 | 策略ID,来自接口1 |
| data[].name | string | 是 | 策略名称,来自接口1 |
| enable | boolean | 是 | true=启用,false=禁用 |
⚠️ 注意: 省略 enable 或 data 时服务端返回 success=true 但操作无意义,实际使用时必须传入。
请求示例(启用)
{
"opr": "set_status",
"data": [
{
"id": 1,
"name": "test_gateway_arp_capture"
}
],
"enable": true
}
请求示例(禁用)
{
"opr": "set_status",
"data": [
{
"id": 1,
"name": "test_gateway_arp_capture"
}
],
"enable": false
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.7 删除网关策略
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "delete" |
| data | array | 是 | 待删除的策略列表 |
| data[].id | integer | 是 | 策略ID,来自接口1 |
| data[].name | string | 是 | 策略名称,来自接口1 |
请求示例
{
"opr": "delete",
"data": [
{
"id": 1,
"name": "test_gateway_arp_capture"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.8 NAC控制器ARP防御列表
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "list" |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"net": {
"enable": true,
"wac_arp_trust_obj": [
{
"gw_ip": "1.2.3.4",
"gw_mac": "00-12-33-45-66-77",
"gw_desc": "des"
}
],
"arp_is_add_black": {
"enable": true,
"arp_black_time": {
"value": 5,
"unit": "min"
}
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.net | object | 网络ARP防御配置 |
| data.net.enable | boolean | 是否启用ARP防御 |
| data.net.wac_arp_trust_obj | array | 网关IP/MAC绑定列表 |
| data.net.wac_arp_trust_obj[].gw_ip | string | 网关IP地址 |
| data.net.wac_arp_trust_obj[].gw_mac | string | 网关MAC地址 |
| data.net.wac_arp_trust_obj[].gw_desc | string | 网关描述 |
| data.net.arp_is_add_black | object | 黑名单配置 |
| data.net.arp_is_add_black.enable | boolean | 是否将可疑网关加入黑名单 |
| data.net.arp_is_add_black.arp_black_time | object | 冻结时间配置 |
| data.net.arp_is_add_black.arp_black_time.value | integer | 冻结时间值 |
| data.net.arp_is_add_black.arp_black_time.unit | string | 冻结时间单位,如 "min" |
| success | boolean | 操作是否成功 |
2.9 NAC控制器ARP防御修改
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值 "modify" |
| data.net | object | 是 | 网络ARP防御配置 |
| data.net.enable | boolean | 否 | 是否启用ARP防御 |
| data.net.wac_arp_trust_obj | array | 否 | 网关IP/MAC绑定列表 |
| data.net.wac_arp_trust_obj[].gw_ip | string | 否 | 网关IP地址 |
| data.net.wac_arp_trust_obj[].gw_mac | string | 否 | 网关MAC地址 |
| data.net.wac_arp_trust_obj[].gw_desc | string | 否 | 网关描述 |
| data.net.arp_is_add_black | object | 否 | 黑名单配置 |
| data.net.arp_is_add_black.enable | boolean | 否 | 是否将可疑网关加入黑名单 |
| data.net.arp_is_add_black.arp_black_time.value | integer | 否 | 冻结时间值 |
| data.net.arp_is_add_black.arp_black_time.unit | string | 否 | 冻结时间单位,如 "min" |
请求示例
{
"opr": "modify",
"data": {
"net": {
"enable": true,
"wac_arp_trust_obj": [
{
"gw_ip": "1.2.3.4",
"gw_mac": "00-12-33-45-66-77",
"gw_desc": "des"
}
],
"arp_is_add_black": {
"enable": true,
"arp_black_time": {
"value": 5,
"unit": "min"
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
网关DoS防御接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/sc_wac_ddos_defense/list | 获取网关DoS防御策略列表 |
| /index.php/sc_wac_ddos_defense/listDetail | 获取单条网关DoS防御策略完整配置 |
| /index.php/sc_wac_ddos_defense/scTree | 获取可选网关(分组)树 |
| /index.php/sc_wac_ddos_defense/add | 新增网关DoS防御策略 |
| /index.php/sc_wac_ddos_defense/modify | 修改网关DoS防御策略 |
| /index.php/sc_wac_ddos_defense/delete | 删除网关DoS防御策略 |
| /index.php/sc_wac_ddos_defense/disable | 禁用网关DoS防御策略 |
| /index.php/sc_wac_ddos_defense/enable | 启用网关DoS防御策略 |
| /index.php/wac_ddos_defense/list | 独立模式NAC显示控制器DoS防御配置 |
| /index.php/wac_ddos_defense/modify | 独立模式NAC修改控制器DoS防御配置 |
二、接口详细说明
2.1 sc_wac_ddos_defense_list
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:list |
| start | integer | 否 | 分页起始,默认 0 |
| limit | integer | 否 | 每页条数,默认 50 |
| sort | string | 否 | 排序字段,如 name |
| direction | string | 否 | 排序方向,如 ASC / DESC |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50
}
响应 Body
{
"data": [
{
"id": 1,
"name": "TestGwDoS_Auto",
"desc": "",
"creator": "admin",
"is_default": false,
"enable": true,
"controller": [
{
"id": 6,
"type": "branch",
"path": "/vnmc115",
"platform": null,
"branch_name": "vnmc115",
"branch_id": null,
"name": null
}
]
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 策略列表 |
| data[].id | integer | 策略 ID |
| data[].name | string | 策略名称 |
| data[].desc | string | 策略描述 |
| data[].creator | string | 创建者 |
| data[].is_default | boolean | 是否默认策略 |
| data[].enable | boolean | 是否启用 |
| data[].controller | array | 策略关联的网关节点列表 |
| data[].controller[].id | integer | 网关节点 ID |
| data[].controller[].type | string | 节点类型 |
| data[].controller[].path | string | 网关路径 |
| data[].controller[].platform | integer/null | 平台标识 |
| data[].controller[].branch_name | string/null | 分支名称 |
| data[].controller[].branch_id | integer/null | 分支 ID |
| data[].controller[].name | string/null | 节点名称 |
| total | integer | 策略总数 |
| success | boolean | 请求是否成功 |
2.2 sc_wac_ddos_defense_listDetail
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:listDetail |
| data | object | 是 | 查询条件对象 |
| data.id | integer | 是 | 策略 ID,来自列表接口 |
请求示例
{
"opr": "listDetail",
"data": {
"id": 1
}
}
响应 Body
{
"data": {
"strategy_data": {
"enable": true,
"id": 1,
"name": "TestGwDoS_Auto",
"desc": null,
"controller": [
{
"id": 6,
"type": "branch",
"path": "/vnmc115",
"platform": null,
"branch_name": "vnmc115",
"branch_id": null,
"name": null
}
],
"ddos": {
"enable_dhcp_security": {
"enable": false,
"dhcp_packet_per_second": 10
}
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 响应数据对象 |
| data.strategy_data | object | 策略完整配置对象 |
| data.strategy_data.enable | boolean | 策略是否启用 |
| data.strategy_data.id | integer | 策略 ID |
| data.strategy_data.name | string | 策略名称 |
| data.strategy_data.desc | string/null | 策略描述 |
| data.strategy_data.controller | array | 网关节点数组 |
| data.strategy_data.controller[].id | integer | 网关节点 ID |
| data.strategy_data.controller[].type | string | 节点类型 |
| data.strategy_data.controller[].path | string | 网关路径 |
| data.strategy_data.controller[].platform | integer/null | 平台标识 |
| data.strategy_data.controller[].branch_name | string/null | 分支名称 |
| data.strategy_data.controller[].branch_id | integer/null | 分支 ID |
| data.strategy_data.controller[].name | string/null | 节点名称 |
| data.strategy_data.ddos | object | DoS 防护配置 |
| data.strategy_data.ddos.enable_dhcp_security | object | DHCP 泛洪攻击检测配置 |
| data.strategy_data.ddos.enable_dhcp_security.enable | boolean | 是否启用 DHCP 泛洪攻击检测 |
| data.strategy_data.ddos.enable_dhcp_security.dhcp_packet_per_second | integer | DHCP 包速率上限(包/秒) |
| success | boolean | 请求是否成功 |
2.3 sc_wac_ddos_defense_scTree
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:scTree |
| parent | string | 是 | 固定值:root |
| data | object | 是 | 查询上下文对象 |
| data.config_id | integer/null | 否 | 编辑时传入当前策略 ID,新增时传 null |
请求示例
{
"opr": "scTree",
"parent": "root",
"data": {
"config_id": null
}
}
响应 Body
{
"data": [
{
"id": 0,
"name": "本机",
"text": "本机",
"type": "branch",
"branch_type": "wac",
"leaf": true,
"platform": 1,
"version": "NMC3.16.5",
"sub_mode": 0
},
{
"id": 6,
"name": "vnmc115",
"text": "vnmc115",
"type": "branch",
"branch_type": "wac",
"leaf": true,
"platform": 1,
"version": "vNMC3.16.4",
"sub_mode": 0
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 可选网关节点列表 |
| data[].id | integer | 网关节点 ID |
| data[].name | string | 网关名称 |
| data[].text | string | 网关显示名称 |
| data[].type | string | 节点类型 |
| data[].branch_type | string | 分支类型 |
| data[].leaf | boolean | 是否叶子节点 |
| data[].platform | integer | 平台标识 |
| data[].version | string | 网关版本 |
| data[].sub_mode | integer | 子模式 |
| success | boolean | 请求是否成功 |
2.4 sc_wac_ddos_defense_add
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:add |
| data | object | 是 | 请求数据对象 |
| data.strategy_data | object | 是 | 策略配置对象 |
| data.strategy_data.enable | boolean | 是 | 是否启用策略 |
| data.strategy_data.id | string | 是 | 新增时传空字符串 "" |
| data.strategy_data.name | string | 是 | 策略名称 |
| data.strategy_data.desc | string | 否 | 策略描述 |
| data.strategy_data.controller | array | 是 | 网关节点数组,来自 scTree 接口并按字段裁剪 |
| data.strategy_data.controller[].id | integer | 是 | 网关节点 ID,来自 scTree |
| data.strategy_data.controller[].type | string | 是 | 节点类型,来自 scTree |
| data.strategy_data.controller[].path | string | 是 | 网关路径,由 scTree 的 name/text 拼接 / 前缀得到 |
| data.strategy_data.controller[].platform | integer | 是 | 平台标识,来自 scTree |
| data.strategy_data.ddos | object | 是 | DoS 防护配置 |
| data.strategy_data.ddos.enable_dhcp_security | object | 是 | DHCP 泛洪攻击检测配置 |
| data.strategy_data.ddos.enable_dhcp_security.enable | boolean | 是 | 是否启用 DHCP 泛洪攻击检测 |
| data.strategy_data.ddos.enable_dhcp_security.dhcp_packet_per_second | integer | 否 | DHCP 包速率上限(包/秒),默认 10 |
请求示例
{
"opr": "add",
"data": {
"strategy_data": {
"enable": true,
"id": "",
"name": "TestGwDoS_Auto",
"desc": "",
"controller": [
{
"id": 6,
"type": "branch",
"path": "/vnmc115",
"platform": 1
}
],
"ddos": {
"enable_dhcp_security": {
"enable": false,
"dhcp_packet_per_second": 10
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.5 sc_wac_ddos_defense_modify
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:modify |
| data | object | 是 | 请求数据对象 |
| data.strategy_data | object | 是 | 完整策略对象,基于详情接口返回值修改后提交 |
| data.strategy_data.enable | boolean | 是 | 是否启用策略 |
| data.strategy_data.id | integer | 是 | 策略 ID |
| data.strategy_data.name | string | 是 | 策略名称 |
| data.strategy_data.desc | string/null | 否 | 策略描述 |
| data.strategy_data.controller | array | 是 | 网关节点数组 |
| data.strategy_data.ddos | object | 是 | DoS 防护配置 |
请求示例
{
"opr": "modify",
"data": {
"strategy_data": {
"enable": true,
"id": 1,
"name": "TestGwDoS_Auto",
"desc": "修改后的描述",
"controller": [
{
"id": 6,
"type": "branch",
"path": "/vnmc115",
"platform": null,
"branch_name": "vnmc115",
"branch_id": null,
"name": null
}
],
"ddos": {
"enable_dhcp_security": {
"enable": true,
"dhcp_packet_per_second": 20
}
}
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
2.6 sc_wac_ddos_defense_delete
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:delete |
| data | array | 是 | 待删除的策略完整记录数组,来自列表接口 |
| data[].id | integer | 是 | 策略 ID |
| data[].name | string | 是 | 策略名称 |
| data[].desc | string | 否 | 策略描述 |
| data[].creator | string | 否 | 创建者 |
| data[].is_default | boolean | 否 | 是否默认策略 |
| data[].enable | boolean | 否 | 是否启用 |
| data[].controller | array | 否 | 关联网关节点列表 |
请求示例
{
"opr": "delete",
"data": [
{
"id": 1,
"name": "TestGwDoS_Auto",
"desc": "test",
"creator": "admin",
"is_default": false,
"enable": true,
"controller": [
{
"id": 6,
"type": "branch",
"path": "/vnmc115",
"platform": null,
"branch_name": "vnmc115",
"branch_id": null,
"name": null
}
]
}
]
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": ["TestGwDoS_Auto"],
"successCount": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 删除失败的策略列表 |
| errorCount | integer | 删除失败数量 |
| succList | array | 删除成功的策略名称列表 |
| successCount | integer | 删除成功数量 |
| success | boolean | 请求是否成功 |
2.7 sc_wac_ddos_defense_disable
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:disable |
| data | array | 是 | 待禁用的策略对象数组,来自列表接口并保留 id、name 字段 |
| data[].id | integer | 是 | 策略 ID,来自列表接口 |
| data[].name | string | 是 | 策略名称,来自列表接口 |
请求示例
{
"data": [
{
"id": 17,
"name": "test"
}
],
"opr": "disable"
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [],
"successCount": 0,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 禁用失败的策略列表 |
| errorCount | integer | 禁用失败数量 |
| succList | array | 禁用成功的策略列表 |
| successCount | integer | 禁用成功数量 |
| success | boolean | 请求是否成功 |
2.8 sc_wac_ddos_defense_enable
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:enable |
| data | array | 是 | 待启用的策略对象数组,来自列表接口并保留 id、name 字段 |
| data[].id | integer | 是 | 策略 ID,来自列表接口 |
| data[].name | string | 是 | 策略名称,来自列表接口 |
请求示例
{
"data": [
{
"id": 17,
"name": "test"
}
],
"opr": "enable"
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [],
"successCount": 0,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 启用失败的策略列表 |
| errorCount | integer | 启用失败数量 |
| succList | array | 启用成功的策略列表 |
| successCount | integer | 启用成功数量 |
| success | boolean | 请求是否成功 |
2.9 wac_ddos_defense_list
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:list |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"enable_dhcp_security": {
"enable": true,
"dhcp_packet_per_second": 60
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | 独立模式 NAC 控制器 DoS 防御配置对象 |
| data.enable_dhcp_security | object | DHCP 泛洪攻击检测配置 |
| data.enable_dhcp_security.enable | boolean | 是否启用 DHCP 泛洪攻击检测 |
| data.enable_dhcp_security.dhcp_packet_per_second | integer | DHCP 包速率上限(包/秒) |
| success | boolean | 请求是否成功 |
2.10 wac_ddos_defense_modify
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 固定值:modify |
| data | object | 是 | 独立模式 NAC 控制器 DoS 防御配置对象 |
| data.enable_dhcp_security | object | 是 | DHCP 泛洪攻击检测配置,通常基于 list 接口返回值修改后提交 |
| data.enable_dhcp_security.enable | boolean | 是 | 是否启用 DHCP 泛洪攻击检测 |
| data.enable_dhcp_security.dhcp_packet_per_second | integer | 是 | DHCP 包速率上限(包/秒) |
请求示例
{
"opr": "modify",
"data": {
"enable_dhcp_security": {
"enable": true,
"dhcp_packet_per_second": 60
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 请求是否成功 |
HOSTS 接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/hosts/add | 新增HOSTS记录 |
| /index.php/hosts/list | 显示所有HOSTS列表(分页) |
| /index.php/hosts/listDetail | 显示某个HOST详细信息 |
| /index.php/hosts/modify | 修改某个HOSTS记录 |
| /index.php/hosts/delete | 删除某个HOSTS记录 |
| /index.php/hosts/list | 根据名称或IP查询HOSTS |
二、接口详细说明
2.1 hosts_add — 新增HOSTS
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 add |
| data | object | 是 | HOST数据对象 |
| data.ip | string | 是 | IP地址 |
| data.host | string | 是 | 主机名 |
| data.desc | string | 是 | 描述信息 |
请求示例
{
"opr": "add",
"data": {
"ip": "1.2.3.4",
"host": "aa",
"desc": "des"
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.2 hosts_list — 显示所有HOSTS
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
| start | integer | 是 | 分页起始位置 |
| limit | integer | 是 | 分页每页数量 |
| sort | string | 是 | 排序字段 |
| direction | string | 是 | 排序方向(ASC/DESC) |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"sort": "host",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"ip": "127.0.0.1",
"host": "localhost",
"desc": "回环地址",
"default": true
},
{
"ip": "1.2.3.4",
"host": "aa",
"desc": "des"
}
],
"total": 2,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | HOST列表数组 |
| data[].ip | string | IP地址 |
| data[].host | string | 主机名 |
| data[].desc | string | 描述信息 |
| data[].default | boolean | 是否为默认HOST(可选,仅系统默认HOST存在) |
| total | integer | 总记录数 |
| success | boolean | 操作是否成功 |
2.3 hosts_listDetail — 显示某个HOST详细信息
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 listDetail |
| data | object | 是 | 目标HOST标识对象 |
| data.ip | string | 是 | 目标HOST的IP地址 |
| data.host | string | 是 | 目标HOST的主机名 |
| data.desc | string | 是 | 目标HOST的描述 |
请求示例
{
"opr": "listDetail",
"data": {
"ip": "1.2.3.4",
"host": "aa",
"desc": "des"
}
}
响应 Body
{
"data": {
"ip": "1.2.3.4",
"host": "aa",
"desc": "des"
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | object | HOST详细信息对象 |
| data.ip | string | IP地址 |
| data.host | string | 主机名 |
| data.desc | string | 描述信息 |
| success | boolean | 操作是否成功 |
2.4 hosts_modify — 修改某个HOSTS
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 modify |
| odata | object | 是 | 原HOST数据对象(修改前的值) |
| odata.ip | string | 是 | 原IP地址 |
| odata.host | string | 是 | 原主机名 |
| odata.desc | string | 是 | 原描述信息 |
| data | object | 是 | 新HOST数据对象(修改后的值) |
| data.ip | string | 是 | 新IP地址 |
| data.host | string | 是 | 新主机名 |
| data.desc | string | 是 | 新描述信息 |
请求示例
{
"opr": "modify",
"odata": {
"ip": "1.2.3.4",
"host": "aa",
"desc": "des"
},
"data": {
"ip": "1.2.3.4",
"host": "aa",
"desc": "new_des"
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.5 hosts_delete — 删除某个HOSTS
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 delete |
| data | array | 是 | 待删除的HOST数组 |
| data[].ip | string | 是 | 待删除HOST的IP地址 |
| data[].host | string | 是 | 待删除HOST的主机名 |
| data[].desc | string | 是 | 待删除HOST的描述 |
请求示例
{
"opr": "delete",
"data": [
{
"ip": "1.2.3.4",
"host": "aa",
"desc": "new_des"
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.6 hosts_list_search — 根据名称或IP查询HOSTS
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
| start | integer | 是 | 分页起始位置 |
| limit | integer | 是 | 分页每页数量 |
| search | string | 是 | 搜索关键词(主机名或IP) |
| sort | string | 是 | 排序字段 |
| direction | string | 是 | 排序方向(ASC/DESC) |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"search": "aa",
"sort": "host",
"direction": "ASC"
}
响应 Body
{
"data": [
{
"ip": "1.2.3.4",
"host": "aa",
"desc": "new_des"
}
],
"total": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 匹配搜索条件的HOST列表 |
| data[].ip | string | IP地址 |
| data[].host | string | 主机名 |
| data[].desc | string | 描述信息 |
| total | integer | 匹配记录数 |
| success | boolean | 操作是否成功 |
MAC地址库接口
一、接口概览
| 序号 | 接口名称 | 接口路径 | 功能说明 |
|---|---|---|---|
| 1 | 新增MAC地址库分组 | /index.php/obj_macgroup/add |
新增MAC地址库分组 |
| 2 | 获取MAC地址库分组列表 | /index.php/obj_macgroup/index |
获取MAC地址库分组列表 |
| 3 | 获取MAC地址库分组详情 | /index.php/obj_macgroup/listDetail |
获取MAC地址库分组详情 |
| 4 | 修改MAC地址库分组 | /index.php/obj_macgroup/modify |
修改MAC地址库分组 |
| 5 | 删除MAC地址库分组 | /index.php/obj_macgroup/delete |
删除MAC地址库分组 |
| 6 | 新增MAC地址库 | /index.php/obj_macdb/add |
新增MAC地址库 |
| 7 | 搜索MAC地址库 | /index.php/obj_macdb/list |
搜索MAC地址库 |
| 8 | 修改MAC地址库 | /index.php/obj_macdb/modify |
修改MAC地址库 |
| 9 | 移动MAC地址库到指定分组 | /index.php/obj_macdb/move |
移动MAC地址库到指定分组 |
| 10 | 删除MAC地址库 | /index.php/obj_macdb/delete |
删除MAC地址库 |
二、接口详细说明
2.1 obj_macgroup_add — 新增MAC地址库分组
请求表单schema
本接口使用表单 schema:obj_macgroup.add.json (完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 add | - | - |
| data | object | 是 | 新增分组数据对象 | - | - |
| data.id | string | 否 | 新增时留空字符串(服务端自动分配ID) | - | - |
| data.name | string | 是 | 分组名称。规则:required, check_text | - | - |
请求示例
{"opr":"add","data":{"id":"","name":"mac地址库测试"}}
响应 Body
{
"data": true,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | boolean | 新增结果,true 表示新增成功 |
| success | boolean | 操作成功标识 |
后续接口取值:新增成功后,需调用接口
obj_macgroup/index刷新列表获取新分组的 id,再进行 modify/listDetail/delete 操作。
2.2 obj_macgroup_index — 获取MAC地址库分组列表
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 index | - | - |
| filter | string | 否 | 关键词过滤字符串,配合 filterCol 使用,空字符串表示不过滤 | - | - |
| filterCol | array[string] | 否 | 在哪些列上做关键词过滤,常见值 ["name"] | - | - |
| limit | integer | 否 | 每页条数,默认 100 | - | - |
| start | integer | 否 | 起始偏移量,默认 0 | - | - |
| sort | string | 否 | 排序字段,空字符串表示默认排序 | - | - |
请求示例
{"filterCol":["name"],"opr":"index","start":0,"sort":"","limit":100,"filter":""}
响应 Body
{
"data": [
{
"id": 1,
"name": "默认黑名单",
"leaf": true,
"deletetable": true,
"creator": "system",
"is_system": 1,
"group_type": 1
},
{
"id": 2,
"name": "默认白名单",
"leaf": true,
"deletetable": true,
"creator": "system",
"is_system": 1,
"group_type": 1
},
{
"id": 3,
"name": "默认重点用户",
"leaf": true,
"deletetable": true,
"creator": "system",
"is_system": 1,
"group_type": 1
},
{
"id": 4,
"name": "test_group",
"leaf": true,
"deletetable": true,
"creator": "admin",
"is_system": 0,
"group_type": 1
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array[object] | MAC分组列表 |
| data[].id | integer | 分组ID |
| data[].name | string | 分组名称 |
| data[].leaf | boolean | 是否叶子节点(固定 true) |
| data[].deletetable | boolean | 是否允许删除 |
| data[].creator | string | 创建者,系统默认分组为 system,用户自建为用户名 |
| data[].is_system | integer | 是否系统创建:1=系统创建,0=用户创建 |
| data[].group_type | integer | 分组类型:1=重点用户组 |
| success | boolean | 操作成功标识 |
后续接口取值:接口
obj_macgroup/add、obj_macgroup/modify、obj_macgroup/listDetail、obj_macgroup/delete需本接口的 id,取值路径$.data[].id;obj_macgroup/delete同时需本接口的 name(用于删除返回结果中“成功列表”展示),取值路径$.data[].name。
说明
- 系统内置3个分组:
默认黑名单(id=1)、默认白名单(id=2)、默认重点用户(id=3)。
2.3 obj_macgroup_listDetail — 获取MAC地址库分组详情
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 listDetail | - | - |
| data | object | 是 | 详情查询数据对象 | - | - |
| data.id | string | 是 | 待查询分组ID。规则:requried | /index.php/obj_macgroup/index | $.data[].id |
| data.name | string | 否 | 分组名称(页面回显用,服务端不查库) | /index.php/obj_macgroup/index | $.data[].name |
| data.desc | string | 否 | 分组描述(页面回显用,服务端不查库) | - | - |
请求示例
{"opr":"listDetail","data":{"id":"68","name":"mac地址库测试"}}
响应 Body
{
"data": [
{
"name": "test_group",
"desc": null,
"id": 4
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array[object] | 详情数据(按页面入参回显,不查库) |
| data[].id | integer | 分组ID |
| data[].name | string | 分组名称 |
| data[].desc | string|null | 分组描述,无描述时为 null |
| success | boolean | 操作成功标识 |
后续接口取值:本接口返回的 data 对象可作为接口
obj_macgroup/modify的提交基础,避免丢字段。
2.4 obj_macgroup_modify — 修改MAC地址库分组
请求表单schema
本接口使用表单 schema:obj_macgroup.add.json (完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 modify | - | - |
| data | object | 是 | 修改分组数据对象 | - | - |
| data.id | string | 是 | 待修改分组ID。规则:requried | /index.php/obj_macgroup/index | $.data[].id |
| data.name | string | 是 | 修改后的分组名称。规则:check_text | - | - |
modify 提交基础:建议以 listDetail 返回的完整 data 对象为底,再覆盖要改的字段,避免丢字段。
请求示例
{"opr":"modify","data":{"id":"68","name":"mac地址库测试1"}}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作成功标识 |
后续接口取值:本接口无返回数据,修改成功后可调用接口
obj_macgroup/index或obj_macgroup/listDetail确认修改结果。
2.5 obj_macgroup_delete — 删除MAC地址库分组
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 delete | - | - |
| data | array[object] | 是 | 待删除分组数组(支持批量) | - | - |
| data[].id | integer | 是 | 待删除分组ID | /index.php/obj_macgroup/index | $.data[].id |
| data[].name | string | 是 | 待删除分组名称(用于删除结果中“成功列表”展示) | /index.php/obj_macgroup/index | $.data[].name |
请求示例
{"opr":"delete","data":[{"id":68,"name":"mac地址库测试1"}]}
响应 Body
{
"succList": [
"test_group_modfiy"
],
"errorList": [],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| succList | array[string] | 删除成功的分组名称列表 |
| errorList | array[object] | 删除失败的分组列表(被引用阻断) |
| errorList[].name | string | 删除失败的分组名称 |
| errorList[].refer | array[string] | 被引用的详情说明列表(如“网关有线认证:xxx”、“重点用户匹配策略:xxx”、“WEB认证策略:xxx”等) |
| success | boolean | 操作成功标识(即使部分失败也返回 true) |
后续接口取值:本接口为流程终点,无后续接口取值。删除成功后可调用接口
obj_macgroup/index刷新列表确认。
2.6 obj_macdb_add — 新增MAC地址库
请求表单schema
本接口使用表单 schema:obj_macdb.add.json (完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 add | - | - |
| branch_id | integer | 否 | 分支 ID(集中管理场景下使用),独立控制器场景为 0 | - | - |
| data | object | 是 | MAC 记录容器 | - | - |
| data.mac | string | 是 | MAC 地址(连字符格式)。规则:trim, required | - | - |
| data.desc | string | 否 | 描述。规则:trim, check_text[1] | - | - |
| data.group | object | 是 | 所属分组对象 | - | - |
| data.group.id | integer | 是 | 分组 ID。规则:trim, required(form_validation 中拼写为 requried) | /index.php/obj_macgroup/index | $.data[].id |
| data.group.name | string | 否 | 分组名称(前端回带,便于展示)。规则:trim | /index.php/obj_macgroup/index | $.data[].name |
⚠️ 提示:
data.group.id缺少时仍会进入业务流程,但 IPC 下发会失败,因此视为功能必需字段。
请求示例
{
"opr": "add",
"data": {
"mac": "15-1E-90-78-07-AE",
"group": {
"name": "默认白名单",
"id": 2
}
},
"branch_id": 0
}
响应 Body
{"success":true}
无权限时返回
success:false,正常成功响应只有{"success":true}。
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 是否新增成功 |
| noPermission | string | 无权限时返回的提示文案(仅失败场景) |
后续接口取值:本接口新增成功后,记录
id由服务端生成,后续modify/delete/move需先调用list拿到该id才能操作。
2.7 obj_macdb_list — 搜索MAC地址库
filter.id = -1 表示查询所有分组。请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list | - | - |
| start | integer | 否 | 分页起始偏移量。规则:check_start, intval。默认 0 | - | - |
| limit | integer | 否 | 每页条数。规则:intval, check_limit。默认 10 | - | - |
| search | string | 否 | 关键字搜索(按 MAC/描述模糊匹配)。规则:trim, check_keyword[1] | - | - |
| direction | string | 否 | 排序方向 asc/desc。规则:trim, strval。默认 asc | - | - |
| sort | string | 否 | 排序字段。规则:trim, strval。默认 name | - | - |
| filter | object | 否 | 过滤条件容器 | - | - |
| filter.id | integer | 否 | 分组 ID 过滤值,-1 表示所有分组。规则:intval。默认 -1 | /index.php/obj_macgroup/index | $.data[].id |
请求示例
{
"opr": "list",
"start": 0,
"limit": 50,
"filter": {
"id": -1
},
"search": "00-11-22-33-44-55"
}
响应 Body
{
"total": 1,
"data": [
{
"id": 0,
"mac": "00-11-22-33-44-55",
"group_id": 4,
"desc": "",
"group_name": "test_group",
"group": 4
}
],
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| total | integer | 总记录数 |
| data | array[object] | MAC 地址记录数组 |
| data[].id | integer | 记录 ID |
| data[].mac | string | MAC 地址(连字符格式,如 4D-21-9C-06-02-B7) |
| data[].group_id | integer | 所属分组 ID |
| data[].desc | string | 描述 |
| data[].group_name | string | 所属分组名称 |
| data[].group | integer | 所属分组 ID(与 group_id 同值) |
| success | boolean | 是否成功 |
后续接口取值:
obj_macdb/modify、obj_macdb/delete、obj_macdb/move的data.id/data[].id/macs[].id取值路径$.data[].id;obj_macdb/add、obj_macdb/modify的data.group.id、data.group.name直接取自页面分组下拉(候选集来源为/index.php/obj_macgroup/index);obj_macdb/delete、obj_macdb/move的data[].group_id/macs[].group_id、data[].group_name/macs[].group_name、data[].mac/macs[].mac取自本接口$.data[].group_id、$.data[].group_name、$.data[].mac。
2.8 obj_macdb_modify — 修改MAC地址库
请求表单schema
本接口使用表单 schema:obj_macdb.add.json (完整内容见 三、表单schema定义)。
注意:schema是表单编辑类接口会提供的重要参考文档,开发过程需要参考schema来定义参数的结构、约束和字段之间的关联性。
说明:schema中的字段如果定义了
x-component,约束校验直接调用 nmc-sdk。示例:表单 name 字段"x-component": "nametextfield",该字段校验方法:r=validators.nametextfield(form.name);…
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 modify | - | - |
| data | object | 是 | MAC 记录容器 | - | - |
| data.id | string | 是 | 记录 ID。规则:trim, requried(form_validation 原拼写) | /index.php/obj_macdb/list | $.data[].id |
| data.mac | string | 是 | MAC 地址。规则:trim, required | /index.php/obj_macdb/list | $.data[].mac |
| data.desc | string | 否 | 描述。规则:trim, check_text[1] | - | - |
| data.group | object | 是 | 目标分组对象 | - | - |
| data.group.id | integer | 是 | 目标分组 ID。规则:trim, requried | /index.php/obj_macgroup/index | $.data[].id |
| data.group.name | string | 否 | 目标分组名称 | /index.php/obj_macgroup/index | $.data[].name |
| data.group.leaf | boolean | 否 | 是否叶子节点(前端回带) | /index.php/obj_macgroup/index | $.data[].leaf |
| data.group.deletetable | boolean | 否 | 是否可删除(前端回带) | /index.php/obj_macgroup/index | $.data[].deletetable |
| data.group.creator | string | 否 | 创建者(前端回带) | /index.php/obj_macgroup/index | $.data[].creator |
| data.group.is_system | integer | 否 | 是否系统分组(前端回带) | /index.php/obj_macgroup/index | $.data[].is_system |
| data.group.group_type | integer | 否 | 分组类型(前端回带) | /index.php/obj_macgroup/index | $.data[].group_type |
| data.ogroup | integer | 是 | 修改前的原分组ID | - | - |
modify 提交基础:建议以 list(或 listDetail)返回的完整 data 对象为底,再覆盖要改的字段,避免丢字段。
编辑接口不支持修改记录所属分组,
data.group请回带该记录原有分组。
请求示例
{
"opr": "modify",
"data": {
"id": "0",
"desc": "test11",
"mac": "90-59-AE-AB-9B-DD",
"group": {
"id": 68,
"name": "mac地址库测试",
"leaf": true,
"deletetable": true,
"creator": "admin",
"is_system": 0,
"group_type": 1
}
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 是否修改成功 |
后续接口取值:本接口不输出可供后续接口取用的字段。
2.9 obj_macdb_move — 移动MAC地址库到指定分组
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 move | - | - |
| data | object | 是 | 目标分组容器 | - | - |
| data.group | object | 是 | 目标分组对象。规则:required | - | - |
| data.group.id | integer | 是 | 目标分组 ID | /index.php/obj_macgroup/index | $.data[].id |
| data.group.name | string | 否 | 目标分组名称 | /index.php/obj_macgroup/index | $.data[].name |
| macs | array[object] | 是 | 待移动 MAC 记录数组。规则:required | - | - |
| macs[].id | integer | 是 | 记录 ID | /index.php/obj_macdb/list | $.data[].id |
| macs[].mac | string | 是 | MAC 地址 | /index.php/obj_macdb/list | $.data[].mac |
| macs[].group_id | integer | 否 | 原分组 ID(前端回带) | /index.php/obj_macdb/list | $.data[].group_id |
| macs[].group | integer | 否 | 原分组 ID(与 group_id 同值) | /index.php/obj_macdb/list | $.data[].group |
| macs[].group_name | string | 否 | 原分组名称 | /index.php/obj_macdb/list | $.data[].group_name |
| macs[].desc | string | 否 | 描述 | /index.php/obj_macdb/list | $.data[].desc |
请求示例
{
"data": {
"group": {
"id": 1,
"name": "默认黑名单"
}
},
"macs": [
{
"id": 0,
"mac": "90-59-AE-AB-9B-DD",
"group_id": 68,
"desc": "test11",
"group_name": "mac地址库测试1",
"group": 68
}
],
"opr": "move"
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 是否移动成功 |
后续接口取值:本接口不输出可供后续接口取用的字段。
2.10 obj_macdb_delete — 删除MAC地址库
请求 Body
| 字段 | 类型 | 必填 | 说明 | 数据来源接口 | 数据来源字段 |
|---|---|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 delete | - | - |
| data | array[object] | 是 | 待删除记录数组。规则:required | - | - |
| data[].id | integer | 是 | 记录 ID | /index.php/obj_macdb/list | $.data[].id |
| data[].mac | string | 是 | MAC 地址 | /index.php/obj_macdb/list | $.data[].mac |
| data[].group_id | integer | 是 | 所属分组 ID | /index.php/obj_macdb/list | $.data[].group_id |
| data[].group | integer | 是 | 所属分组 ID(与 group_id 同值) | /index.php/obj_macdb/list | $.data[].group |
| data[].group_name | string | 否 | 所属分组名称 | /index.php/obj_macdb/list | $.data[].group_name |
| data[].desc | string | 否 | 描述 | /index.php/obj_macdb/list | $.data[].desc |
请求示例
{
"opr": "delete",
"data": [
{
"id": 0,
"mac": "D5-A4-03-2C-5D-AF",
"group_id": 1,
"desc": "",
"group_name": "默认黑名单",
"group": 1
}
]
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 是否删除成功 |
后续接口取值:本接口不输出可供后续接口取用的字段。
三、表单schema定义
1. obj_macgroup.add.json
使用接口:/index.php/obj_macgroup/add(2.1)、/index.php/obj_macgroup/modify(2.4)
{
"title": "MAC地址库-分组",
"description": "MAC地址库「分组」新增/编辑 — 字段契约(面向外部开放接口)",
"x-api": {
"url": "/index.php/obj_macgroup",
"opr": {
"add": "add",
"edit": "modify"
},
"x-comment": "提交地址为 /index.php/obj_macgroup,opr 作为顶层参数传入:新增传 'add'、编辑传 'modify'。若需二次确认提交,可在同一 opr 下追加 confirmMsg:true 重发。⚠️ 本接口与 /index.php/obj_macdb 不同——后者是「MAC 地址条目」的 CRUD(字段为 data[mac]/data[desc]/data[group][id]),两者不可混用。⚠️ 第三方开放通道未放开 add 操作,仅放开查询/删除/编辑类接口;如需经该通道新增分组,须先确认接口是否已放开"
},
"x-page": {
"path": "/object/MACGroup",
"menu": "对象 → MAC地址库",
"功能": "维护 MAC 地址库的「分组」(名称),供 MAC 黑白名单条目归属;新增/编辑共用同一弹窗表单"
},
"type": "object",
"required": [
"opr",
"data"
],
"properties": {
"opr": {
"type": "string",
"enum": [
"add",
"modify"
],
"x-comment": "操作类型;新增 'add'、编辑 'modify',由调用方按场景传入,提交时作为顶层参数。⚠️ 分组删除(opr='delete')不属于本表单契约:删除由页面独立发起,data 为 [{id}] 形式的数组,字段结构与本文件不同"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"default": "",
"x-comment": "分组 id。新增(opr='add')时提交空串 \"\",后端不要求该字段;编辑(opr='modify')时回传原 id,后端要求该字段必填。前端不对此字段做校验"
},
"name": {
"type": "string",
"x-component": "nametextfield",
"x-comment": "分组名称;必填,不允许为空白(trim 后非空),提交前会 trim。后端新增时同样要求必填。校验规则由公共组件 `nametextfield` 提供(见 x-component),不接受其它特殊字符,仅允许中文、英文字母、数字、空格、下划线及英文句点,长度上限 95 个字符;具体约束由「公共校验提取」环节统一注入,本文件不复制。⚠️ 业务保留名:名称为「所有」的分组已存在且受保护,提交该名称会被拒绝并提示「记录已存在,请检查是否有创建过、或其他管理员创建过该配置」,外部调用方不可创建同名分组。⚠️ 名称大小写:前后端均按输入原样处理(不做大小写转换),去重与匹配时请注意大小写敏感"
}
},
"required": [
"name"
]
}
},
"x-comment": "本表单无顶层开关(无 enable 总闸),无提交前字段改写逻辑,无子表,无联动显隐控制——全部字段均为无条件提交。前端表单实际提交 2 个字段:id 与 name,均位于 data 之下;此外接口在后端另接受一个可选字段 desc(前端未暴露,见 desc 节点说明)。⚠️ 本表单另有一个内嵌使用场景:MAC 条目表单的「分组」下拉支持直接新增分组,该入口复用本表单,提交地址与字段契约完全一致,仅触发位置不同"
}
2. obj_macdb.add.json
使用接口:/index.php/obj_macdb/add(2.6)、/index.php/obj_macdb/modify(2.8)
{
"title": "MAC黑白名单",
"description": "MAC黑白名单(MAC地址库条目)新增/编辑 — 前端校验规则(面向外部开放接口)",
"x-api": {
"url": "/index.php/obj_macdb",
"opr": {
"add": "add",
"edit": "modify"
},
"x-comment": "操作类型非固定:新增传 'add',编辑传 'modify'。编辑场景前端优先采用调用方传入的操作类型,缺省回退为 'modify';外部调用方沿用页面行为时请传 'modify'。若服务端返回需要二次确认,前端会用同一操作类型并追加 confirmMsg:true 再次提交。接口地址 /index.php/obj_macdb 为 MAC地址库条目接口,请勿与 /index.php/obj_macgroup(分组接口,提交字段为分组名与分组描述)混淆"
},
"x-page": {
"path": "/object/MACGroup",
"menu": "对象 → MAC地址库",
"功能": "维护 MAC 黑白名单条目(MAC 地址 + 描述 + 所属分组),新增/编辑共用同一弹窗表单"
},
"type": "object",
"required": [
"opr",
"data"
],
"properties": {
"opr": {
"type": "string",
"enum": [
"add",
"modify"
],
"x-comment": "操作类型;新增 'add'、编辑 'modify'(见 x-api.x-comment)。由调用方按 add/modify 场景传入,提交时作为顶层参数"
},
"branch_id": {
"type": "integer",
"x-comment": "分支 ID;可选,仅集中管理(多分支)场景下使用。该字段不在表单内,由页面运行环境注入,与 data 平级提交。接口文档标注为「否」(选填),独立控制器场景示例值为 0;外部调用方按自身部署形态决定是否携带"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"default": "",
"x-comment": "记录 id;新增时传空字符串 \"\",编辑时回传原值,且编辑(modify)场景为必填(接口文档标注为必填)"
},
"mac": {
"type": "string",
"x-required": true,
"x-comment": "MAC地址;必填,前端做格式校验。接受无分隔符 12 位十六进制(可带 0x 前缀)、英文冒号分隔(aa:bb:cc:dd:ee:ff)、英文中横线分隔(aa-bb-cc-dd-ee-ff),以及 XX-* 通配形式(1~5 个 XX- 前缀,如 aa-*、aa-bb-*、aa-bb-cc-*、aa-bb-cc-dd-*、aa-bb-cc-dd-ee-*);字母不区分大小写。⚠️ 提交前前端会标准化该值:无分隔符时按每 2 位插入 '-',再整体转大写,并把 ':' 全部替换为 '-',服务端最终收到的一定是大写、中横线分隔的形式(如 AA-BB-CC-DD-EE-FF 或 AA-BB-*-…)。外部调用方传入任意受支持格式均可"
},
"desc": {
"type": "string",
"maxLength": 95,
"x-component": "desctextfield",
"x-comment": "描述;选填。校验规则由公共组件 `desctextfield` 提供(见 x-component),具体正则/长度约束由「公共校验提取」环节统一注入,本文件不复制。maxLength:95 为表单显式声明的长度上限"
},
"group": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"x-required": true,
"x-comment": "分组 id;必填,服务端按分组 id 落库。类型为 integer(示例值 2)"
},
"name": {
"type": "string",
"x-comment": "分组名称(回显用);前端提交时携带所选分组的完整对象 {id, name}"
},
"leaf": {
"type": "boolean",
"x-readonly": true,
"x-comment": "是否叶子节点。由前端从分组列表接口取回后原样回带,非用户输入;选中分组后随 group 对象一并提交"
},
"deletetable": {
"type": "boolean",
"x-readonly": true,
"x-comment": "该分组是否可删除。由前端从分组列表接口取回后原样回带,非用户输入;选中分组后随 group 对象一并提交"
},
"creator": {
"type": "string",
"x-readonly": true,
"x-comment": "分组创建者。由前端从分组列表接口取回后原样回带,非用户输入;选中分组后随 group 对象一并提交"
},
"is_system": {
"type": "integer",
"x-readonly": true,
"x-comment": "是否系统内置分组(0/1)。由前端从分组列表接口取回后原样回带,非用户输入;选中分组后随 group 对象一并提交"
},
"group_type": {
"type": "integer",
"x-readonly": true,
"x-comment": "分组类型。由前端从分组列表接口取回后原样回带,非用户输入;选中分组后随 group 对象一并提交"
}
},
"x-comment": "所属分组。⚠️ 提交形态为**对象**而非 id 字符串:前端从分组下拉列表中取出所选分组的完整对象;仅当分组列表尚未加载或未选中分组时才退化为空字符串 \"\"。⚠️ 对象内的 leaf / deletetable / creator / is_system / group_type 为分组记录的回带属性(前端从分组列表接口取回后原样带回,非用户输入),只要提交了 group 对象就会一并携带(新增、编辑皆然),属只读回带字段。⚠️ 可编辑性:编辑已有记录时不支持修改所属分组,mac 与 group 两个字段均为只读(不可编辑),仅 desc 可改;新增时两者可编辑,且会自动默认选中页面当前所处的分组。⚠️ 编辑提交时建议以查询接口返回的完整 data 对象为底再覆盖改动项,避免回带属性丢失(接口文档亦有此提示)"
}
},
"required": [
"mac",
"group"
]
}
},
"x-comment": "无顶层启用开关。提交前前端会对 mac 做标准化改写:无分隔符时按每 2 位插入 '-',再整体转大写,最后把 ':' 替换为 '-'。本表单无子表。所属分组的填写支持通过下拉框内嵌「新增分组」弹窗(该弹窗字段为分组名称,必填),属下拉框的内嵌新增能力,非本表单提交字段。⚠️ 字段范围提示:本契约以表单实际提交字段为准,并依据接口文档补齐了字段——顶层 branch_id(集中管理场景,环境注入,文档标为选填),以及 data.group 内的 5 个只读回带属性(leaf/deletetable/creator/is_system/group_type,文档中标注为「前端回带」)。这些字段均不在表单 UI 中,对接方按需携带。⚠️ 字段范围随 opr 变化:add 不含 data.id,modify 必含 data.id(新增时前端提交空字符串 \"\")。⚠️ data.group 在 add/modify 两场景均为必填(其内 group.id 亦为必填;文档标为必填)"
}
SNMP服务接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/snmp/list | 读取 SNMP 服务配置 | verified |
二、接口详细说明
2.1 list — 读取 SNMP 配置
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"v1v2": {
"enable": false,
"name": null,
"visit_host": "all",
"all": true,
"specific": { "enable": false, "value": null }
},
"v3": {
"enable": false,
"content": "noAuth",
"name": null,
"identity": {
"enable": false,
"algorithm": "sha",
"password": null,
"confirm_password": null
},
"data_encrypt": {
"enable": false,
"algorithm": "des",
"password": null,
"confirm_password": null
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.v1v2.enable | boolean | 启用 SNMP v1/v2c |
| data.v1v2.name | string | 团体名(community) |
| data.v1v2.visit_host | string | 访问主机范围(all/specific) |
| data.v1v2.all | boolean | 允许所有主机 |
| data.v1v2.specific | object | 指定主机(enable/value) |
| data.v3.enable | boolean | 启用 SNMP v3 |
| data.v3.content | string | 安全级别(noAuth 等) |
| data.v3.name | string | v3 用户名 |
| data.v3.identity | object | 身份认证(enable/algorithm/password/confirm_password) |
| data.v3.data_encrypt | object | 数据加密(enable/algorithm/password/confirm_password) |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功。
Syslog配置接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/syslog_conf/list | 读取 Syslog 配置 | verified |
二、接口详细说明
2.1 list — 读取 Syslog 配置
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"enable": false,
"enable_system_set": { "enable_system": false, "system_min_level": "Warn" },
"enable_manager": false,
"enable_safe": false,
"enable_auth": false,
"enable_dev": false,
"enable_alarm": false,
"log_server_addr": "",
"log_server_port": 514
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.enable | boolean | Syslog 总开关 |
| data.enable_system_set.enable_system | boolean | 系统日志上报开关 |
| data.enable_system_set.system_min_level | string | 系统日志最小级别(如 Warn) |
| data.enable_manager | boolean | 管理日志上报开关 |
| data.enable_safe | boolean | 安全日志上报开关 |
| data.enable_auth | boolean | 认证日志上报开关 |
| data.enable_dev | boolean | 设备日志上报开关 |
| data.enable_alarm | boolean | 告警日志上报开关 |
| data.log_server_addr | string | Syslog 服务器地址 |
| data.log_server_port | integer | Syslog 服务器端口 |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功。
平台服务接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/trade_set/list_industry | 读取平台服务行业配置 | verified |
二、接口详细说明
2.1 list_industry — 读取行业配置
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list_industry |
请求示例
{
"opr": "list_industry"
}
响应 Body
{
"data": {
"trade_set": {
"industry": "education",
"title": "营销中心",
"title_en": "Marketing Center",
"bmap_key_setting": { "enable": false, "map_key": "" },
"advance": {}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.trade_set.industry | string | 行业类型 |
| data.trade_set.title | string | 标题(中文) |
| data.trade_set.title_en | string | 标题(英文) |
| data.trade_set.bmap_key_setting.enable | boolean | 百度地图 Key 开关 |
| data.trade_set.bmap_key_setting.map_key | string | 百度地图 Key |
| data.trade_set.advance | object | 高级配置(整体引用,随行业变化) |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功。
日期时间接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/date_time/list | 读取系统日期时间配置 | verified |
二、接口详细说明
2.1 list — 读取日期时间
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"datetime": { "sys_date": "2026-07-23", "sys_time": "22:02" },
"local": { "timezone": 8 },
"srv": { "enable": true, "ntp": "time.windows.com" }
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.datetime.sys_date | string | 系统日期(YYYY-MM-DD) |
| data.datetime.sys_time | string | 系统时间(HH:mm) |
| data.local.timezone | integer | 时区(东八区为 8) |
| data.srv.enable | boolean | NTP 同步开关 |
| data.srv.ntp | string | NTP 服务器地址 |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功。
服务接口
一、接口概览
| 接口路径 | 接口功能说明 |
|---|---|
| /index.php/sw_horizontal_interdict_service/add | 新增漏洞利用防御服务 |
| /index.php/sw_horizontal_interdict_service/delete | 删除漏洞利用防御服务 |
| /index.php/sw_horizontal_interdict_service/list | 显示漏洞利用防御服务列表 |
二、接口详细说明
2.1 sw_horizontal_interdict_service_add(新增漏洞利用防御服务)
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 add |
| data | object | 是 | 新增服务配置对象 |
| data.name | string | 是 | 服务名称,不可重复 |
| data.desc | string | 否 | 服务描述,空字符串表示不填写描述 |
| data.port | string | 是 | 服务端口,多个端口可使用逗号分隔 |
| data.threat_server | boolean | 是 | 是否标记为威胁/风险服务 |
请求示例
{
"opr": "add",
"data": {
"name": "test",
"desc": "",
"port": "1",
"threat_server": true
}
}
响应 Body
{
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| success | boolean | 操作是否成功 |
2.2 sw_horizontal_interdict_service_delete(删除漏洞利用防御服务)
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 delete |
| data | array | 是 | 待删除服务对象数组 |
| data[].id | integer | 是 | 服务 ID,来自服务列表接口 |
| data[].name | string | 是 | 服务名称,来自服务列表接口 |
| data[].desc | string | 否 | 服务描述,来自服务列表接口 |
| data[].port | string | 是 | 服务端口,来自服务列表接口 |
| data[].is_threat_server | boolean | 是 | 是否为威胁/风险服务,来自服务列表接口 |
| data[].risk_desc | string | 否 | 风险描述,来自服务列表接口 |
| data[].is_default | boolean | 是 | 是否为系统默认服务,来自服务列表接口;系统默认服务不可删除 |
请求示例
{
"opr": "delete",
"data": [
{
"id": 17,
"name": "test",
"desc": "",
"port": "1",
"is_threat_server": true,
"risk_desc": "",
"is_default": false
}
]
}
响应 Body
{
"errorList": [],
"errorCount": 0,
"succList": [
"test"
],
"successCount": 1,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errorList | array | 删除失败的服务列表 |
| errorCount | integer | 删除失败数量 |
| succList | array | 删除成功的服务名称列表 |
| successCount | integer | 删除成功数量 |
| success | boolean | 操作是否成功 |
⚠️ 系统默认服务(is_default=true)不可删除,删除接口应选择自定义服务(is_default=false)。
2.3 sw_horizontal_interdict_service_list(显示漏洞利用防御服务列表)
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
| sort | string | 是 | 排序字段,示例值 is_risk |
| direction | string | 是 | 排序方向,示例值 ASC |
| start | integer | 是 | 分页起始位置 |
| limit | integer | 是 | 每页条数 |
| search | string | 否 | 搜索关键字,空字符串表示不搜索 |
| service_type | string | 是 | 服务类型过滤,示例值 all |
请求示例
{
"opr": "list",
"sort": "is_risk",
"direction": "ASC",
"start": 0,
"limit": 50,
"search": "",
"service_type": "all"
}
响应 Body
{
"data": [
{
"id": 15,
"name": "MySQL",
"desc": "MySQL服务",
"port": "3306",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 14,
"name": "NFS",
"desc": "网络文件系统服务,通过使用NFS,用户和程序可以像访问本地文件一样访问远端系统上的文件",
"port": "2049",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 13,
"name": "IMAP2",
"desc": "IMAP互联网消息存取服务,可以通过客户端直接对服务器上的邮件进行操作。",
"port": "143",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 12,
"name": "POP3",
"desc": "POP3电子邮件传输,本协议主要用于支持使用客户端远程管理在服务器上的电子邮件",
"port": "110",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 11,
"name": "SMTP",
"desc": "SMTP电子邮件传输协议,SMTP是建立在FTP文件传输服务上的一种邮件服务,主要用于系统之间的邮件信息传递,并提供有关来信的通知",
"port": "25",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 10,
"name": "Daytime",
"desc": "日期服务",
"port": "13",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 5,
"name": "SSH",
"desc": "专为远程登录会话和其他网络服务提供的安全性协议",
"port": "22",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 4,
"name": "TELNET",
"desc": "Internet远程登录服务的标准协议和主要方式",
"port": "23",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 3,
"name": "FTP",
"desc": "文件传输协议,是Internet上用来传送文件的协议",
"port": "20,21",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 2,
"name": "HTTPS",
"desc": "超文本传输安全协议,是以安全为目标的HTTP通道",
"port": "443",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 1,
"name": "HTTP",
"desc": "超文本传输协议,被用于在Web浏览器和网站服务器之间传递信息",
"port": "80",
"is_threat_server": false,
"risk_desc": "",
"is_default": true
},
{
"id": 9,
"name": "木马服务",
"desc": "木马常用端口集合",
"port": "31,555,666,1025,1033,1170,1234,1243,1245,1249,1600,1807,1981,1999,2000,2023,2115,2140,2583,2801,3024,3129,3150,3210,3333,3700,3996,4060,4092,4321,4590,5000,5001,5321,50505,5400,5401,5402,5550,5569,5742,6267,6400,6670,6671,6711,6776,6883,6969,7000,7300,7301,7306,7307,7308,7626,7789,9400,9401,9402,9872,9873,9874,9875,9989,10067,10167,11000,11223,12076,12223,12345,12346,12361,16969,19191,20000,20001,20034,21554,22222,23456,26262,26274,27374,30100,30103,30999,31337,31338,31339,31666,33333,34324,40412,40421,40422,40423,40426,43210,44445,53001,54321,61466,65000",
"is_threat_server": true,
"risk_desc": "广外女生木马、NetSPY木马",
"is_default": true
},
{
"id": 8,
"name": "SQL Server",
"desc": "1433用于供SQL Server对外提供服务",
"port": "1433",
"is_threat_server": true,
"risk_desc": "SQLSlammer病毒",
"is_default": true
},
{
"id": 7,
"name": "远程桌面",
"desc": "应用于远程管理终端,多被黑客利用抓鸡",
"port": "3389",
"is_threat_server": true,
"risk_desc": "CVE-2019-0708高危漏洞、Attention勒索病毒、GlobeImposter勒索病毒、Matrix勒索病毒",
"is_default": true
},
{
"id": 6,
"name": "SMB",
"desc": "应用于共享文件夹或共享打印机,其漏洞多被勒索病毒利用",
"port": "139,445",
"is_threat_server": true,
"risk_desc": "永恒之蓝、WannaCry勒索病毒、WannaMine挖矿蠕虫",
"is_default": true
},
{
"id": 17,
"name": "test",
"desc": "",
"port": "1",
"is_threat_server": true,
"risk_desc": "",
"is_default": false
}
],
"total": 16,
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | array | 服务列表数组 |
| data[].id | integer | 服务 ID |
| data[].name | string | 服务名称 |
| data[].desc | string | 服务描述 |
| data[].port | string | 服务端口 |
| data[].is_threat_server | boolean | 是否为威胁/风险服务 |
| data[].risk_desc | string | 风险描述 |
| data[].is_default | boolean | 是否为系统默认服务 |
| total | integer | 服务总数 |
| success | boolean | 查询是否成功 |
短信服务接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/sms_service/list | 读取短信服务配置 | verified |
二、接口详细说明
2.1 list — 读取短信服务
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"sms": {
"enable": false,
"enable_country_code": true,
"modules": {
"inner": { "enable": true, "state": "ON" },
"external": { "enable": false },
"gateway": false
},
"params": {
"gateway_type": "gsm",
"gsm": {},
"http": {
"enable": false,
"url": null,
"charset": "UTF-8",
"template": { "request_tmp": null, "receiv_tmp": null },
"req_type": "get"
},
"country_code": "86"
}
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.sms.enable | boolean | 启用短信总开关 |
| data.sms.enable_country_code | boolean | 启用国家码 |
| data.sms.modules.inner | object | 内置短信模块(enable/state) |
| data.sms.modules.external | object | 外部短信模块 |
| data.sms.modules.gateway | boolean | 网关模块开关 |
| data.sms.params.gateway_type | string | 网关类型,"gsm"=GSM短信猫,"http"=HTTP协议 |
| data.sms.params.gsm | object | GSM 短信猫参数 |
| data.sms.params.http.enable | boolean | HTTP 网关开关 |
| data.sms.params.http.url | string | HTTP 网关 URL 地址(gateway_type=http 时有效) |
| data.sms.params.http.charset | string | 字符集 |
| data.sms.params.http.template.request_tmp | string | 短信请求模板 |
| data.sms.params.http.template.receiv_tmp | string | 接收模板 |
| data.sms.params.http.req_type | string | 请求方式(get/post) |
| data.sms.params.country_code | string | 国家码 |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功。
系统选项接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/system_option/list | 读取系统选项配置 | verified |
二、接口详细说明
2.1 list — 读取系统选项
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"lang": { "mode": "" },
"device": {
"dev_name": "",
"dev_code": "",
"https_port": 443,
"map_https_port": 443,
"cert": { "id": 9999, "name": "SUNDRAY-WAC" },
"tunnelport": 7070,
"dataport": "7077,5246,5247",
"igw_port": 8686,
"discoverport": "",
"centmanageport": 5000,
"custom_conf": "",
"audio_port": 4545
},
"server_ports": { "MQTT_port": 58883, "component_port": 58002 },
"sys": {
"timeout": 1440,
"safeLogin": false,
"disable_https_auth_port": false,
"offline": 30,
"acpolicy": false,
"extral_url_jump": true
},
"webagent": { "checkWebAgent": { "enable": false } }
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.lang.mode | string | 语言模式 |
| data.device.dev_name | string | 设备名称 |
| data.device.dev_code | string | 设备编码 |
| data.device.https_port | integer | HTTPS 管理端口 |
| data.device.map_https_port | integer | 映射 HTTPS 端口 |
| data.device.cert | object | 证书信息(id/name) |
| data.device.tunnelport | integer | 隧道端口 |
| data.device.dataport | string | 数据端口列表 |
| data.device.igw_port | integer | IGW 端口 |
| data.device.discoverport | string | 发现端口 |
| data.device.centmanageport | integer | 集中管理端口 |
| data.device.custom_conf | string | 自定义配置 |
| data.device.audio_port | integer | 音频端口 |
| data.server_ports.MQTT_port | integer | MQTT 端口 |
| data.server_ports.component_port | integer | 组件端口 |
| data.sys.timeout | integer | 会话超时时间(分钟) |
| data.sys.safeLogin | boolean | 安全登录开关 |
| data.sys.disable_https_auth_port | boolean | 禁用 HTTPS 认证端口 |
| data.sys.offline | integer | 离线时长 |
| data.sys.acpolicy | boolean | AC 策略开关 |
| data.sys.extral_url_jump | boolean | 外部 URL 跳转开关 |
| data.webagent.checkWebAgent.enable | boolean | WebAgent 检测开关 |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功。
账号安全策略接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/admin_account/password_policy_detail | 读取管理员账号密码安全策略配置 | verified |
二、接口详细说明
2.1 password_policy_detail — 读取密码安全策略
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 password_policy_detail |
请求示例
{
"opr": "password_policy_detail"
}
响应 Body
{
"data": {
"password_len": 8,
"no_username": true,
"no_weak_password": true,
"password_complex": {
"enable": true,
"items": ["number", "upper_case", "lower_case", "special"],
"satisfy_required": 3
},
"password_safe": {
"enable": false,
"expire": 7,
"valid": 90
},
"login_safe": {
"enable": true,
"errors": 5,
"freeze": 1
}
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.password_len | integer | 密码最小长度 |
| data.no_username | boolean | 密码不能包含用户名 |
| data.no_weak_password | boolean | 禁止使用弱密码 |
| data.password_complex.enable | boolean | 密码复杂度开关 |
| data.password_complex.items | array | 复杂度字符类型集合(number/upper_case/lower_case/special) |
| data.password_complex.satisfy_required | integer | 至少满足的字符类型数量 |
| data.password_safe.enable | boolean | 密码有效期开关 |
| data.password_safe.expire | integer | 到期提前提醒天数 |
| data.password_safe.valid | integer | 密码有效期天数 |
| data.login_safe.enable | boolean | 登录安全(锁定)开关 |
| data.login_safe.errors | integer | 允许连续错误次数 |
| data.login_safe.freeze | integer | 冻结时长 |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功;success=false 表示失败。
邮件服务接口
一、接口概览
| 接口路径 | 接口功能说明 | 状态 |
|---|---|---|
| /index.php/email_service/list | 读取邮件服务配置 | verified |
二、接口详细说明
2.1 list — 读取邮件服务
请求 Body
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| opr | string | 是 | 操作类型,固定值 list |
请求示例
{
"opr": "list"
}
响应 Body
{
"data": {
"enable": false,
"smtp_server": "",
"email_address": "",
"serverPort": 25,
"server_check": { "enable": false, "name": "", "pwd": "" }
},
"success": true
}
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data.enable | boolean | 邮件服务开关 |
| data.smtp_server | string | SMTP 服务器地址 |
| data.email_address | string | 发件人邮箱地址 |
| data.serverPort | integer | SMTP 服务器端口 |
| data.server_check.enable | boolean | 服务器认证开关 |
| data.server_check.name | string | 认证用户名 |
| data.server_check.pwd | string | 认证密码 |
| success | boolean | 操作是否成功 |
成功/失败语义: success=true 表示读取成功。