网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

新增该站点模板的SSID配置

更新时间:2025-02-17 GMT+08:00
分享

典型场景

提供新增站点模板内AP的SSID配置列表接口。

接口功能

新增站点模板内AP的SSID配置列表。

接口约束

该接口支持租户视图或msp代维视图下,用户角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。

调用方法

POST

URI

/controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/apssid

表1 path参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

siteTemplateId

string

36个字符。

-

站点模板标识,UUID格式。

"fbde1c5d-5b94-49e3-a912-48641015e45c"

请求参数

表2 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

siteTemplateSsidConfigDto

REFERENCE

详细请参见表3

站点模板SSID配置参数,结构体参见SiteTemplateSsidConfigDto。

-

表3 SiteTemplateSsidConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

name

string

1~32个字符。

-

SSID名称。长度为1~32字节(UTF-8编码),不能包含特殊符号&、=、?、#、%、+。当以空格开头或结尾时,最大长度减少2字节;当以"开头时,最大长度减少1字节。

"Huawei-Guest"

pki

string

0~50个字符。

-

pki参数证书域。

"default"

tags

ARRAY_REFERENCE

0-10个列表项,详细请参见表4

设备标签列表,总数不能超过10个。如果指定标签列表,SSID会下发给带有列表中标签的设备。如果不指定,会下发给站点模板绑定的站点内所有设备。

-

enable

boolean

  • true

  • false

true

工作状态开启。

true

timeTemplateId

string

-

-

时间模板ID。时间模板可以通过第三方开放接口https://host:port/controller/campus/v3/networkconfig/timetemplate得到。

"2c3918cb-f0bd-44e3-963b-119870bfc779"

connectionMode

string

  • bridge

  • nat

-

网络连接方式,大小写敏感,前后不能有空格,且不能含有全角字符。当配置为nat时,全局DHCP分配地址开关打开,bridge则为关闭。

"nat"

vlans

ARRAY_REFERENCE

0-1个列表项,详细请参见表5

SSID所属的VLAN配置信息。站点模板与站点配置的AP SSID不同,此处站点模板的同一SSID所属VLAN不支持按照标签进行差异化配置,最大仅可以配置一个SiteTemplateVlanDto对象,考虑后续扩展,采用数组方式,结构体参见SiteTemplateVlanDto。

-

customVlans

ARRAY_REFERENCE

0-251个列表项,详细请参见表6

按照标签进行差异化配置。

-

vlanMode

string

6~8个字符。满足正则表达vlanId|vlanPool。

-

VLAN模式。

"vlanId"

vlanPoolId

string

36个字符。

-

VLAN pool id。

"1e930b21-a307-45a9-96a2-f1443ca84f39"

vlanPoolName

string

1~32个字符。

-

VLAN pool 名称。

"vlanPool"

hidedEnable

boolean

  • true

  • false

false

是否隐藏SSID。

false

autoOffTrackLinkEnable

boolean

  • true

  • false

fasle

断链关断开关。默认值为false。

false

arpCheckEnable

boolean

  • true

  • false

true

arp检测功能使能开关。默认值为true。

true

ipCheckEnable

boolean

  • true

  • false

true

IPSG功能使能开关。默认值为true。

true

dhcpStrictEnable

boolean

  • true

  • false

false

终端地址严格DHCP获取,依赖ipCheckEnable开启。默认值为false。

false

dhcpv6SlaacStrictEnable

int32

[0-2]

0

ipv6终端地址严格DHCP获取(0:disable 1:dhcpv6-strict 2:dhcpv6-slaac),依赖ipCheckEnable开启,默认值为0,仅部分款型设备某些版本支持,具体款型和版本信息可查看产品资料。

0

mdnsSnoopingEnable

boolean

  • true

  • false

fasle

mdns snooping开关。默认值为false。

false

dnsSnoopingEnable

boolean

  • true

  • false

fasle

dns snooping开关。默认值为false。

false

gameSpeedUpEnable

boolean

  • true

  • false

true

手游加速开关,默认打开。

false

relativeRadios

integer

[1-7]

-

射频类型。

1 --- 2.4G(wlan-radio 0/0/0)。

2 --- 5G(wlan-radio 0/0/1)。

3 --- 2.4G(wlan-radio 0/0/0)&5G(wlan-radio 0/0/1)。

4 --- 5G/6G(wlan-radio 0/0/2)。

5 --- 2.4G(wlan-radio 0/0/0)&5G/6G(wlan-radio 0/0/2)。

6 --- 5G(wlan-radio 0/0/1)&5G/6G(wlan-radio 0/0/2)。

7 --- 2.4G(wlan-radio 0/0/0)&5G(wlan-radio 0/0/1)&5G/6G(wlan-radio 0/0/2)。

3

relativeOnlyTwoRadios

integer

[1-4]

-

射频类型,这里为射频口的默认频段,射频调优后可能会进行冗余射频调整。对双射频口款型生效。若该字段入参不携带,继承relativeRadios的配置。

1 --- 2.4G(wlan-radio 0/0/0)。

2 --- 5G(wlan-radio 0/0/1)。

3 --- 2.4G(wlan-radio 0/0/0)&5G(wlan-radio 0/0/1)。

4 --- 空配置。若站点下存在双射频款型时,该款型会配置结果报错,ssid不进行下发。

3

dtimInterval

int32

[1-255]

1

DTIM周期.

1

advertiseApNameSwitch

boolean

  • true

  • false

false

Beacon帧携带AP name使能开关,默认关闭。

true

frequencyNavigation

boolean

  • true

  • false

true

是否开启频谱导航。

true

maxUserNumber

integer

[1-600]

-

最大用户数。

64

blackAndWhite

REFERENCE

详细请参见表7

-

-

userSeparation

boolean

  • true

  • false

true

是否用户隔离。当userSeparation为true时,开启二三层用户隔离。

false

separationOption

string

-

-

用户隔离状态。取值范围:all---开启二三层隔离,l2---开启二层隔离,disable---不隔离。当userSeparation为true时,separationOption只允许为all 或 l2,默认为all;当userSeparation为false时,separationOption只允许为disable。V200R019C10版本以及之后的设备版本,separationOption生效。

"disable"

userL2LanIsolate

boolean

  • true

  • false

false

设备间二层用户隔离开关。开启后,用户报文只能访问网关。默认值为false。

false

staNetworkDetect

boolean

  • true

  • false

true

sta-network-detect开关。默认为true。

true

muMiMo

boolean

  • true

  • false

true

mimo开关。默认值为true。

true

associationTimeout

integer

[1-30]

-

终端老化时间(分钟)。

5

erSuSwitch

boolean

  • true

  • false

true

ER-SU远距离覆盖开关。默认值为true。

true

userFlowSyslogEnable

boolean

  • true

  • false

false

上报用户流量信息开关。默认值为false。

false

multiLinkOper

boolean

  • true

  • false

false

多链路链接开关。默认值为false。

false

lay3RoamSwitch

boolean

  • true

  • false

true

三层漫游开关。默认值为true。

true

suExtendedRangeSwitch

boolean

  • true

  • false

false

suer模式开关,当前版本未实现。默认值为false。

false

muRtsSwitch

boolean

  • true

  • false

false

MU-RTS使能开关,当前版本未实现。默认值为false。

false

muRtsThreshold

int64

[64-65535]

2347

MU-RTS门限,当前版本未实现。默认值为2347。

2347

forbiddenOldTerminal

boolean

  • true

  • false

false

禁止传统终端接入。

false

reachMaxSta

integer

[1-3]

-

接入阈值策略 范围:1:SSID接入的终端达到阈值后,新用户禁止接入。 2:SSID接入的终端达到阈值后,新用户禁止接入,且自动隐藏该SSID。 3:SSID接入的终端达到阈值后,VIP用户优先接入,替换掉普通用户。

1

igmpSnooping

boolean

  • true

  • false

false

是二层组播的基本功能,可以实现组播数据在数据链路层的转发和控制。

false

multicast2Unicast

string

  • disable

  • enable

  • dynamic-adaptive

-

组播转单播,如果要黑盒功能可用,需要开启igmpSnooping。

"disable"

bcmcDenyAll

boolean

  • true

  • false

false

广播或组播禁止,非必填。现网中没有业务依赖于除ARP/ND/DHCP以外的广播或组播报文,可以通过禁止空口所有广播或组播报文的发送,提高空口性能。

false

bonjourTransparent

boolean

  • true

  • false

false

bonjour透传

false

powerSave

boolean

  • true

  • false

false

高级省电功能,U-APSD(Unscheduled Automatic Power Save Delivery)功能。缺省情况下,U-APSD功能未使能。

false

beacon2gRate

string

  • 1Mbps

  • 2Mbps

  • 5.5Mbps

  • 6Mbps

  • 9Mbps

  • 11Mbps

  • 12Mbps

  • 18Mbps

  • 24Mbps

  • 36Mbps

  • 48Mbps

  • 54Mbps

-

2.4G射频Beacon帧发送速率(Mbps)

"1Mbps"

beacon5gRate

string

  • 6Mbps

  • 9Mbps

  • 12Mbps

  • 18Mbps

  • 24Mbps

  • 36Mbps

  • 48Mbps

  • 54Mbps

-

5G射频Beacon帧发送速率(Mbps)

"6Mbps"

beacon6gRate

string

-

-

6G射频Beacon帧发送速率(Mbps),支持6Mbps、9Mbps、12Mbps、18Mbps、24Mbps、36Mbps、48Mbps、54Mbps

"6Mbps"

sipPort

integer

[1-65535]

-

SIP协议端口

5060

timeTemplateName

string

-

-

时间模板名称,非必填

"全天"

seaSwitch

boolean

  • true

  • false

false

音频质量分析。

false

overDsPrivate

string

  • disable

  • enable

-

端管协同漫游

使能端管协同漫游功能后只支持开放网络(Open和Open+Portal)、半开放网络(PSK+WPA2+AES、PPSK+WPA2+AES)、安全网络(802.1X+WPA2+AES)。

括号内的认证场景指代字段:开放网络即mode是open,半开放和安全网络为(认证模式+加密模式+加密算法)的组合。

认证模式 - mode

加密模式 - 根据不同的场景对应:pskEncryptType、dot1xEncryptType

加密算法 - securityKeyType

"disable"

ssidAuth

REFERENCE

详细请参见表8

-

-

vapBackupConfig

REFERENCE

详细请参见表12

-

-

ssidPolicy

REFERENCE

详细请参见表13

-

-

dot11r

boolean

  • true

  • false

false

使能802.11r快速漫游功能。默认值为false。

使能802.11r快速漫游功能后只支持开放网络(Open和Open+Portal)、半开放网络(PSK+WPA2+AES、PPSK+WPA2+AES、PSK-SAE+WPA2-WPA3+AES、SAE+WPA3+AES)、安全网络(802.1X+WPA2+AES、802.1X+WPA2-WPA3+AES、802.1X+WPA3+CCMP128)。

括号内的认证场景指代字段:开放网络即mode是open,半开放和安全网络为(认证模式+加密模式+加密算法)的组合。

认证模式 - mode

加密模式 - 根据不同的场景对应:pskEncryptType、saeEncryptType、pskSaeEncryptType、dot1xEncryptType

加密算法 - securityKeyType

false

overDs

boolean

  • true

  • false

false

使能802.11r快速漫游功能over the ds协议。当dot11r为true时才生效。默认值为false。

false

reassociateTimeout

integer

[1-10]

1

重新关联的超时时间,单位为秒。默认值为1。

1

serviceGuarantee

string

  • performanceFirst

  • reliabilityFirst

performanceFirst

业务保障功能模式。可选:performanceFirst 性能优先,非AR/VR场景使用。reliabilityFirst 可靠性优先,AR/VR场景使用,提升用户体验,不配或配其他值时默认下performanceFirst配置。

"performanceFirst"

activeDullClient

boolean

  • true

  • false

false

抑制省电开关。设备默认是省电的,如果该开关打开,会让设备切出省点模式,设备切换成正常模式,耗点更快。默认值为false。

false

wmmScene

string

-

default

wmm场景,可选四个值,default、voice、voiceAndVideo、customize。该字段主要对报文进行优先级选择,若选default,则按照设备默认优先级处理;若选voice,则设备优先处理涉及音频的报文;若选voiceAndVideo,则优先处理音频和视频的报文;当选择customize时,即自定义优先级,则需要填写EdcaClientDto的相关参数。默认值为default。

"default"

edcaClientConfigList

ARRAY_REFERENCE

0-4个列表项,详细请参见表24

当wmmScene为customize,即自定义时,可选填该数组。若不填,就不更改此配置,结构体参见EdcaClientDto。

-

insertOption82Enable

boolean

  • true

  • false

false

是否插入Option82选项。

false

option82

REFERENCE

详细请参见表25

当insertOption82Enable为true时,该字段必填;为false时,该字段不生效,结构体参见Option82Dto。

-

forwardMode

string

  • direct

  • softgre

-

数据转发模式。可取值为:direct、softgre。

"direct"

softgreProfileId

string

36个字符。

-

softgre模板ID,当forwardMode为softgre时,此字段为必填字段。

"fbde1c5d-5b94-49e3-a912-48641015e45f"

configName

string

0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。

-

配置名称标识

"ssid-tmp-config-name"

phyProtection

string

满足正则表达^(security-priority|business-priority|disable)$。

disable

密盾功能。可选:security-priority 安全优先,对于不支持MU-MIMO功能的终端会拒绝接入;business-priority 业务优先只保障支持MU-MIMO功能的终端的业务安全性;disable:不使能。

"security-priority"

表4 TagDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

name

string

1~32个字符。

-

标签名称。长度为1-32之间。支持中英文,数字以及_和-。

"testApTag"

表5 SiteTemplateVlanDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

vlanId

integer

[1-4094]

-

所属VLAN ID。

10

vlanDesc

string

0~80个字符。

-

VLAN描述。

"work"

表6 CustomVlanDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

priority

int32

[0-250]

-

优先级。0的优先级最低;当取值大于0时,值越小优先级越高。

0

vlanId

int32

[1-4094]

-

所属VLAN ID。

10

vlanDesc

string

0~80个字符。

-

VLAN描述。

"work"

tags

ARRAY_REFERENCE

0-10个列表项,详细请参见表4

设备标签列表,总数不能超过10个。如果指定标签列表,SSID会下发给带有列表中标签的设备。如果不指定,会下发给站点模板绑定的站点内所有设备。

-

表7 BlackAndWhite对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

bindingType

int32

0~2个字符。

-

0--不绑定,1--黑名单设置,2--白名单设置

2

terminalMacList

array<string>

0-2048 个列表项。每个列表项0~20个字符。

-

AP终端MAC列表,多条数据之间使用逗号分隔。不支持广播、组播、全零MAC或广播、组播OUI。中心AP支持2048条。云AP最大支持256条,超过256条会下发失败。重复项无效,提交时将忽略重复项。

["XX:XX:XX:XX:XX:XX"]

terminalOUIList

array<string>

0-2048 个列表项。每个列表项0~20个字符。

-

AP终端OUI列表,多条数据之间使用逗号分隔。不支持广播、组播、全零MAC或广播、组播OUI。中心AP支持2048条。云AP最大支持256条,超过256条会下发失败。重复项无效,提交时将忽略重复项。

["02:02:01"]

表8 SiteTemplateAuthContentDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

mode

string

  • open

  • owe

  • psk

  • ppsk

  • sae

  • psk-sae

  • dot1x

  • mac

  • pskportal

  • pskmacauth

  • dpskmacauth

  • rpskmacauth

-

关联SSID时的认证模式,当mode为mac或dot1x时radius必填。当mode为open或pskportal时,portal认证内容必填。当mode为owe时,oweTransitionMode必填。"open",对应WLAN安全策略为:开放网络(Open),开放网络(Portal认证);"pskportal" 对应WLAN安全策略为:半开放网络(PSK+Portal认证)"owe" 对应WLAN安全策略为:开放网络(OWE);开放网络(OWE+Portal认证)"psk", 对应WLAN安全策略为:半开放网络(PSK认证)"PPSK", 对应WLAN安全策略为:半开放网络(PPSK认证)"SAE", 对应WLAN安全策略为:半开放网络(SAE认证)"PSK-SAE", 对应WLAN安全策略为:半开放网络(PSK-SAE认证)"mac", 对应WLAN安全策略为:半开放网络(MAC认证)"pskmacauth", 对应WLAN安全策略为:半开放网络(PSK+MAC认证)"rpskmacauth",对应WLAN安全策略为:半开放网络(RPSK+MAC认证)"dpskmacauth",对应WLAN安全策略为:半开放网络(DPSK+MAC认证)"dot1x",对应WLAN安全策略为:安全网络(802.1X认证)。

"ppsk"

oweTransitionMode

boolean

  • true

  • false

-

owe过渡认证模式是否使能,当mode为owe时必填。

true

transitionOpenSsid

string

-

-

过渡认证模式下的Open网络SSID的ID。当oweTransitionMode为true时,该字段必填。

"de5813f8ff1e41f5ba9c324da70b49ed"

pskEncryptType

string

  • wep

  • wpa1AndWpa2

  • wpa2

  • wpa

-

psk认证方式下的加密模式,当mode为psk或ppsk或pskportal或pskmacauth或rpskmacauth时必选。大小写敏感,前后不能有空格,且不能含有全角字符。当mode为ppsk时加密方式不支持wep。当mode为rpskmacauth时仅支持wpa2。

"wpa2"

wepType

string

  • WEP40

  • WEP104

  • WEP128

-

wep加密方式密钥类型,当认证模式为psk并且加密模式为wep时需填。

"WEP40"

wepDefaultKey

integer

  • 0

  • 1

  • 2

  • 3

-

加密方式为WEP时的default-key,有效取值为0~3,传入null时,内部自动生成

0

enableMacAuth

boolean

  • true

  • false

false

当认证模式为psk时需填。当值为true时,radius必填并且escapeStrategy必填。

false

securityKey

password

-

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

psk密钥,当mode为psk或pskportal或pskmacauth时必选。查询始终为null。

当pskEncryptType为wep时,5位字符与数字组合的字符串或10位十六进制数。

当pskEncryptType为wpa1AndWpa2或wpa2或wpa时,8-63位字母、数字或特殊字符组合,不能以空格或双引号开始或结尾,不能全是*,空格不能出现在双引号前后。

-

saeEncryptType

string

  • wpa3

-

sae认证方式下的加密模式,当mode为sae时必选。大小写敏感,前后不能有空格,且不能含有全角字符。

-

saeSecurityKey

password

-

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

sae密钥,当mode为sae时必选。查询始终为null。8-63位字母、数字或特殊字符组合,不能以空格或双引号开始或结尾,不能全是*,空格不能出现在双引号前后。

-

pskSaeEncryptType

string

  • wpa2AndWpa3

-

psk-sae认证方式下的加密模式,当mode为psk-sae时必选。大小写敏感,前后不能有空格,且不能含有全角字符。

-

pskSaeSecurityKey

password

-

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

psk-sae密钥,当mode为psk-sae时必选。查询始终为null。8-63位字母、数字或特殊字符组合,不能以空格或双引号开始或结尾,不能全是*,空格不能出现在双引号前后。

-

securityKeyType

string

  • AES

  • AES-TKIP

  • TKIP

  • gcmp256

  • ccmp128

AES

加密算法。

当pskEncryptType为wpa2且认证场景mode为除rpskmacauth的其他枚举时、或者当dot1xEncryptType为wpa2时,securityKeyType必填,且只能从AES、AES-TKIP和TKIP中选择,默认为AES;

当pskEncryptType为wpa2且mode为rpskmacauth时,securityKeyType必填,且只能从AES、TKIP中选择,默认为AES;

当saeEncryptType为wpa3时,securityKeyType必填,只能为AES;

当pskSaeEncryptType或dot1xEncryptType为wpa2AndWpa3时,securityKeyType必填,且只能选择AES;

当dot1xEncryptType为wpa3时,securityKeyType必填,且只能选择gcmp256、ccmp128;

且场景上与dot11r(802.11r快速漫游功能)和overDsPrivate(端管协同功能)有联系,详见对应字段描述。

大小写敏感,前后不能有空格,且不能含有全角字符。

"AES"

dot1xEncryptType

string

  • wpa1AndWpa2

  • wpa2AndWpa3

  • wpa2

  • wpa3

-

dot1x加密模式,当mode为dot1x时必选。大小写敏感,前后不能有空格,且不能含有全角字符。

-

dot1xQuietPeriod

int32

[1-3600]

-

dot1x认证静默时间。

60

dot1xQuietTimes

int32

[1-10]

-

dot1x认证静默失败次数。

10

macAutoBinding

boolean

  • true

  • false

-

是否MAC自动绑定。当mode为ppsk时,此参数必填。若值为true,则开启MAC自动绑定。

true

macAuthMethod

string

  • CHAP

  • PAP

-

MAC认证协议,当mode为mac时生效,默认为PAP,建议选用CHAP。大小写敏感,前后不能有空格,且不能含有全角字符。

-

escapeStrategy

string

-

noNew

逃生策略。取值范围:1.noNew 2.noAuth 3.userDefined

当mode为ppsk和mac时,此参数有效。当mode为ppsk时,仅支持noNew和noAuth;mode为mac时,全部支持。当escapeStrategy为null时,默认传noNew。

noNew:允许已认证用户继续使用网络,新用户不允许接入。默认值。

noAuth:允许已认证用户继续使用网络,新用户需要输入PPSK密钥。注意:此时PPSK用户数控制、MCA自动绑定功失效。

userDefined:允许用户接入,不需要认证,使用自定义逃生模板。

"noAuth"

escapeProfileName

string

-

-

逃生模板名字

"escapeStrategy1"

escapeProfileId

string

-

-

逃生模板ID。当escapeStrategy为userDefined时,此项必填。

"5871926c-2a5e-4340-a931-19ce019a231c"

portal

REFERENCE

详细请参见表9

-

-

radius

REFERENCE

详细请参见表10

-

-

haca

REFERENCE

详细请参见表11

-

-

表9 SiteTemplatePortalContentDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

mode

string

  • portalDisable

  • portalThirdIndirect

  • portalThirdController

  • portalThird

-

认证方式。

portalDisable---不启用Portal认证(当mode为pskportal时不能为portalDisable)。

portalThirdIndirect---云平台中继认证(默认对接方式:API)。

"portalThirdIndirect"

pushProtocol

string

-

-

推送协议,取值范围https/http,大小写不敏感,当云平台中继认证时生效,默认值是安全的https协议。

"https"

freeAuthEnable

boolean

  • true

  • false

-

有效期内免认证是否开启,当mode为portalThirdIndirect时必选。

true

authExpireUnit

string

-

minute

Portal认证有效期单位,ssid创建场景:freeAuthEnable为true时,此字段不传则默认值为minute;ssid更新场景:freeAuthEnable为true时,此字段不传则使用更新前的值。只能为day、hour、minute中的一个,大小写不敏感,前后空格忽略,且不能含有全角字符。默认值为minute。

"day"

authExpire

integer

[1-365]

2

Portal认证有效期,ssid创建场景:freeAuthEnable为true时,此字段不传则默认值为2;ssid更新场景:freeAuthEnable为true时,此字段不传则使用更新前的值。

authExpireUnit为minute时,范围为1~59。

authExpireUnit为hour时,范围为1~23。

authExpireUnit为day时,范围为1~365。

10

escapeStrategy

integer

-

1

逃生策略,当mode为portalThirdIndirect时有效,此字段不传时,默认值是1。

1---允许已认证用户继续使用网络,新用户不允许接入,默认值(noNew)

2---允许用户接入,不需要认证(noAuth)

3---允许用户接入,不需要认证,使用自定义逃生模板。(userDefined)

2

escapeProfileName

string

-

-

逃生模板名字

"escapeStrategy1"

escapeProfileId

string

-

-

逃生模板ID。当escapeStrategy为3时,此项必填。

"5871926c-2a5e-4340-a931-19ce019a231c"

freeAclTmplId

string

0~36个字符。

-

免认证ACL,当mode为portalThirdIndirect时必填。免认证ACL可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c4"

freeAclTmplName

string

1~32个字符。

-

免认证ACL名称,当mode为portalThirdIndirect时有效。POST与PUT操作时,该字段无效。长度为1至32字节。

"free-acl-name"

controllerPortalType

string

  • haca

  • portalTpz

-

Portal协议类型: haca:haca portal2.0:portalTpz。Portal2.0只支持非NAT场景。云平台内置认证方式时需填

"haca"

masterPortalTmplId

string

32~36个字符。

-

主portal服务器ID。认证方式为云平台内置和第三方认证时需填

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

masterPortalTmplName

string

-

-

主portal服务器模板名称。POST与PUT操作时,该字段无效。

-

bakPortalEnable

boolean

  • true

  • false

-

备portal服务器开关。第三方认证方式时使用,非必填。

false

bakPortalTmplId

string

32~36个字符。

-

备portal服务器ID。第三方认证方式时使用,当bakPortalEnable开启时必填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

bakPortalTmplName

string

-

-

备portal服务器模板名称。POST与PUT操作时,该字段无效。

-

authRedirectUrlCarryEnable

boolean

  • true

  • false

-

授权重定向场景携带URL参数。云平台内置认证方式,portal2.0协议类型时需填。

false

radiusEnable

boolean

  • true

  • false

-

radius开关

false

radiusTmplId

string

32~36个字符。

-

radius模板ID。认证方式为云平台内置和第三方认证时需填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

radiusTmplName

string

-

-

radius模板名称。POST与PUT操作时,该字段无效。

-

fastPushEnable

boolean

  • true

  • false

-

推送方式:值为true时为快速推送,false为高级推送。使用快速推送时,只能选择一种推送方式,微信链接、用户名密码、短信认证、Passcode认证、一键认证、社交媒体、匿名认证只能有一个值为true,并且portalPageId必填。使用高级推送时请在准入 > 准入资源 > 页面管理 > Portal页面推送策略中配置启用的登录类型页面。云平台内置认证方式时需填。

true

portalPageId

string

32~36个字符。

-

推送页面ID。根据准入 > 准入资源 > 页面管理 > 页面定制获取ID。云平台内置认证方式且使用了快速推送方式时需填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

wechatUrlAuthEnable

boolean

  • true

  • false

-

推送方式:默认微信链接认证定制页面。云平台内置认证方式时选填。

false

weComAuthEnable

boolean

  • true

  • false

false

推送方式:默认企业微信认证定制页面。云平台内置认证方式时选填。默认值为false。

false

dingTalkEnable

boolean

  • true

  • false

false

推送方式:默认钉钉认证定制页面。云平台内置认证方式时选填。默认值为false。

false

normalEnable

boolean

  • true

  • false

-

推送方式:默认用户名认证定制页面。云平台内置认证方式时选填。当值为true时,registerEnable必填。

false

registerEnable

boolean

  • true

  • false

-

用户自注册使能。推送页面为默认用户名认证定制页面时需填,当值为true时,需要填用户有效期,用户所属组,最大接入终端数选填。

false

registerExpire

int32

[1-365]

-

用户有效期。推送页面为默认用户名认证并且开启了用户自注册时必填。

registerExpireUnit为minute时,范围为1~59。

registerExpireUnit为hour时,范围为1~23。

registerExpireUnit为day时,范围为1~365。

2

registerExpireUnit

string

  • day

  • hour

  • minute

-

用户有效期单位。推送页面为默认用户名认证并且开启了用户自注册时必填。

"hour"

userRegisterMaxAccessNumber

int32

[0-16]

-

用户注册最大接入数:0代表不限制,1-16为具体限制数。推送页面为默认用户名认证定制页面时并且开启了用户自注册时选填。

0

userGroupId

string

32~36个字符。

-

用户名密码认证用户组id:根据准入用户组来获取ID值。推送页面为默认用户名认证定制页面时,并且开启了用户自注册时必填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

smsAuthEnable

boolean

  • true

  • false

-

推送方式:默认短信认证定制页面。云平台内置认证方式时选填。用户输入手机号码,通过获取短信验证码后,可以正常上网,相关参数在系统 > 系统设置 > 第三方服务 > 第三方服务 > 短信服务器中配置。

false

smsPasswordExpire

int32

[1-365]

-

短信验证密码有效期。推送页面为短信认证定制页面时必填。

registerExpireUnit为minute时,范围为1~59。

registerExpireUnit为hour时,范围为1~23。

registerExpireUnit为day时,范围为1~365。

5

smsPasswordExpireUnit

string

  • day

  • hour

  • minute

-

短信验证密码有效期单位。推送页面为短信认证定制页面时必填。

"minute"

smsUserRegisterEnable

boolean

  • true

  • false

-

用户自注册使能。推送页面为短信认证定制页面时需填,当值为true时,需要填用户有效期,用户所属组,最大接入终端数选填。

false

smsUserExpire

int32

[1-365]

-

用户有效期。推送页面为短信认证定制页面并且开启了用户自注册时必填。

registerExpireUnit为minute时,范围为1~59。

registerExpireUnit为hour时,范围为1~23。

registerExpireUnit为day时,范围为1~365。

2

smsUserExpireUnit

string

  • day

  • hour

  • minute

-

用户有效期单位。推送页面为短信认证定制页面并且开启了用户自注册时必填。

"hour"

smsUserMaxAccessNumber

int32

[0-16]

-

用户注册最大接入数:0代表不限制,1-16为具体限制数。推送页面为短信认证定制页面时并且开启了用户自注册时选填。

0

smsUserGroupId

string

32~36个字符。

-

短信认证用户组id:根据准入用户组来获取ID值。推送页面为短信认证定制页面时,并且开启了用户自注册时必填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

emailAuthEnable

boolean

  • true

  • false

-

推送方式:邮箱认证定制页面。云平台内置认证方式时选填。用户使用邮箱进行认证后,可以正常上网,相关参数属于全局配置,在admin > 系统 > 系统管理 > 第三方服务 > 邮箱服务器参数中配置。

false

passCodeEnable

boolean

  • true

  • false

-

推送方式:默认passcode认证定制页面。云平台内置认证方式时选填。

false

oneKeyAuthEnable

boolean

  • true

  • false

-

推送方式:默认一键认证定制页面。云平台内置认证方式时选填。用户只需要输入用户名和验证码,并点击“登录”按钮就可以正常上网。

false

anonymousEnable

boolean

  • true

  • false

-

推送方式:默认匿名认证定制页面。云平台内置认证方式时选填。 用户不用输入信息,只需要点击页面上的“登录”按钮就可以正常上网。相关参数在准入 > 准入策略 > 准入设置 > 高级参数中配置。

false

socialMediaEnable

boolean

  • true

  • false

-

推送方式:默认社交媒体认证定制页面。云平台内置认证方式时选填。当值为true时,需要配置Facebook、Twitter、新浪微博、QQ认证中的一种或多种,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

twitterEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之Twitter认证。云平台内置认证方式时选填。用户使用Twitter进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

sinaEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之新浪微博认证。云平台内置认证方式时选填。用户使用新浪微博进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

qqEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之QQ认证。云平台内置认证方式时选填。用户使用QQ进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

qrCodeAuthEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之公共二维码认证。云平台内置认证方式时选填。用户使用公共二维码进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

qrCodeRegisterEnable

boolean

  • true

  • false

false

默认社交媒体认证定制页面之二维码审批认证。云平台内置认证方式时选填。用户使用二维码审批进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

googleEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之Google认证。云平台内置认证方式时选填。用户使用Google认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

accountingEnable

boolean

  • true

  • false

-

实时计费开关。云平台内置认证方式时选填。

false

accountingExpire

int32

[5-65535]

-

计费上报周期时长(单位分钟)。实时计费开关开启时必填。云平台内置认证方式使用。

15

interconnectionMode

string

  • API

  • radiusRelay

API

云平台中继认证对接方式。API:API对接方式;radiusRelay:Radius中继认证方式。开启云平台中继认证方式时需填。默认值为API。

"API"

userNameKey

string

1~64个字符。

-

第三方portal页面认证“用户名”参数名称,由字母名称横杠和下划线的组合。开启云平台中继认证方式并使用Radius中继对接方式时需填。

"用户"

passwordKey

string

-

-

第三方portal页面认证“密码”参数名称,由字母名称横杠和下划线的组合。开启云平台中继认证方式并使用Radius中继对接方式时需填。

-

urlMatchMode

int32

[0-1]

-

跳转URL匹配规则:0--重定向URL参数 1--重定向URL地址,为null时默认为0。提供两种方式进行第三方portal页面跳转URL:

重定向URL参数:根据请求中携带的URL地址的参数名和参数值进行重定向URL地址的获取,当参数名匹配上输入框中的参数名,获取对应的参数值作为重定向URL地址进行跳转。

重定向URL地址:根据需要跳转的URL地址直接获取输入框中的重定向URL地址进行跳转。

云平台内置认证方式使用。

0

successUrlKey

string

0~256个字符。

-

第三方portal页面认证“认证成功跳转URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

authFailedUrlKey

string

0~256个字符。

-

第三方portal页面认证“认证失败跳转URL”参数名称,由字母名称横杠和下划线的组合。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

logoutSuccessUrlKey

string

0~256个字符。

-

第三方portal页面认证“注销成功跳转URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

logoutFailedUrlKey

string

0~256个字符。

-

第三方portal页面认证“注销失败跳转URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

logoutUrlKey

string

0~256个字符。

-

第三方portal页面认证“注销页面URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。。开启云平台中继认证方式并使用Radius中继对接方式时选填。

-

radiusModelId

string

32~36个字符。

-

radius中继服务器模板ID。开启云平台中继认证方式并使用Radius中继对接方式时需填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

表10 SiteTemplateRadiusContentDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

radiusTmplId

string

0~36个字符。

-

RADIUS模板ID。

"b90f8190-e12f-4323-95f3-4018309209c4"

radiusTmplName

string

0~32个字符。

-

RADIUS模板名称。POST与PUT操作时,该字段无效。

"test"

staticEnable

boolean

  • true

  • false

-

用户流量统计使能开关。

false

iconnectAccessEnable

boolean

  • true

  • false

false

iConnect终端接入开关,默认值为false。

-

autoReauthenTime

integer

[0-7200]

0

自动重认证时间,单位为秒,取值范围:0 或 30-7200

0---自动重认证功能关闭,默认值

30-7200---自动重认证功能打开时的自动重认证时间

-

hacaEnable

boolean

  • true

  • false

-

radius内置场景是否支持NAT场景Coa/DM。

false

表11 SiteTemplateHacaContentDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

authComponentId

string

0~36个字符。

-

主认证组件ID(内置认证服务为00000000-0000-0000-0000-000000000000,拉远场景为拉远组件ID)

"00000000-0000-0000-0000-000000000000"

authComponentIp

string

7~15个字符。

-

主认证组件IP(内置认证服务时可以不填,拉远场景为拉远组件IP)

"10.20.0.0"

bakAuthComponentId

string

0~36个字符。

-

备认证组件ID(内置认证服务为00000000-0000-0000-0000-000000000000,拉远场景为拉远组件ID)

"00000000-0000-0000-0000-000000000000"

bakAuthComponentIp

string

7~15个字符。

-

备认证组件IP(内置认证服务时可以不填,拉远场景为拉远组件IP)

"10.20.0.0"

表12 SiteTemplateVapBackupConfig对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

vapBackupEnable

boolean

  • true

  • false

false

开启802.1x备份认证,默认false,关闭。

false

radiusBackupTmplId

string

0~36个字符。

-

监控radius模板Id,当vapBackupEnable为true时必填。UUID格式。

"cf23f275-01e6-4301-890e-407e1d78c53e"

rejectNewAccess

boolean

  • true

  • false

-

仅限在监控radius认证过的终端接入,非必填,默认false。

false

表13 SiteTemplatePolicyContentDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

securityPolicy

REFERENCE

详细请参见表14

-

-

ssidRateLimit

REFERENCE

详细请参见表20

-

-

terminalRateLimit

REFERENCE

详细请参见表21

-

-

terminalDynamicRateLimit

REFERENCE

详细请参见表23

-

-

ipv6Enable

boolean

  • true

  • false

false

是否支持IPV6。

false

ndTrustPort

boolean

  • true

  • false

false

启用或禁用nd信任接口。

false

表14 SiteTemplateSecurityPolicyConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

highReliableSliceAclTplId

string

0~36个字符。

-

高可靠切片acl模板id。ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式

"b90f8190-e12f-4323-95f3-4018309209c4"

highReliableSliceAclTplName

string

0~32个字符。

-

高可靠切片ACL模板名称。POST与PUT操作时,该字段无效。

"test-slice-acl"

highReliableSliceAclTplIdIpv6

string

0~36个字符。

-

高可靠切片IPV6 acl模板id。仅ipv6Enable为true且全局ipv6开启时有效。ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式

"b90f8190-e12f-4323-95f3-4018309209c4"

highReliableSliceAclTplNameIpv6

string

0~32个字符。

-

高可靠切片IPV6 ACL模板名称。POST与PUT操作时,该字段无效。

"test-slice-acl"

securityAclTmplId

string

0~36个字符。

-

安全ACL模板ID。安全ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c4"

securityAclTmplName

string

0~32个字符。

-

ACL模板名称。POST与PUT操作时,该字段无效。长度为1至32字节。

"test-security-acl"

securityIPv6AclTmplId

string

0~36个字符。

-

安全IPv6ACL模板ID。仅ipv6Enable为true且全局ipv6开启时有效。安全IPv6ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c4"

securityIPv6AclTmplName

string

0~32个字符。

-

IPv6ACL模板名称。POST与PUT操作时,该字段无效。

"test-security-acl"

ipsecAclTmplId

string

0~36个字符。

-

IPSEC ACL模板ID。IPSEC ACL模板可以通过第三方开放接口https://host:port/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c5"

ipsecAclTmplName

string

0~32个字符。

-

IPSEC ACL模板名称。POST与PUT操作时,该字段无效。长度为1至32字节。

"test-ipsec-acl"

tcpAdjustMss

int32

[128-2048]

-

最大报文长度

1380

appTrafficAcls

REFERENCE

详细请参见表15

应用流量优先级列表,单方向最多只能添加8条。

-

tunnelAclTmplId

string

0~36个字符。

-

隧道转发ACL模板ID。Tunnel ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c5"

tunnelAclTmplName

string

0~32个字符。

-

隧道转发ACL模板名称。POST与PUT操作时,该字段无效。

"test-tunnel-acl"

urlFilter

REFERENCE

详细请参见表19

-

-

appsPolicys

REFERENCE

详细请参见表17

应用过滤列表,最多只能添加32条。如果策略选择了permit并且同时配置了DSCP和CAR,则认为是两条策略。

-

表15 appTrafficAcls对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

appTrafficAclList

ARRAY_REFERENCE

0-16个列表项,详细请参见表16

-

-

表16 SiteTemplateAppTrafficAclDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

direction

string

  • inbound

  • outbound

-

应用流量优先级方向。

"inbound"

index

int32

[0-7]

-

优先级。

0

dscp

int32

[0-63]

-

DSCP优先级值,值越大优先级越高。action为deny时,忽略dscp。action为permit时,dscp不允许为空。应用和应用所属的分类存在互斥关系,分类如果是禁止,那么分类下的具体应用不能是禁止;分类如果是允许,分类下的具体应用如果也是允许,那么分类配置了DSCP,具体应用不能配置DSCP。取值范围:0、8、10、12、14、16、18、20、22、24、26、28、30、32、34、36、38、40、44、46、48、56

1

appTrafficAclTplId

string

0~36个字符。

-

应用流量优先级ACL模板ID。应用流量优先级ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c5"

appTrafficAclName

string

0~32个字符。

-

应用流量优先级ACL模板名称。POST与PUT操作时,该字段无效。

"test-tunnel-acl"

表17 appsPolicys对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

siteSaList

ARRAY_REFERENCE

0-32个列表项,详细请参见表18

-

-

表18 SiteTemplateSecurityAppsPolicyDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

appId

int32

[0-10000]

-

应用id。

1

type

string

  • app

  • class

-

标示具体应用还是应用分类。app表示单个应用,class表示应用分类。

"app"

appType

int32

[0-1]

-

区分是预定义还是自定义。预定义为0,自定义是1,默认是预定义。

1

appName

string

0~128个字符。

-

应用名称。

"test_name"

action

string

  • permit

  • deny

-

策略是允许还是拒绝。

"permit"

dscp

int32

[0-63]

-

DSCP优先级值,值越大优先级越高。action为deny时,忽略dscp。action为permit时,dscp不允许为空。应用和应用所属的分类存在互斥关系,分类如果是禁止,那么分类下的具体应用不能是禁止;分类如果是允许,分类下的具体应用如果也是允许,那么分类配置了DSCP,具体应用不能配置DSCP。

1

car

int32

[64-10000000]

-

指定的报文速率, kbps。action为deny时,忽略car。action为permit时,car不允许为空。应用和应用所属的分类存在互斥关系,分类如果是禁止,那么分类下的具体应用不能是禁止;分类如果是允许,分类下的具体应用如果也是允许,分类配置了CAR,具体应用不能配置CAR。

1000

表19 SiteTemplateSecurityUrlFilterDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

false

是否使能URL过滤。创建SSID时,若未填写此字段,默认值为false。该黑白名单机制对使用代理服务器的浏览器不生效。

true

mode

integer

  • 0

  • 1

-

URL过滤类型,当enable为true时mode字段必填且有效。

0---黑名单

1---白名单

1

urls

array<string>

0-128 个列表项。每个列表项4~80个字符。

-

URL列表。URL长度4-80个字符。当enable为true时有效。mode为0时,urls表示允许访问未匹配的url;mode为1时,urls表示禁止访问未匹配的url。每个URL限制要求:'*'只能出现在首尾,'*'不算做有效字符,前后空格忽略,前缀'http://'忽略,且不能含有全角字符,不能以“?”结尾。

-

hostNames

array<string>

0-128 个列表项。每个列表项4~255个字符。

-

域名列表,以换行符分割。域名长度4-255个字符。当enable为true时有效。mode为0时,域名表示允许访问未匹配的域名;mode为1时,域名表示禁止访问未匹配的域名。每个URL限制要求:'*'表示模糊匹配,前后空格忽略,不能含有全角字符,且不包含'/'、'\'、'#'、'"'、'?'及空格。

-

表20 SiteTemplateRateLimitContentDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

upEnable

boolean

  • true

  • false

false

上行限速使能。

true

upLimit

string

0~7个字符。

-

上行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当upEnable为true时生效

"50.0"

downEnable

boolean

  • true

  • false

false

下行限速使能。

true

downLimit

string

0~7个字符。

-

下行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当downEnable为true时生效

"50.0"

表21 SiteTemplateTerminalRateLimitContentDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

upEnable

boolean

  • true

  • false

false

上行限速使能。

true

upLimit

string

0~7个字符。

-

上行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当upEnable为true时生效

"50.0"

downEnable

boolean

  • true

  • false

false

下行限速使能。

true

downLimit

string

0~7个字符。

-

下行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当downEnable为true时生效

"50.0"

timeRange

ARRAY_REFERENCE

0-8个列表项,详细请参见表22

指定时段限速。基于指定时间段的限速策略优先级高于默认策略。如果同一时间有多条基于指定时间段的策略生效,以最小的限速值生效,结构体参见TimeRange。

-

表22 TimeRange对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

timeTemplateId

string

0~36个字符。

-

时间模板id,UUID格式

"b90f8190-e12f-4323-95f3-4018309209c4"

upEnable

boolean

  • true

  • false

-

上行限速使能。

true

upLimit

string

0~7个字符。

-

上行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当upEnable为true时生效

"50.0"

downEnable

boolean

  • true

  • false

-

下行限速使能。

true

downLimit

string

0~7个字符。

-

下行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当downEnable为true时生效

"50.0"

表23 TerminalDynamicRateLimitDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

dynamicEnable

boolean

  • true

  • false

false

终端流量动态流量限速功能开关,默认关闭(false)。如果动态流量限速功能开启,dynamicLimit值为必填。

false

dynamicLimit

int32

[0-32]

-

终端流量动态流量限速功能,流量值可以为8,16,32 (Mbit/s)

16

表24 EdcaClientDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

accessCategory

string

  • acvo

  • acvi

  • acbe

  • acbk

-

报文的4个接入类别。可取值为:acvo、acvi、acbe、acbk。WMM协议将数据报文分为4个接入类别AC(Access Category),分别为AC_VO(Voice)、AC_VI(Video)、AC_BE(Best Effort)、AC_BK(Background)。当accessCategory为acvo时,表示接入类别为语音流;当accessCategory为acvi时,表示接入类别为视频流;当accessCategory为acbe时,表示接入类别为尽力而为流;当accessCategory为acbk时,表示接入类别为背景流。

"acvo"

aifsn

integer

[2-15]

-

指定仲裁帧间隙数,决定了用户的空闲等待时间长短。aifsn数值越大,用户的空闲等待时间越长,优先级越低。范围为2-15。

10

ecwmax

integer

[0-15]

-

指定最大竞争窗口指数,此参数与ecwmin一起决定了用户的平均退避时间。这两个数值越大,用户的平均退避时间越长,优先级越低。取值范围:0~15,且须大于或等于ecwmin。

10

ecwmin

integer

[0-15]

-

指定最小竞争窗口指数,此参数与ecwmax一起决定了用户的平均退避时间。这两个数值越大,用户的平均退避时间越长,优先级越低。取值范围:0~15,且须小于或等于ecwmax。

10

txoplimit

integer

[0-255]

-

用户一次竞争信道成功后,可占用信道的最大时间,这个数值越大,用户一次能占用的信道时长越大。如果是0,则每次占用信道后,只能发送一个报文。取值范围:0~255。

10

表25 Option82Dto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

circuitId

REFERENCE

详细请参见表26

链路代理ID,结构体参见OptionParamDto。

-

remoteId

REFERENCE

详细请参见表26

远程代理ID,结构体参见OptionParamDto。

-

表26 OptionParamDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

connectorPattern

string

  • colon

  • semicolon

colon

选项不同类型内容间的连接符。可取值为:colon、semicolon。默认值为colon。

"colon"

contentType

string

  • ap-mac

  • ap-mac-ssid

  • ap-location

  • ap-location-ssid

  • ap-name

  • ap-name-ssid

  • user-defined

ap-mac

选项内容类型。可取值为:ap-mac、ap-mac-ssid、ap-location、ap-location-ssid、ap-name、ap-name-ssid、user-defined。默认值为ap-mac。

"ap-mac"

format

string

  • ascii

  • normal

  • compact

  • hex

  • colon

ascii

选项内容格式。可取值为:ascii、normal、compact、hex、colon。当contentType为ap-mac时,所有选项均可选择;当contentType为ap-mac-ssid时,hex不可选择。默认值为ascii。

"ascii"

userDefinedText

string

-

-

自定义内容,当contentType为user-defined时,此字段为必填字段。

"xxx"

请求示例

HTTP的示例
POST /controller/campus/v3/networkconfig/site-templates/fbde1c5d-5b94-49e3-a912-48641015e45c/apssid HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
	"name" : "Huawei-Guest",
	"pki" : "default",
	"tags" : [
		{
			"name" : "testApTag"
		}
	],
	"enable" : true,
	"timeTemplateId" : "2c3918cb-f0bd-44e3-963b-119870bfc779",
	"connectionMode" : "nat",
	"vlans" : [
		{
			"vlanId" : 10,
			"vlanDesc" : "work"
		}
	],
	"customVlans" : [
		{
			"priority" : 0,
			"vlanId" : 10,
			"vlanDesc" : "work",
			"tags" : [
				{
					"name" : "testApTag"
				}
			]
		}
	],
	"vlanMode" : "vlanId",
	"vlanPoolId" : "1e930b21-a307-45a9-96a2-f1443ca84f39",
	"vlanPoolName" : "vlanPool",
	"hidedEnable" : false,
	"autoOffTrackLinkEnable" : false,
	"arpCheckEnable" : true,
	"ipCheckEnable" : true,
	"dhcpStrictEnable" : false,
	"dhcpv6SlaacStrictEnable" : 0,
	"mdnsSnoopingEnable" : false,
	"dnsSnoopingEnable" : false,
	"gameSpeedUpEnable" : false,
	"relativeRadios" : 3,
	"relativeOnlyTwoRadios" : 3,
	"dtimInterval" : 1,
	"advertiseApNameSwitch" : true,
	"frequencyNavigation" : true,
	"maxUserNumber" : 64,
	"blackAndWhite" : {
		"bindingType" : 2,
		"terminalMacList" : [
			 "XX:XX:XX:XX:XX:XX"
		],
		"terminalOUIList" : [
			 "02:02:01"
		]
	},
	"userSeparation" : false,
	"separationOption" : "disable",
	"userL2LanIsolate" : false,
	"staNetworkDetect" : true,
	"muMiMo" : true,
	"associationTimeout" : 5,
	"erSuSwitch" : true,
	"userFlowSyslogEnable" : false,
	"multiLinkOper" : false,
	"lay3RoamSwitch" : true,
	"suExtendedRangeSwitch" : false,
	"muRtsSwitch" : false,
	"muRtsThreshold" : 2347,
	"forbiddenOldTerminal" : false,
	"reachMaxSta" : 1,
	"igmpSnooping" : false,
	"multicast2Unicast" : "disable",
	"bcmcDenyAll" : false,
	"bonjourTransparent" : false,
	"powerSave" : false,
	"beacon2gRate" : "1Mbps",
	"beacon5gRate" : "6Mbps",
	"beacon6gRate" : "6Mbps",
	"sipPort" : 5060,
	"timeTemplateName" : "全天",
	"seaSwitch" : false,
	"overDsPrivate" : "disable",
	"ssidAuth" : {
		"mode" : "ppsk",
		"oweTransitionMode" : true,
		"transitionOpenSsid" : "de5813f8ff1e41f5ba9c324da70b49ed",
		"pskEncryptType" : "wpa2",
		"wepType" : "WEP40",
		"wepDefaultKey" : 0,
		"enableMacAuth" : false,
		"securityKey" : "",
		"saeEncryptType" : "",
		"saeSecurityKey" : "",
		"pskSaeEncryptType" : "",
		"pskSaeSecurityKey" : "",
		"securityKeyType" : "AES",
		"dot1xEncryptType" : "",
		"dot1xQuietPeriod" : 60,
		"dot1xQuietTimes" : 10,
		"macAutoBinding" : true,
		"macAuthMethod" : "",
		"escapeStrategy" : "noAuth",
		"escapeProfileName" : "escapeStrategy1",
		"escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c",
		"portal" : {
			"mode" : "portalThirdIndirect",
			"pushProtocol" : "https",
			"freeAuthEnable" : true,
			"authExpireUnit" : "day",
			"authExpire" : 10,
			"escapeStrategy" : 2,
			"escapeProfileName" : "escapeStrategy1",
			"escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c",
			"freeAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
			"freeAclTmplName" : "free-acl-name",
			"controllerPortalType" : "haca",
			"masterPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
			"masterPortalTmplName" : "",
			"bakPortalEnable" : false,
			"bakPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
			"bakPortalTmplName" : "",
			"authRedirectUrlCarryEnable" : false,
			"radiusEnable" : false,
			"radiusTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
			"radiusTmplName" : "",
			"fastPushEnable" : true,
			"portalPageId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
			"wechatUrlAuthEnable" : false,
			"weComAuthEnable" : false,
			"dingTalkEnable" : false,
			"normalEnable" : false,
			"registerEnable" : false,
			"registerExpire" : 2,
			"registerExpireUnit" : "hour",
			"userRegisterMaxAccessNumber" : 0,
			"userGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
			"smsAuthEnable" : false,
			"smsPasswordExpire" : 5,
			"smsPasswordExpireUnit" : "minute",
			"smsUserRegisterEnable" : false,
			"smsUserExpire" : 2,
			"smsUserExpireUnit" : "hour",
			"smsUserMaxAccessNumber" : 0,
			"smsUserGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
			"emailAuthEnable" : false,
			"passCodeEnable" : false,
			"oneKeyAuthEnable" : false,
			"anonymousEnable" : false,
			"socialMediaEnable" : false,
			"twitterEnable" : false,
			"sinaEnable" : false,
			"qqEnable" : false,
			"qrCodeAuthEnable" : false,
			"qrCodeRegisterEnable" : false,
			"googleEnable" : false,
			"accountingEnable" : false,
			"accountingExpire" : 15,
			"interconnectionMode" : "API",
			"userNameKey" : "用户",
			"passwordKey" : "",
			"urlMatchMode" : 0,
			"successUrlKey" : "",
			"authFailedUrlKey" : "",
			"logoutSuccessUrlKey" : "",
			"logoutFailedUrlKey" : "",
			"logoutUrlKey" : "",
			"radiusModelId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc"
		},
		"radius" : {
			"radiusTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
			"radiusTmplName" : "test",
			"staticEnable" : false,
			"iconnectAccessEnable" : "",
			"autoReauthenTime" : "",
			"hacaEnable" : false
		},
		"haca" : {
			"authComponentId" : "00000000-0000-0000-0000-000000000000",
			"authComponentIp" : "10.20.0.0",
			"bakAuthComponentId" : "00000000-0000-0000-0000-000000000000",
			"bakAuthComponentIp" : "10.20.0.0"
		}
	},
	"vapBackupConfig" : {
		"vapBackupEnable" : false,
		"radiusBackupTmplId" : "cf23f275-01e6-4301-890e-407e1d78c53e",
		"rejectNewAccess" : false
	},
	"ssidPolicy" : {
		"securityPolicy" : {
			"highReliableSliceAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
			"highReliableSliceAclTplName" : "test-slice-acl",
			"highReliableSliceAclTplIdIpv6" : "b90f8190-e12f-4323-95f3-4018309209c4",
			"highReliableSliceAclTplNameIpv6" : "test-slice-acl",
			"securityAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
			"securityAclTmplName" : "test-security-acl",
			"securityIPv6AclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
			"securityIPv6AclTmplName" : "test-security-acl",
			"ipsecAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5",
			"ipsecAclTmplName" : "test-ipsec-acl",
			"tcpAdjustMss" : 1380,
			"appTrafficAcls" : {
				"appTrafficAclList" : [
					{
						"direction" : "inbound",
						"index" : 0,
						"dscp" : 1,
						"appTrafficAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c5",
						"appTrafficAclName" : "test-tunnel-acl"
					}
				]
			},
			"tunnelAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5",
			"tunnelAclTmplName" : "test-tunnel-acl",
			"urlFilter" : {
				"enable" : true,
				"mode" : 1,
				"urls" : [
					 ""
				],
				"hostNames" : [
					 ""
				]
			},
			"appsPolicys" : {
				"siteSaList" : [
					{
						"appId" : 1,
						"type" : "app",
						"appType" : 1,
						"appName" : "test_name",
						"action" : "permit",
						"dscp" : 1,
						"car" : 1000
					}
				]
			}
		},
		"ssidRateLimit" : {
			"upEnable" : true,
			"upLimit" : "50.0",
			"downEnable" : true,
			"downLimit" : "50.0"
		},
		"terminalRateLimit" : {
			"upEnable" : true,
			"upLimit" : "50.0",
			"downEnable" : true,
			"downLimit" : "50.0",
			"timeRange" : [
				{
					"timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4",
					"upEnable" : true,
					"upLimit" : "50.0",
					"downEnable" : true,
					"downLimit" : "50.0"
				}
			]
		},
		"terminalDynamicRateLimit" : {
			"dynamicEnable" : false,
			"dynamicLimit" : 16
		},
		"ipv6Enable" : false,
		"ndTrustPort" : false
	},
	"dot11r" : false,
	"overDs" : false,
	"reassociateTimeout" : 1,
	"serviceGuarantee" : "performanceFirst",
	"activeDullClient" : false,
	"wmmScene" : "default",
	"edcaClientConfigList" : [
		{
			"accessCategory" : "acvo",
			"aifsn" : 10,
			"ecwmax" : 10,
			"ecwmin" : 10,
			"txoplimit" : 10
		}
	],
	"insertOption82Enable" : false,
	"option82" : {
		"circuitId" : {
			"connectorPattern" : "colon",
			"contentType" : "ap-mac",
			"format" : "ascii",
			"userDefinedText" : "xxx"
		},
		"remoteId" : {
			"connectorPattern" : "colon",
			"contentType" : "ap-mac",
			"format" : "ascii",
			"userDefinedText" : "xxx"
		}
	},
	"forwardMode" : "direct",
	"softgreProfileId" : "fbde1c5d-5b94-49e3-a912-48641015e45f",
	"configName" : "ssid-tmp-config-name",
	"phyProtection" : "security-priority"
}

响应参数

返回状态码为201:新增的站点模板内SSID配置信息,返回结构体参见SiteTemplateConfigSsidResponse。

表27 SiteTemplateConfigSsidResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

-

-

错误码。

"0"

errmsg

string

-

-

错误信息。

""

data

REFERENCE

详细请参见表28

SSID配置信息,结构体参见SiteTemplateSsidConfigOut。

-

表28 SiteTemplateSsidConfigOut对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

id

string

-

-

SSID唯一标识。

"de5813f8ff1e41f5ba9c324da70b49ed"

name

string

1~32个字符。

-

SSID名称。长度为1~32字节(UTF-8编码),不能包含特殊符号&、=、?、#、%、+。当以空格开头或结尾时,最大长度减少2字节;当以"开头时,最大长度减少1字节。

"Huawei-Guest"

pki

string

0~50个字符。

-

pki参数证书域。

"default"

tags

ARRAY_REFERENCE

0-10个列表项,详细请参见表29

设备标签列表,总数不能超过10个。如果指定标签列表,SSID会下发给带有列表中标签的设备。如果不指定,会下发给站点模板绑定的站点内所有设备。

-

enable

boolean

  • true

  • false

true

工作状态开启。

true

timeTemplateId

string

-

-

时间模板ID。时间模板可以通过第三方开放接口https://host:port/controller/campus/v3/networkconfig/timetemplate得到。

"2c3918cb-f0bd-44e3-963b-119870bfc779"

connectionMode

string

  • bridge

  • nat

-

网络连接方式,大小写敏感,前后不能有空格,且不能含有全角字符。当配置为nat时,全局DHCP分配地址开关打开,bridge则为关闭。

"nat"

vlans

ARRAY_REFERENCE

0-1个列表项,详细请参见表30

SSID所属的VLAN配置信息。站点模板与站点配置的AP SSID不同,此处站点模板的同一SSID所属VLAN不支持按照标签进行差异化配置,最大仅可以配置一个SiteTemplateVlanDto对象,考虑后续扩展,采用数组方式,结构体参见SiteTemplateVlanDto。

-

customVlans

ARRAY_REFERENCE

0-251个列表项,详细请参见表31

按照标签进行差异化配置。

-

vlanMode

string

6~8个字符。满足正则表达vlanId|vlanPool。

-

VLAN模式。

"vlanId"

vlanPoolId

string

36个字符。

-

VLAN pool id。

"1e930b21-a307-45a9-96a2-f1443ca84f39"

vlanPoolName

string

1~32个字符。

-

VLAN pool 名称。

"vlanPool"

hidedEnable

boolean

  • true

  • false

false

是否隐藏SSID。

false

autoOffTrackLinkEnable

boolean

  • true

  • false

fasle

断链关断开关。默认值为false。

false

arpCheckEnable

boolean

  • true

  • false

true

arp检测功能使能开关。默认值为true。

true

ipCheckEnable

boolean

  • true

  • false

true

IPSG功能使能开关。默认值为true。

true

dhcpStrictEnable

boolean

  • true

  • false

false

终端地址严格DHCP获取,依赖ipCheckEnable开启。默认值为false。

false

dhcpv6SlaacStrictEnable

int32

[0-2]

0

ipv6终端地址严格DHCP获取(0:disable 1:dhcpv6-strict 2:dhcpv6-slaac),依赖ipCheckEnable开启,默认值为0,仅部分款型设备某些版本支持,具体款型和版本信息可查看产品资料。

0

mdnsSnoopingEnable

boolean

  • true

  • false

fasle

mdns snooping开关。默认值为false。

false

dnsSnoopingEnable

boolean

  • true

  • false

fasle

dns snooping开关。默认值为false。

false

gameSpeedUpEnable

boolean

  • true

  • false

true

手游加速开关,默认打开。

false

relativeRadios

integer

[1-7]

-

射频类型。

1 --- 2.4G(wlan-radio 0/0/0)。

2 --- 5G(wlan-radio 0/0/1)。

3 --- 2.4G(wlan-radio 0/0/0)&5G(wlan-radio 0/0/1)。

4 --- 5G/6G(wlan-radio 0/0/2)。

5 --- 2.4G(wlan-radio 0/0/0)&5G/6G(wlan-radio 0/0/2)。

6 --- 5G(wlan-radio 0/0/1)&5G/6G(wlan-radio 0/0/2)。

7 --- 2.4G(wlan-radio 0/0/0)&5G(wlan-radio 0/0/1)&5G/6G(wlan-radio 0/0/2)。

3

relativeOnlyTwoRadios

integer

[1-4]

-

射频类型,这里为射频口的默认频段,射频调优后可能会进行冗余射频调整。对双射频口款型生效。若该字段入参不携带,继承relativeRadios的配置。

1 --- 2.4G(wlan-radio 0/0/0)。

2 --- 5G(wlan-radio 0/0/1)。

3 --- 2.4G(wlan-radio 0/0/0)&5G(wlan-radio 0/0/1)。

4 --- 空配置。若站点下存在双射频款型时,该款型会配置结果报错,ssid不进行下发。

3

dtimInterval

int32

[1-255]

1

DTIM周期.

1

advertiseApNameSwitch

boolean

  • true

  • false

false

Beacon帧携带AP name使能开关,默认关闭。

true

frequencyNavigation

boolean

  • true

  • false

true

是否开启频谱导航。

true

maxUserNumber

integer

[1-600]

-

最大用户数。

64

blackAndWhite

REFERENCE

详细请参见表32

-

-

userSeparation

boolean

  • true

  • false

true

是否用户隔离。当userSeparation为true时,开启二三层用户隔离。

false

separationOption

string

-

-

用户隔离状态。取值范围:all---开启二三层隔离,l2---开启二层隔离,disable---不隔离。当userSeparation为true时,separationOption只允许为all 或 l2,默认为all;当userSeparation为false时,separationOption只允许为disable。V200R019C10版本以及之后的设备版本,separationOption生效。

"disable"

userL2LanIsolate

boolean

  • true

  • false

false

设备间二层用户隔离开关。开启后,用户报文只能访问网关。默认值为false。

false

staNetworkDetect

boolean

  • true

  • false

true

sta-network-detect开关。默认为true。

true

muMiMo

boolean

  • true

  • false

true

mimo开关。默认值为true。

true

associationTimeout

integer

[1-30]

-

终端老化时间(分钟)。

5

erSuSwitch

boolean

  • true

  • false

true

ER-SU远距离覆盖开关。默认值为true。

true

userFlowSyslogEnable

boolean

  • true

  • false

false

上报用户流量信息开关。默认值为false。

false

multiLinkOper

boolean

  • true

  • false

false

多链路链接开关。默认值为false。

false

lay3RoamSwitch

boolean

  • true

  • false

true

三层漫游开关。默认值为true。

true

suExtendedRangeSwitch

boolean

  • true

  • false

false

suer模式开关,当前版本未实现。默认值为false。

false

muRtsSwitch

boolean

  • true

  • false

false

MU-RTS使能开关,当前版本未实现。默认值为false。

false

muRtsThreshold

int64

[64-65535]

2347

MU-RTS门限,当前版本未实现。默认值为2347。

2347

forbiddenOldTerminal

boolean

  • true

  • false

false

禁止传统终端接入。

false

reachMaxSta

integer

[1-3]

-

接入阈值策略 范围:1:SSID接入的终端达到阈值后,新用户禁止接入。 2:SSID接入的终端达到阈值后,新用户禁止接入,且自动隐藏该SSID。 3:SSID接入的终端达到阈值后,VIP用户优先接入,替换掉普通用户。

1

igmpSnooping

boolean

  • true

  • false

false

是二层组播的基本功能,可以实现组播数据在数据链路层的转发和控制。

false

multicast2Unicast

string

  • disable

  • enable

  • dynamic-adaptive

-

组播转单播,如果要黑盒功能可用,需要开启igmpSnooping。

"disable"

bcmcDenyAll

boolean

  • true

  • false

false

广播或组播禁止,非必填。现网中没有业务依赖于除ARP/ND/DHCP以外的广播或组播报文,可以通过禁止空口所有广播或组播报文的发送,提高空口性能。

false

bonjourTransparent

boolean

  • true

  • false

false

bonjour透传

false

powerSave

boolean

  • true

  • false

false

高级省电功能,U-APSD(Unscheduled Automatic Power Save Delivery)功能。缺省情况下,U-APSD功能未使能。

false

beacon2gRate

string

  • 1Mbps

  • 2Mbps

  • 5.5Mbps

  • 6Mbps

  • 9Mbps

  • 11Mbps

  • 12Mbps

  • 18Mbps

  • 24Mbps

  • 36Mbps

  • 48Mbps

  • 54Mbps

-

2.4G射频Beacon帧发送速率(Mbps)

"1Mbps"

beacon5gRate

string

  • 6Mbps

  • 9Mbps

  • 12Mbps

  • 18Mbps

  • 24Mbps

  • 36Mbps

  • 48Mbps

  • 54Mbps

-

5G射频Beacon帧发送速率(Mbps)

"6Mbps"

beacon6gRate

string

-

-

6G射频Beacon帧发送速率(Mbps),支持6Mbps、9Mbps、12Mbps、18Mbps、24Mbps、36Mbps、48Mbps、54Mbps

"6Mbps"

sipPort

integer

[1-65535]

-

SIP协议端口

5060

timeTemplateName

string

-

-

时间模板名称,非必填

"全天"

seaSwitch

boolean

  • true

  • false

false

音频质量分析。

false

overDsPrivate

string

  • disable

  • enable

-

端管协同漫游

使能端管协同漫游功能后只支持开放网络(Open和Open+Portal)、半开放网络(PSK+WPA2+AES、PPSK+WPA2+AES)、安全网络(802.1X+WPA2+AES)。

括号内的认证场景指代字段:开放网络即mode是open,半开放和安全网络为(认证模式+加密模式+加密算法)的组合。

认证模式 - mode

加密模式 - 根据不同的场景对应:pskEncryptType、dot1xEncryptType

加密算法 - securityKeyType

"disable"

ssidAuth

REFERENCE

详细请参见表33

-

-

vapBackupConfig

REFERENCE

详细请参见表37

-

-

ssidPolicy

REFERENCE

详细请参见表38

-

-

dot11r

boolean

  • true

  • false

false

使能802.11r快速漫游功能。默认值为false。

使能802.11r快速漫游功能后只支持开放网络(Open和Open+Portal)、半开放网络(PSK+WPA2+AES、PPSK+WPA2+AES、PSK-SAE+WPA2-WPA3+AES、SAE+WPA3+AES)、安全网络(802.1X+WPA2+AES、802.1X+WPA2-WPA3+AES、802.1X+WPA3+CCMP128)。

括号内的认证场景指代字段:开放网络即mode是open,半开放和安全网络为(认证模式+加密模式+加密算法)的组合。

认证模式 - mode

加密模式 - 根据不同的场景对应:pskEncryptType、saeEncryptType、pskSaeEncryptType、dot1xEncryptType

加密算法 - securityKeyType

false

overDs

boolean

  • true

  • false

false

使能802.11r快速漫游功能over the ds协议。当dot11r为true时才生效。默认值为false。

false

reassociateTimeout

integer

[1-10]

1

重新关联的超时时间,单位为秒。默认值为1。

1

serviceGuarantee

string

  • performanceFirst

  • reliabilityFirst

performanceFirst

业务保障功能模式。可选:performanceFirst 性能优先,非AR/VR场景使用。reliabilityFirst 可靠性优先,AR/VR场景使用,提升用户体验,不配或配其他值时默认下performanceFirst配置。

"performanceFirst"

activeDullClient

boolean

  • true

  • false

false

抑制省电开关。设备默认是省电的,如果该开关打开,会让设备切出省点模式,设备切换成正常模式,耗点更快。默认值为false。

false

wmmScene

string

-

default

wmm场景,可选四个值,default、voice、voiceAndVideo、customize。该字段主要对报文进行优先级选择,若选default,则按照设备默认优先级处理;若选voice,则设备优先处理涉及音频的报文;若选voiceAndVideo,则优先处理音频和视频的报文;当选择customize时,即自定义优先级,则需要填写EdcaClientDto的相关参数。默认值为default。

"default"

edcaClientConfigList

ARRAY_REFERENCE

0-4个列表项,详细请参见表49

当wmmScene为customize,即自定义时,可选填该数组。若不填,就不更改此配置,结构体参见EdcaClientDto。

-

insertOption82Enable

boolean

  • true

  • false

false

是否插入Option82选项。

false

option82

REFERENCE

详细请参见表50

当insertOption82Enable为true时,该字段必填;为false时,该字段不生效,结构体参见Option82Dto。

-

forwardMode

string

  • direct

  • softgre

-

数据转发模式。可取值为:direct、softgre。

"direct"

softgreProfileId

string

36个字符。

-

softgre模板ID,当forwardMode为softgre时,此字段为必填字段。

"fbde1c5d-5b94-49e3-a912-48641015e45f"

configName

string

0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。

-

配置名称标识

"ssid-tmp-config-name"

phyProtection

string

满足正则表达^(security-priority|business-priority|disable)$。

disable

密盾功能。可选:security-priority 安全优先,对于不支持MU-MIMO功能的终端会拒绝接入;business-priority 业务优先只保障支持MU-MIMO功能的终端的业务安全性;disable:不使能。

"security-priority"

表29 TagDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

name

string

1~32个字符。

-

标签名称。长度为1-32之间。支持中英文,数字以及_和-。

"testApTag"

表30 SiteTemplateVlanDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

vlanId

integer

[1-4094]

-

所属VLAN ID。

10

vlanDesc

string

0~80个字符。

-

VLAN描述。

"work"

表31 CustomVlanDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

priority

int32

[0-250]

-

优先级。0的优先级最低;当取值大于0时,值越小优先级越高。

0

vlanId

int32

[1-4094]

-

所属VLAN ID。

10

vlanDesc

string

0~80个字符。

-

VLAN描述。

"work"

tags

ARRAY_REFERENCE

0-10个列表项,详细请参见表29

设备标签列表,总数不能超过10个。如果指定标签列表,SSID会下发给带有列表中标签的设备。如果不指定,会下发给站点模板绑定的站点内所有设备。

-

表32 BlackAndWhite对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

bindingType

int32

0~2个字符。

-

0--不绑定,1--黑名单设置,2--白名单设置

2

terminalMacList

array<string>

0-2048 个列表项。每个列表项0~20个字符。

-

AP终端MAC列表,多条数据之间使用逗号分隔。不支持广播、组播、全零MAC或广播、组播OUI。中心AP支持2048条。云AP最大支持256条,超过256条会下发失败。重复项无效,提交时将忽略重复项。

["XX:XX:XX:XX:XX:XX"]

terminalOUIList

array<string>

0-2048 个列表项。每个列表项0~20个字符。

-

AP终端OUI列表,多条数据之间使用逗号分隔。不支持广播、组播、全零MAC或广播、组播OUI。中心AP支持2048条。云AP最大支持256条,超过256条会下发失败。重复项无效,提交时将忽略重复项。

["02:02:01"]

表33 SiteTemplateAuthContentDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

mode

string

  • open

  • owe

  • psk

  • ppsk

  • sae

  • psk-sae

  • dot1x

  • mac

  • pskportal

  • pskmacauth

  • dpskmacauth

  • rpskmacauth

-

关联SSID时的认证模式,当mode为mac或dot1x时radius必填。当mode为open或pskportal时,portal认证内容必填。当mode为owe时,oweTransitionMode必填。"open",对应WLAN安全策略为:开放网络(Open),开放网络(Portal认证);"pskportal" 对应WLAN安全策略为:半开放网络(PSK+Portal认证)"owe" 对应WLAN安全策略为:开放网络(OWE);开放网络(OWE+Portal认证)"psk", 对应WLAN安全策略为:半开放网络(PSK认证)"PPSK", 对应WLAN安全策略为:半开放网络(PPSK认证)"SAE", 对应WLAN安全策略为:半开放网络(SAE认证)"PSK-SAE", 对应WLAN安全策略为:半开放网络(PSK-SAE认证)"mac", 对应WLAN安全策略为:半开放网络(MAC认证)"pskmacauth", 对应WLAN安全策略为:半开放网络(PSK+MAC认证)"rpskmacauth",对应WLAN安全策略为:半开放网络(RPSK+MAC认证)"dpskmacauth",对应WLAN安全策略为:半开放网络(DPSK+MAC认证)"dot1x",对应WLAN安全策略为:安全网络(802.1X认证)。

"ppsk"

oweTransitionMode

boolean

  • true

  • false

-

owe过渡认证模式是否使能,当mode为owe时必填。

true

transitionOpenSsid

string

-

-

过渡认证模式下的Open网络SSID的ID。当oweTransitionMode为true时,该字段必填。

"de5813f8ff1e41f5ba9c324da70b49ed"

pskEncryptType

string

  • wep

  • wpa1AndWpa2

  • wpa2

  • wpa

-

psk认证方式下的加密模式,当mode为psk或ppsk或pskportal或pskmacauth或rpskmacauth时必选。大小写敏感,前后不能有空格,且不能含有全角字符。当mode为ppsk时加密方式不支持wep。当mode为rpskmacauth时仅支持wpa2。

"wpa2"

wepType

string

  • WEP40

  • WEP104

  • WEP128

-

wep加密方式密钥类型,当认证模式为psk并且加密模式为wep时需填。

"WEP40"

wepDefaultKey

integer

  • 0

  • 1

  • 2

  • 3

-

加密方式为WEP时的default-key,有效取值为0~3,传入null时,内部自动生成

0

enableMacAuth

boolean

  • true

  • false

false

当认证模式为psk时需填。当值为true时,radius必填并且escapeStrategy必填。

false

securityKey

password

-

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

psk密钥,当mode为psk或pskportal或pskmacauth时必选。查询始终为null。

当pskEncryptType为wep时,5位字符与数字组合的字符串或10位十六进制数。

当pskEncryptType为wpa1AndWpa2或wpa2或wpa时,8-63位字母、数字或特殊字符组合,不能以空格或双引号开始或结尾,不能全是*,空格不能出现在双引号前后。

-

saeEncryptType

string

  • wpa3

-

sae认证方式下的加密模式,当mode为sae时必选。大小写敏感,前后不能有空格,且不能含有全角字符。

-

saeSecurityKey

password

-

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

sae密钥,当mode为sae时必选。查询始终为null。8-63位字母、数字或特殊字符组合,不能以空格或双引号开始或结尾,不能全是*,空格不能出现在双引号前后。

-

pskSaeEncryptType

string

  • wpa2AndWpa3

-

psk-sae认证方式下的加密模式,当mode为psk-sae时必选。大小写敏感,前后不能有空格,且不能含有全角字符。

-

pskSaeSecurityKey

password

-

-

该字段可能包含敏感信息和个人数据,请妥善做好保护。

psk-sae密钥,当mode为psk-sae时必选。查询始终为null。8-63位字母、数字或特殊字符组合,不能以空格或双引号开始或结尾,不能全是*,空格不能出现在双引号前后。

-

securityKeyType

string

  • AES

  • AES-TKIP

  • TKIP

  • gcmp256

  • ccmp128

AES

加密算法。

当pskEncryptType为wpa2且认证场景mode为除rpskmacauth的其他枚举时、或者当dot1xEncryptType为wpa2时,securityKeyType必填,且只能从AES、AES-TKIP和TKIP中选择,默认为AES;

当pskEncryptType为wpa2且mode为rpskmacauth时,securityKeyType必填,且只能从AES、TKIP中选择,默认为AES;

当saeEncryptType为wpa3时,securityKeyType必填,只能为AES;

当pskSaeEncryptType或dot1xEncryptType为wpa2AndWpa3时,securityKeyType必填,且只能选择AES;

当dot1xEncryptType为wpa3时,securityKeyType必填,且只能选择gcmp256、ccmp128;

且场景上与dot11r(802.11r快速漫游功能)和overDsPrivate(端管协同功能)有联系,详见对应字段描述。

大小写敏感,前后不能有空格,且不能含有全角字符。

"AES"

dot1xEncryptType

string

  • wpa1AndWpa2

  • wpa2AndWpa3

  • wpa2

  • wpa3

-

dot1x加密模式,当mode为dot1x时必选。大小写敏感,前后不能有空格,且不能含有全角字符。

-

dot1xQuietPeriod

int32

[1-3600]

-

dot1x认证静默时间。

60

dot1xQuietTimes

int32

[1-10]

-

dot1x认证静默失败次数。

10

macAutoBinding

boolean

  • true

  • false

-

是否MAC自动绑定。当mode为ppsk时,此参数必填。若值为true,则开启MAC自动绑定。

true

macAuthMethod

string

  • CHAP

  • PAP

-

MAC认证协议,当mode为mac时生效,默认为PAP,建议选用CHAP。大小写敏感,前后不能有空格,且不能含有全角字符。

-

escapeStrategy

string

-

noNew

逃生策略。取值范围:1.noNew 2.noAuth 3.userDefined

当mode为ppsk和mac时,此参数有效。当mode为ppsk时,仅支持noNew和noAuth;mode为mac时,全部支持。当escapeStrategy为null时,默认传noNew。

noNew:允许已认证用户继续使用网络,新用户不允许接入。默认值。

noAuth:允许已认证用户继续使用网络,新用户需要输入PPSK密钥。注意:此时PPSK用户数控制、MCA自动绑定功失效。

userDefined:允许用户接入,不需要认证,使用自定义逃生模板。

"noAuth"

escapeProfileName

string

-

-

逃生模板名字

"escapeStrategy1"

escapeProfileId

string

-

-

逃生模板ID。当escapeStrategy为userDefined时,此项必填。

"5871926c-2a5e-4340-a931-19ce019a231c"

portal

REFERENCE

详细请参见表34

-

-

radius

REFERENCE

详细请参见表35

-

-

haca

REFERENCE

详细请参见表36

-

-

表34 SiteTemplatePortalContentDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

mode

string

  • portalDisable

  • portalThirdIndirect

  • portalThirdController

  • portalThird

-

认证方式。

portalDisable---不启用Portal认证(当mode为pskportal时不能为portalDisable)。

portalThirdIndirect---云平台中继认证(默认对接方式:API)。

"portalThirdIndirect"

pushProtocol

string

-

-

推送协议,取值范围https/http,大小写不敏感,当云平台中继认证时生效,默认值是安全的https协议。

"https"

freeAuthEnable

boolean

  • true

  • false

-

有效期内免认证是否开启,当mode为portalThirdIndirect时必选。

true

authExpireUnit

string

-

minute

Portal认证有效期单位,ssid创建场景:freeAuthEnable为true时,此字段不传则默认值为minute;ssid更新场景:freeAuthEnable为true时,此字段不传则使用更新前的值。只能为day、hour、minute中的一个,大小写不敏感,前后空格忽略,且不能含有全角字符。默认值为minute。

"day"

authExpire

integer

[1-365]

2

Portal认证有效期,ssid创建场景:freeAuthEnable为true时,此字段不传则默认值为2;ssid更新场景:freeAuthEnable为true时,此字段不传则使用更新前的值。

authExpireUnit为minute时,范围为1~59。

authExpireUnit为hour时,范围为1~23。

authExpireUnit为day时,范围为1~365。

10

escapeStrategy

integer

-

1

逃生策略,当mode为portalThirdIndirect时有效,此字段不传时,默认值是1。

1---允许已认证用户继续使用网络,新用户不允许接入,默认值(noNew)

2---允许用户接入,不需要认证(noAuth)

3---允许用户接入,不需要认证,使用自定义逃生模板。(userDefined)

2

escapeProfileName

string

-

-

逃生模板名字

"escapeStrategy1"

escapeProfileId

string

-

-

逃生模板ID。当escapeStrategy为3时,此项必填。

"5871926c-2a5e-4340-a931-19ce019a231c"

freeAclTmplId

string

0~36个字符。

-

免认证ACL,当mode为portalThirdIndirect时必填。免认证ACL可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c4"

freeAclTmplName

string

1~32个字符。

-

免认证ACL名称,当mode为portalThirdIndirect时有效。POST与PUT操作时,该字段无效。长度为1至32字节。

"free-acl-name"

controllerPortalType

string

  • haca

  • portalTpz

-

Portal协议类型: haca:haca portal2.0:portalTpz。Portal2.0只支持非NAT场景。云平台内置认证方式时需填

"haca"

masterPortalTmplId

string

32~36个字符。

-

主portal服务器ID。认证方式为云平台内置和第三方认证时需填

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

masterPortalTmplName

string

-

-

主portal服务器模板名称。POST与PUT操作时,该字段无效。

-

bakPortalEnable

boolean

  • true

  • false

-

备portal服务器开关。第三方认证方式时使用,非必填。

false

bakPortalTmplId

string

32~36个字符。

-

备portal服务器ID。第三方认证方式时使用,当bakPortalEnable开启时必填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

bakPortalTmplName

string

-

-

备portal服务器模板名称。POST与PUT操作时,该字段无效。

-

authRedirectUrlCarryEnable

boolean

  • true

  • false

-

授权重定向场景携带URL参数。云平台内置认证方式,portal2.0协议类型时需填。

false

radiusEnable

boolean

  • true

  • false

-

radius开关

false

radiusTmplId

string

32~36个字符。

-

radius模板ID。认证方式为云平台内置和第三方认证时需填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

radiusTmplName

string

-

-

radius模板名称。POST与PUT操作时,该字段无效。

-

fastPushEnable

boolean

  • true

  • false

-

推送方式:值为true时为快速推送,false为高级推送。使用快速推送时,只能选择一种推送方式,微信链接、用户名密码、短信认证、Passcode认证、一键认证、社交媒体、匿名认证只能有一个值为true,并且portalPageId必填。使用高级推送时请在准入 > 准入资源 > 页面管理 > Portal页面推送策略中配置启用的登录类型页面。云平台内置认证方式时需填。

true

portalPageId

string

32~36个字符。

-

推送页面ID。根据准入 > 准入资源 > 页面管理 > 页面定制获取ID。云平台内置认证方式且使用了快速推送方式时需填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

wechatUrlAuthEnable

boolean

  • true

  • false

-

推送方式:默认微信链接认证定制页面。云平台内置认证方式时选填。

false

weComAuthEnable

boolean

  • true

  • false

false

推送方式:默认企业微信认证定制页面。云平台内置认证方式时选填。默认值为false。

false

dingTalkEnable

boolean

  • true

  • false

false

推送方式:默认钉钉认证定制页面。云平台内置认证方式时选填。默认值为false。

false

normalEnable

boolean

  • true

  • false

-

推送方式:默认用户名认证定制页面。云平台内置认证方式时选填。当值为true时,registerEnable必填。

false

registerEnable

boolean

  • true

  • false

-

用户自注册使能。推送页面为默认用户名认证定制页面时需填,当值为true时,需要填用户有效期,用户所属组,最大接入终端数选填。

false

registerExpire

int32

[1-365]

-

用户有效期。推送页面为默认用户名认证并且开启了用户自注册时必填。

registerExpireUnit为minute时,范围为1~59。

registerExpireUnit为hour时,范围为1~23。

registerExpireUnit为day时,范围为1~365。

2

registerExpireUnit

string

  • day

  • hour

  • minute

-

用户有效期单位。推送页面为默认用户名认证并且开启了用户自注册时必填。

"hour"

userRegisterMaxAccessNumber

int32

[0-16]

-

用户注册最大接入数:0代表不限制,1-16为具体限制数。推送页面为默认用户名认证定制页面时并且开启了用户自注册时选填。

0

userGroupId

string

32~36个字符。

-

用户名密码认证用户组id:根据准入用户组来获取ID值。推送页面为默认用户名认证定制页面时,并且开启了用户自注册时必填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

smsAuthEnable

boolean

  • true

  • false

-

推送方式:默认短信认证定制页面。云平台内置认证方式时选填。用户输入手机号码,通过获取短信验证码后,可以正常上网,相关参数在系统 > 系统设置 > 第三方服务 > 第三方服务 > 短信服务器中配置。

false

smsPasswordExpire

int32

[1-365]

-

短信验证密码有效期。推送页面为短信认证定制页面时必填。

registerExpireUnit为minute时,范围为1~59。

registerExpireUnit为hour时,范围为1~23。

registerExpireUnit为day时,范围为1~365。

5

smsPasswordExpireUnit

string

  • day

  • hour

  • minute

-

短信验证密码有效期单位。推送页面为短信认证定制页面时必填。

"minute"

smsUserRegisterEnable

boolean

  • true

  • false

-

用户自注册使能。推送页面为短信认证定制页面时需填,当值为true时,需要填用户有效期,用户所属组,最大接入终端数选填。

false

smsUserExpire

int32

[1-365]

-

用户有效期。推送页面为短信认证定制页面并且开启了用户自注册时必填。

registerExpireUnit为minute时,范围为1~59。

registerExpireUnit为hour时,范围为1~23。

registerExpireUnit为day时,范围为1~365。

2

smsUserExpireUnit

string

  • day

  • hour

  • minute

-

用户有效期单位。推送页面为短信认证定制页面并且开启了用户自注册时必填。

"hour"

smsUserMaxAccessNumber

int32

[0-16]

-

用户注册最大接入数:0代表不限制,1-16为具体限制数。推送页面为短信认证定制页面时并且开启了用户自注册时选填。

0

smsUserGroupId

string

32~36个字符。

-

短信认证用户组id:根据准入用户组来获取ID值。推送页面为短信认证定制页面时,并且开启了用户自注册时必填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

emailAuthEnable

boolean

  • true

  • false

-

推送方式:邮箱认证定制页面。云平台内置认证方式时选填。用户使用邮箱进行认证后,可以正常上网,相关参数属于全局配置,在admin > 系统 > 系统管理 > 第三方服务 > 邮箱服务器参数中配置。

false

passCodeEnable

boolean

  • true

  • false

-

推送方式:默认passcode认证定制页面。云平台内置认证方式时选填。

false

oneKeyAuthEnable

boolean

  • true

  • false

-

推送方式:默认一键认证定制页面。云平台内置认证方式时选填。用户只需要输入用户名和验证码,并点击“登录”按钮就可以正常上网。

false

anonymousEnable

boolean

  • true

  • false

-

推送方式:默认匿名认证定制页面。云平台内置认证方式时选填。 用户不用输入信息,只需要点击页面上的“登录”按钮就可以正常上网。相关参数在准入 > 准入策略 > 准入设置 > 高级参数中配置。

false

socialMediaEnable

boolean

  • true

  • false

-

推送方式:默认社交媒体认证定制页面。云平台内置认证方式时选填。当值为true时,需要配置Facebook、Twitter、新浪微博、QQ认证中的一种或多种,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

twitterEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之Twitter认证。云平台内置认证方式时选填。用户使用Twitter进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

sinaEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之新浪微博认证。云平台内置认证方式时选填。用户使用新浪微博进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

qqEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之QQ认证。云平台内置认证方式时选填。用户使用QQ进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

qrCodeAuthEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之公共二维码认证。云平台内置认证方式时选填。用户使用公共二维码进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

qrCodeRegisterEnable

boolean

  • true

  • false

false

默认社交媒体认证定制页面之二维码审批认证。云平台内置认证方式时选填。用户使用二维码审批进行认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

googleEnable

boolean

  • true

  • false

-

默认社交媒体认证定制页面之Google认证。云平台内置认证方式时选填。用户使用Google认证后,可以正常上网,相关参数属于全局配置,在准入 > 准入资源 > 外部数据源 > 社交媒体参数中配置。

false

accountingEnable

boolean

  • true

  • false

-

实时计费开关。云平台内置认证方式时选填。

false

accountingExpire

int32

[5-65535]

-

计费上报周期时长(单位分钟)。实时计费开关开启时必填。云平台内置认证方式使用。

15

interconnectionMode

string

  • API

  • radiusRelay

API

云平台中继认证对接方式。API:API对接方式;radiusRelay:Radius中继认证方式。开启云平台中继认证方式时需填。默认值为API。

"API"

userNameKey

string

1~64个字符。

-

第三方portal页面认证“用户名”参数名称,由字母名称横杠和下划线的组合。开启云平台中继认证方式并使用Radius中继对接方式时需填。

"用户"

passwordKey

string

-

-

第三方portal页面认证“密码”参数名称,由字母名称横杠和下划线的组合。开启云平台中继认证方式并使用Radius中继对接方式时需填。

-

urlMatchMode

int32

[0-1]

-

跳转URL匹配规则:0--重定向URL参数 1--重定向URL地址,为null时默认为0。提供两种方式进行第三方portal页面跳转URL:

重定向URL参数:根据请求中携带的URL地址的参数名和参数值进行重定向URL地址的获取,当参数名匹配上输入框中的参数名,获取对应的参数值作为重定向URL地址进行跳转。

重定向URL地址:根据需要跳转的URL地址直接获取输入框中的重定向URL地址进行跳转。

云平台内置认证方式使用。

0

successUrlKey

string

0~256个字符。

-

第三方portal页面认证“认证成功跳转URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

authFailedUrlKey

string

0~256个字符。

-

第三方portal页面认证“认证失败跳转URL”参数名称,由字母名称横杠和下划线的组合。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

logoutSuccessUrlKey

string

0~256个字符。

-

第三方portal页面认证“注销成功跳转URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

logoutFailedUrlKey

string

0~256个字符。

-

第三方portal页面认证“注销失败跳转URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。。开启云平台中继认证方式并使用Radius中继对接方式, 跳转URL匹配规则为重定向URL参数时选填。

-

logoutUrlKey

string

0~256个字符。

-

第三方portal页面认证“注销页面URL”参数名称,由字母名称横杠和下划线的组合,当URL匹配规则为重定向URL地址时,URL长度不能超过256位,URL必须以“http://” 或者 “https://”开头,且不能包含@、localhost或xip.io。。开启云平台中继认证方式并使用Radius中继对接方式时选填。

-

radiusModelId

string

32~36个字符。

-

radius中继服务器模板ID。开启云平台中继认证方式并使用Radius中继对接方式时需填。

"0b6d8077-947a-41d0-a539-c8a02c5fe6dc"

表35 SiteTemplateRadiusContentDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

radiusTmplId

string

0~36个字符。

-

RADIUS模板ID。

"b90f8190-e12f-4323-95f3-4018309209c4"

radiusTmplName

string

0~32个字符。

-

RADIUS模板名称。POST与PUT操作时,该字段无效。

"test"

staticEnable

boolean

  • true

  • false

-

用户流量统计使能开关。

false

iconnectAccessEnable

boolean

  • true

  • false

false

iConnect终端接入开关,默认值为false。

-

autoReauthenTime

integer

[0-7200]

0

自动重认证时间,单位为秒,取值范围:0 或 30-7200

0---自动重认证功能关闭,默认值

30-7200---自动重认证功能打开时的自动重认证时间

-

hacaEnable

boolean

  • true

  • false

-

radius内置场景是否支持NAT场景Coa/DM。

false

表36 SiteTemplateHacaContentDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

authComponentId

string

0~36个字符。

-

主认证组件ID(内置认证服务为00000000-0000-0000-0000-000000000000,拉远场景为拉远组件ID)

"00000000-0000-0000-0000-000000000000"

authComponentIp

string

7~15个字符。

-

主认证组件IP(内置认证服务时可以不填,拉远场景为拉远组件IP)

"10.20.0.0"

bakAuthComponentId

string

0~36个字符。

-

备认证组件ID(内置认证服务为00000000-0000-0000-0000-000000000000,拉远场景为拉远组件ID)

"00000000-0000-0000-0000-000000000000"

bakAuthComponentIp

string

7~15个字符。

-

备认证组件IP(内置认证服务时可以不填,拉远场景为拉远组件IP)

"10.20.0.0"

表37 SiteTemplateVapBackupConfig对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

vapBackupEnable

boolean

  • true

  • false

false

开启802.1x备份认证,默认false,关闭。

false

radiusBackupTmplId

string

0~36个字符。

-

监控radius模板Id,当vapBackupEnable为true时必填。UUID格式。

"cf23f275-01e6-4301-890e-407e1d78c53e"

rejectNewAccess

boolean

  • true

  • false

-

仅限在监控radius认证过的终端接入,非必填,默认false。

false

表38 SiteTemplatePolicyContentDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

securityPolicy

REFERENCE

详细请参见表39

-

-

ssidRateLimit

REFERENCE

详细请参见表45

-

-

terminalRateLimit

REFERENCE

详细请参见表46

-

-

terminalDynamicRateLimit

REFERENCE

详细请参见表48

-

-

ipv6Enable

boolean

  • true

  • false

false

是否支持IPV6。

false

ndTrustPort

boolean

  • true

  • false

false

启用或禁用nd信任接口。

false

表39 SiteTemplateSecurityPolicyConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

highReliableSliceAclTplId

string

0~36个字符。

-

高可靠切片acl模板id。ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式

"b90f8190-e12f-4323-95f3-4018309209c4"

highReliableSliceAclTplName

string

0~32个字符。

-

高可靠切片ACL模板名称。POST与PUT操作时,该字段无效。

"test-slice-acl"

highReliableSliceAclTplIdIpv6

string

0~36个字符。

-

高可靠切片IPV6 acl模板id。仅ipv6Enable为true且全局ipv6开启时有效。ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式

"b90f8190-e12f-4323-95f3-4018309209c4"

highReliableSliceAclTplNameIpv6

string

0~32个字符。

-

高可靠切片IPV6 ACL模板名称。POST与PUT操作时,该字段无效。

"test-slice-acl"

securityAclTmplId

string

0~36个字符。

-

安全ACL模板ID。安全ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c4"

securityAclTmplName

string

0~32个字符。

-

ACL模板名称。POST与PUT操作时,该字段无效。长度为1至32字节。

"test-security-acl"

securityIPv6AclTmplId

string

0~36个字符。

-

安全IPv6ACL模板ID。仅ipv6Enable为true且全局ipv6开启时有效。安全IPv6ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c4"

securityIPv6AclTmplName

string

0~32个字符。

-

IPv6ACL模板名称。POST与PUT操作时,该字段无效。

"test-security-acl"

ipsecAclTmplId

string

0~36个字符。

-

IPSEC ACL模板ID。IPSEC ACL模板可以通过第三方开放接口https://host:port/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c5"

ipsecAclTmplName

string

0~32个字符。

-

IPSEC ACL模板名称。POST与PUT操作时,该字段无效。长度为1至32字节。

"test-ipsec-acl"

tcpAdjustMss

int32

[128-2048]

-

最大报文长度

1380

appTrafficAcls

REFERENCE

详细请参见表40

应用流量优先级列表,单方向最多只能添加8条。

-

tunnelAclTmplId

string

0~36个字符。

-

隧道转发ACL模板ID。Tunnel ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c5"

tunnelAclTmplName

string

0~32个字符。

-

隧道转发ACL模板名称。POST与PUT操作时,该字段无效。

"test-tunnel-acl"

urlFilter

REFERENCE

详细请参见表44

-

-

appsPolicys

REFERENCE

详细请参见表42

应用过滤列表,最多只能添加32条。如果策略选择了permit并且同时配置了DSCP和CAR,则认为是两条策略。

-

表40 appTrafficAcls对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

appTrafficAclList

ARRAY_REFERENCE

0-16个列表项,详细请参见表41

-

-

表41 SiteTemplateAppTrafficAclDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

direction

string

  • inbound

  • outbound

-

应用流量优先级方向。

"inbound"

index

int32

[0-7]

-

优先级。

0

dscp

int32

[0-63]

-

DSCP优先级值,值越大优先级越高。action为deny时,忽略dscp。action为permit时,dscp不允许为空。应用和应用所属的分类存在互斥关系,分类如果是禁止,那么分类下的具体应用不能是禁止;分类如果是允许,分类下的具体应用如果也是允许,那么分类配置了DSCP,具体应用不能配置DSCP。取值范围:0、8、10、12、14、16、18、20、22、24、26、28、30、32、34、36、38、40、44、46、48、56

1

appTrafficAclTplId

string

0~36个字符。

-

应用流量优先级ACL模板ID。应用流量优先级ACL模板可以通过第三方开放接口/controller/campus/v3/profile/acl得到。UUID格式。

"b90f8190-e12f-4323-95f3-4018309209c5"

appTrafficAclName

string

0~32个字符。

-

应用流量优先级ACL模板名称。POST与PUT操作时,该字段无效。

"test-tunnel-acl"

表42 appsPolicys对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

siteSaList

ARRAY_REFERENCE

0-32个列表项,详细请参见表43

-

-

表43 SiteTemplateSecurityAppsPolicyDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

appId

int32

[0-10000]

-

应用id。

1

type

string

  • app

  • class

-

标示具体应用还是应用分类。app表示单个应用,class表示应用分类。

"app"

appType

int32

[0-1]

-

区分是预定义还是自定义。预定义为0,自定义是1,默认是预定义。

1

appName

string

0~128个字符。

-

应用名称。

"test_name"

action

string

  • permit

  • deny

-

策略是允许还是拒绝。

"permit"

dscp

int32

[0-63]

-

DSCP优先级值,值越大优先级越高。action为deny时,忽略dscp。action为permit时,dscp不允许为空。应用和应用所属的分类存在互斥关系,分类如果是禁止,那么分类下的具体应用不能是禁止;分类如果是允许,分类下的具体应用如果也是允许,那么分类配置了DSCP,具体应用不能配置DSCP。

1

car

int32

[64-10000000]

-

指定的报文速率, kbps。action为deny时,忽略car。action为permit时,car不允许为空。应用和应用所属的分类存在互斥关系,分类如果是禁止,那么分类下的具体应用不能是禁止;分类如果是允许,分类下的具体应用如果也是允许,分类配置了CAR,具体应用不能配置CAR。

1000

表44 SiteTemplateSecurityUrlFilterDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

enable

boolean

  • true

  • false

false

是否使能URL过滤。创建SSID时,若未填写此字段,默认值为false。该黑白名单机制对使用代理服务器的浏览器不生效。

true

mode

integer

  • 0

  • 1

-

URL过滤类型,当enable为true时mode字段必填且有效。

0---黑名单

1---白名单

1

urls

array<string>

0-128 个列表项。每个列表项4~80个字符。

-

URL列表。URL长度4-80个字符。当enable为true时有效。mode为0时,urls表示允许访问未匹配的url;mode为1时,urls表示禁止访问未匹配的url。每个URL限制要求:'*'只能出现在首尾,'*'不算做有效字符,前后空格忽略,前缀'http://'忽略,且不能含有全角字符,不能以“?”结尾。

-

hostNames

array<string>

0-128 个列表项。每个列表项4~255个字符。

-

域名列表,以换行符分割。域名长度4-255个字符。当enable为true时有效。mode为0时,域名表示允许访问未匹配的域名;mode为1时,域名表示禁止访问未匹配的域名。每个URL限制要求:'*'表示模糊匹配,前后空格忽略,不能含有全角字符,且不包含'/'、'\'、'#'、'"'、'?'及空格。

-

表45 SiteTemplateRateLimitContentDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

upEnable

boolean

  • true

  • false

false

上行限速使能。

true

upLimit

string

0~7个字符。

-

上行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当upEnable为true时生效

"50.0"

downEnable

boolean

  • true

  • false

false

下行限速使能。

true

downLimit

string

0~7个字符。

-

下行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当downEnable为true时生效

"50.0"

表46 SiteTemplateTerminalRateLimitContentDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

upEnable

boolean

  • true

  • false

false

上行限速使能。

true

upLimit

string

0~7个字符。

-

上行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当upEnable为true时生效

"50.0"

downEnable

boolean

  • true

  • false

false

下行限速使能。

true

downLimit

string

0~7个字符。

-

下行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当downEnable为true时生效

"50.0"

timeRange

ARRAY_REFERENCE

0-8个列表项,详细请参见表47

指定时段限速。基于指定时间段的限速策略优先级高于默认策略。如果同一时间有多条基于指定时间段的策略生效,以最小的限速值生效,结构体参见TimeRange。

-

表47 TimeRange对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

timeTemplateId

string

0~36个字符。

-

时间模板id,UUID格式

"b90f8190-e12f-4323-95f3-4018309209c4"

upEnable

boolean

  • true

  • false

-

上行限速使能。

true

upLimit

string

0~7个字符。

-

上行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当upEnable为true时生效

"50.0"

downEnable

boolean

  • true

  • false

-

下行限速使能。

true

downLimit

string

0~7个字符。

-

下行限速速率(Mbps),范围:0.1-10000.0内的数字,小数点后最多一位。当downEnable为true时生效

"50.0"

表48 TerminalDynamicRateLimitDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

dynamicEnable

boolean

  • true

  • false

false

终端流量动态流量限速功能开关,默认关闭(false)。如果动态流量限速功能开启,dynamicLimit值为必填。

false

dynamicLimit

int32

[0-32]

-

终端流量动态流量限速功能,流量值可以为8,16,32 (Mbit/s)

16

表49 EdcaClientDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

accessCategory

string

  • acvo

  • acvi

  • acbe

  • acbk

-

报文的4个接入类别。可取值为:acvo、acvi、acbe、acbk。WMM协议将数据报文分为4个接入类别AC(Access Category),分别为AC_VO(Voice)、AC_VI(Video)、AC_BE(Best Effort)、AC_BK(Background)。当accessCategory为acvo时,表示接入类别为语音流;当accessCategory为acvi时,表示接入类别为视频流;当accessCategory为acbe时,表示接入类别为尽力而为流;当accessCategory为acbk时,表示接入类别为背景流。

"acvo"

aifsn

integer

[2-15]

-

指定仲裁帧间隙数,决定了用户的空闲等待时间长短。aifsn数值越大,用户的空闲等待时间越长,优先级越低。范围为2-15。

10

ecwmax

integer

[0-15]

-

指定最大竞争窗口指数,此参数与ecwmin一起决定了用户的平均退避时间。这两个数值越大,用户的平均退避时间越长,优先级越低。取值范围:0~15,且须大于或等于ecwmin。

10

ecwmin

integer

[0-15]

-

指定最小竞争窗口指数,此参数与ecwmax一起决定了用户的平均退避时间。这两个数值越大,用户的平均退避时间越长,优先级越低。取值范围:0~15,且须小于或等于ecwmax。

10

txoplimit

integer

[0-255]

-

用户一次竞争信道成功后,可占用信道的最大时间,这个数值越大,用户一次能占用的信道时长越大。如果是0,则每次占用信道后,只能发送一个报文。取值范围:0~255。

10

表50 Option82Dto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

circuitId

REFERENCE

详细请参见表51

链路代理ID,结构体参见OptionParamDto。

-

remoteId

REFERENCE

详细请参见表51

远程代理ID,结构体参见OptionParamDto。

-

表51 OptionParamDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

connectorPattern

string

  • colon

  • semicolon

colon

选项不同类型内容间的连接符。可取值为:colon、semicolon。默认值为colon。

"colon"

contentType

string

  • ap-mac

  • ap-mac-ssid

  • ap-location

  • ap-location-ssid

  • ap-name

  • ap-name-ssid

  • user-defined

ap-mac

选项内容类型。可取值为:ap-mac、ap-mac-ssid、ap-location、ap-location-ssid、ap-name、ap-name-ssid、user-defined。默认值为ap-mac。

"ap-mac"

format

string

  • ascii

  • normal

  • compact

  • hex

  • colon

ascii

选项内容格式。可取值为:ascii、normal、compact、hex、colon。当contentType为ap-mac时,所有选项均可选择;当contentType为ap-mac-ssid时,hex不可选择。默认值为ascii。

"ascii"

userDefinedText

string

-

-

自定义内容,当contentType为user-defined时,此字段为必填字段。

"xxx"

返回状态码为400:校验异常。

详细信息请参见实际响应消息体。

返回状态码为500:内部服务错误。

详细信息请参见实际响应消息体。

响应示例

返回状态码为201:新增的站点模板内SSID配置信息,返回结构体参见SiteTemplateConfigSsidResponse。

HTTP/1.1 201 Created
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
	"errcode" : "0",
	"errmsg" : "",
	"data" : {
		"id" : "de5813f8ff1e41f5ba9c324da70b49ed",
		"name" : "Huawei-Guest",
		"pki" : "default",
		"tags" : [
			{
				"name" : "testApTag"
			}
		],
		"enable" : true,
		"timeTemplateId" : "2c3918cb-f0bd-44e3-963b-119870bfc779",
		"connectionMode" : "nat",
		"vlans" : [
			{
				"vlanId" : 10,
				"vlanDesc" : "work"
			}
		],
		"customVlans" : [
			{
				"priority" : 0,
				"vlanId" : 10,
				"vlanDesc" : "work",
				"tags" : [
					{
						"name" : "testApTag"
					}
				]
			}
		],
		"vlanMode" : "vlanId",
		"vlanPoolId" : "1e930b21-a307-45a9-96a2-f1443ca84f39",
		"vlanPoolName" : "vlanPool",
		"hidedEnable" : false,
		"autoOffTrackLinkEnable" : false,
		"arpCheckEnable" : true,
		"ipCheckEnable" : true,
		"dhcpStrictEnable" : false,
		"dhcpv6SlaacStrictEnable" : 0,
		"mdnsSnoopingEnable" : false,
		"dnsSnoopingEnable" : false,
		"gameSpeedUpEnable" : false,
		"relativeRadios" : 3,
		"relativeOnlyTwoRadios" : 3,
		"dtimInterval" : 1,
		"advertiseApNameSwitch" : true,
		"frequencyNavigation" : true,
		"maxUserNumber" : 64,
		"blackAndWhite" : {
			"bindingType" : 2,
			"terminalMacList" : [
				 "XX:XX:XX:XX:XX:XX"
			],
			"terminalOUIList" : [
				 "02:02:01"
			]
		},
		"userSeparation" : false,
		"separationOption" : "disable",
		"userL2LanIsolate" : false,
		"staNetworkDetect" : true,
		"muMiMo" : true,
		"associationTimeout" : 5,
		"erSuSwitch" : true,
		"userFlowSyslogEnable" : false,
		"multiLinkOper" : false,
		"lay3RoamSwitch" : true,
		"suExtendedRangeSwitch" : false,
		"muRtsSwitch" : false,
		"muRtsThreshold" : 2347,
		"forbiddenOldTerminal" : false,
		"reachMaxSta" : 1,
		"igmpSnooping" : false,
		"multicast2Unicast" : "disable",
		"bcmcDenyAll" : false,
		"bonjourTransparent" : false,
		"powerSave" : false,
		"beacon2gRate" : "1Mbps",
		"beacon5gRate" : "6Mbps",
		"beacon6gRate" : "6Mbps",
		"sipPort" : 5060,
		"timeTemplateName" : "全天",
		"seaSwitch" : false,
		"overDsPrivate" : "disable",
		"ssidAuth" : {
			"mode" : "ppsk",
			"oweTransitionMode" : true,
			"transitionOpenSsid" : "de5813f8ff1e41f5ba9c324da70b49ed",
			"pskEncryptType" : "wpa2",
			"wepType" : "WEP40",
			"wepDefaultKey" : 0,
			"enableMacAuth" : false,
			"securityKey" : "",
			"saeEncryptType" : "",
			"saeSecurityKey" : "",
			"pskSaeEncryptType" : "",
			"pskSaeSecurityKey" : "",
			"securityKeyType" : "AES",
			"dot1xEncryptType" : "",
			"dot1xQuietPeriod" : 60,
			"dot1xQuietTimes" : 10,
			"macAutoBinding" : true,
			"macAuthMethod" : "",
			"escapeStrategy" : "noAuth",
			"escapeProfileName" : "escapeStrategy1",
			"escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c",
			"portal" : {
				"mode" : "portalThirdIndirect",
				"pushProtocol" : "https",
				"freeAuthEnable" : true,
				"authExpireUnit" : "day",
				"authExpire" : 10,
				"escapeStrategy" : 2,
				"escapeProfileName" : "escapeStrategy1",
				"escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c",
				"freeAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
				"freeAclTmplName" : "free-acl-name",
				"controllerPortalType" : "haca",
				"masterPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
				"masterPortalTmplName" : "",
				"bakPortalEnable" : false,
				"bakPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
				"bakPortalTmplName" : "",
				"authRedirectUrlCarryEnable" : false,
				"radiusEnable" : false,
				"radiusTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
				"radiusTmplName" : "",
				"fastPushEnable" : true,
				"portalPageId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
				"wechatUrlAuthEnable" : false,
				"weComAuthEnable" : false,
				"dingTalkEnable" : false,
				"normalEnable" : false,
				"registerEnable" : false,
				"registerExpire" : 2,
				"registerExpireUnit" : "hour",
				"userRegisterMaxAccessNumber" : 0,
				"userGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
				"smsAuthEnable" : false,
				"smsPasswordExpire" : 5,
				"smsPasswordExpireUnit" : "minute",
				"smsUserRegisterEnable" : false,
				"smsUserExpire" : 2,
				"smsUserExpireUnit" : "hour",
				"smsUserMaxAccessNumber" : 0,
				"smsUserGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc",
				"emailAuthEnable" : false,
				"passCodeEnable" : false,
				"oneKeyAuthEnable" : false,
				"anonymousEnable" : false,
				"socialMediaEnable" : false,
				"twitterEnable" : false,
				"sinaEnable" : false,
				"qqEnable" : false,
				"qrCodeAuthEnable" : false,
				"qrCodeRegisterEnable" : false,
				"googleEnable" : false,
				"accountingEnable" : false,
				"accountingExpire" : 15,
				"interconnectionMode" : "API",
				"userNameKey" : "用户",
				"passwordKey" : "",
				"urlMatchMode" : 0,
				"successUrlKey" : "",
				"authFailedUrlKey" : "",
				"logoutSuccessUrlKey" : "",
				"logoutFailedUrlKey" : "",
				"logoutUrlKey" : "",
				"radiusModelId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc"
			},
			"radius" : {
				"radiusTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
				"radiusTmplName" : "test",
				"staticEnable" : false,
				"iconnectAccessEnable" : "",
				"autoReauthenTime" : "",
				"hacaEnable" : false
			},
			"haca" : {
				"authComponentId" : "00000000-0000-0000-0000-000000000000",
				"authComponentIp" : "10.20.0.0",
				"bakAuthComponentId" : "00000000-0000-0000-0000-000000000000",
				"bakAuthComponentIp" : "10.20.0.0"
			}
		},
		"vapBackupConfig" : {
			"vapBackupEnable" : false,
			"radiusBackupTmplId" : "cf23f275-01e6-4301-890e-407e1d78c53e",
			"rejectNewAccess" : false
		},
		"ssidPolicy" : {
			"securityPolicy" : {
				"highReliableSliceAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
				"highReliableSliceAclTplName" : "test-slice-acl",
				"highReliableSliceAclTplIdIpv6" : "b90f8190-e12f-4323-95f3-4018309209c4",
				"highReliableSliceAclTplNameIpv6" : "test-slice-acl",
				"securityAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
				"securityAclTmplName" : "test-security-acl",
				"securityIPv6AclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4",
				"securityIPv6AclTmplName" : "test-security-acl",
				"ipsecAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5",
				"ipsecAclTmplName" : "test-ipsec-acl",
				"tcpAdjustMss" : 1380,
				"appTrafficAcls" : {
					"appTrafficAclList" : [
						{
							"direction" : "inbound",
							"index" : 0,
							"dscp" : 1,
							"appTrafficAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c5",
							"appTrafficAclName" : "test-tunnel-acl"
						}
					]
				},
				"tunnelAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5",
				"tunnelAclTmplName" : "test-tunnel-acl",
				"urlFilter" : {
					"enable" : true,
					"mode" : 1,
					"urls" : [
						 ""
					],
					"hostNames" : [
						 ""
					]
				},
				"appsPolicys" : {
					"siteSaList" : [
						{
							"appId" : 1,
							"type" : "app",
							"appType" : 1,
							"appName" : "test_name",
							"action" : "permit",
							"dscp" : 1,
							"car" : 1000
						}
					]
				}
			},
			"ssidRateLimit" : {
				"upEnable" : true,
				"upLimit" : "50.0",
				"downEnable" : true,
				"downLimit" : "50.0"
			},
			"terminalRateLimit" : {
				"upEnable" : true,
				"upLimit" : "50.0",
				"downEnable" : true,
				"downLimit" : "50.0",
				"timeRange" : [
					{
						"timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4",
						"upEnable" : true,
						"upLimit" : "50.0",
						"downEnable" : true,
						"downLimit" : "50.0"
					}
				]
			},
			"terminalDynamicRateLimit" : {
				"dynamicEnable" : false,
				"dynamicLimit" : 16
			},
			"ipv6Enable" : false,
			"ndTrustPort" : false
		},
		"dot11r" : false,
		"overDs" : false,
		"reassociateTimeout" : 1,
		"serviceGuarantee" : "performanceFirst",
		"activeDullClient" : false,
		"wmmScene" : "default",
		"edcaClientConfigList" : [
			{
				"accessCategory" : "acvo",
				"aifsn" : 10,
				"ecwmax" : 10,
				"ecwmin" : 10,
				"txoplimit" : 10
			}
		],
		"insertOption82Enable" : false,
		"option82" : {
			"circuitId" : {
				"connectorPattern" : "colon",
				"contentType" : "ap-mac",
				"format" : "ascii",
				"userDefinedText" : "xxx"
			},
			"remoteId" : {
				"connectorPattern" : "colon",
				"contentType" : "ap-mac",
				"format" : "ascii",
				"userDefinedText" : "xxx"
			}
		},
		"forwardMode" : "direct",
		"softgreProfileId" : "fbde1c5d-5b94-49e3-a912-48641015e45f",
		"configName" : "ssid-tmp-config-name",
		"phyProtection" : "security-priority"
	}
}

返回状态码为400:校验异常。

HTTP/1.1 400 Bad Request
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

返回状态码为500:内部服务错误。

HTTP/1.1 500 Internal Server Error
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容

提示

您即将访问非华为云网站,请注意账号财产安全