创建RADIUS模板
典型场景
创建RADIUS模板。
接口功能
RADIUS模板创建接口。
接口约束
1、该接口支持租户视图或msp代维视图下,用户角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。
调用方法
POST
URI
/controller/campus/v1/networkservice/networkconfig/profile/radius
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
body |
是 |
REFERENCE |
详细请参见表2。 |
RADIUS服务器模板信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
name |
是 |
string |
1~32个字符。 |
- |
RADIUS模板名称不能包含特殊字符 ~ $ @ # & ? = + % * ( ) { } < > ] [ ^ ! , : ; ` ' / | \ ",不能使用中文字符,且不能单独以-或- -作为模板名称。 |
"radius1" |
description |
否 |
string |
0~256个字符。 |
- |
RADIUS模板描述。 |
"radius1" |
multipleBackupServerConfig |
否 |
boolean |
|
true |
是否启用多backup服务器配置。radius模板为三方模板时,是否选择多backup服务器配置。当multipleBackupServerConfig为true时,authServerList参数必填。当multipleBackupServerConfig为false时,masterAuthServer参数必填。该值只在更新和创建作为入参时生效;作为返回值时为无效参数,请忽略。 |
true |
radiusServerType |
否 |
string |
|
- |
radius服务器类型:thirdPartyServer(第三方)、builtInServer(内置)、hybridServer(混合) |
"thirdPartyServer" |
iaeDtoList |
否 |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表3。 |
IAE服务,当radiusServerType为builtInServer或hybridServer时必填。 |
- |
|
authServerList |
否 |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表4。 |
认证服务器列表。当multipleBackupServerConfig为true时,authServerList必填。 |
- |
|
accountServerList |
否 |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表5。 |
计费服务器列表。当multipleBackupServerConfig为true时,accountServerList必填。 |
- |
|
masterAuthServer |
是 |
REFERENCE |
详细请参见表6。 |
主认证服务器 |
- |
|
slaveAuthServer |
否 |
REFERENCE |
详细请参见表7。 |
副认证服务器 |
- |
|
masterAccountServer |
否 |
REFERENCE |
详细请参见表8。 |
主计费服务器 |
- |
|
slaveAccountServer |
否 |
REFERENCE |
详细请参见表9。 |
副计费服务器 |
- |
|
realtimeAccounting |
否 |
REFERENCE |
详细请参见表10。 |
实时计费 |
- |
|
serverSelectionPolicy |
否 |
string |
|
- |
服务器选择策略:master-backup(主备)、loading-share(负载均衡)。当multipleBackupServerConfig为true时,serverSelectionPolicy参数必填。 |
"master-backup" |
serverSelectionAlgorithm |
否 |
string |
|
- |
服务器选择算法:packets(基于报文数计算)、subscribers(基于用户数计算)。当multipleBackupServerConfig为true且服务器选择策略为loading-share(负载均衡)时,serverSelectionAlgorithm参数必填 |
"packets" |
dpskConfig |
否 |
REFERENCE |
详细请参见表11。 |
dpsk配置 |
- |
|
prohibitAttribute |
否 |
REFERENCE |
详细请参见表12。 |
禁止属性 |
- |
|
radiusAttributeConfig |
否 |
REFERENCE |
详细请参见表14。 |
RADIUS属性配置 |
- |
|
calledStationId |
否 |
REFERENCE |
详细请参见表16。 |
CALLED-STATION-ID |
- |
|
macFormatSetting |
否 |
REFERENCE |
详细请参见表17。 |
mac格式设置 |
- |
|
enableAutomaticServerStatusDetection |
否 |
boolean |
|
false |
是否配置服务器选择状态探测。当enableAutomaticServerStatusDetection为true时,automaticServerStatusDetection必填。 |
true |
automaticServerStatusDetection |
否 |
REFERENCE |
详细请参见表18。 |
自动服务器状态监测 |
- |
|
enableAuthRequestRetransmitConfig |
否 |
boolean |
|
false |
是否配置认证请求重传配置。当enableAuthRequestRetransmitConfig为true时,authRequestRetransmitConfig必填。 |
true |
authRequestRetransmitConfig |
否 |
REFERENCE |
详细请参见表19。 |
认证请求重传配置 |
- |
|
sourceIpEnable |
否 |
boolean |
|
- |
源IP配置使能 |
true |
nassPortIdFormat |
否 |
string |
|
- |
NAS-Port-Id属性封装的格式。修改模板时translateExtendList不为null,此项需必填。 |
"new" |
translateExtendList |
否 |
ARRAY_REFERENCE |
0-255个列表项,详细请参见表20。 |
RADIUS扩展属性转换列表。修改模板时translateExtendList为空列表且nassPortIdFormat为null时,第三方服务对接参数开关关闭。 |
- |
|
startAccountingFail |
否 |
boolean |
|
false |
计费逃生,true:允许,false:不允许。非必填,不填时为默认值false。在radiusServerType为thirdPartyServer时可以配置,否则只能为false或不填。 |
true |
configName |
否 |
string |
0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。 |
- |
配置名称标识,用于radius-server-name |
"abc" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
iaeId |
否 |
string |
36个字符。 |
- |
主远程IAE组件ID |
"ce67b74c-01ac-4e2a-81af-0908d98ea242" |
iaeName |
否 |
string |
1~256个字符。 |
- |
主远程IAE组件名称 |
"iae12" |
iaeIp |
否 |
string |
7~15个字符。 |
- |
主远程IAE组件IP地址 |
"192.168.1.1" |
iaeAd |
否 |
string |
1~256个字符。 |
- |
主ad domain,废弃字段,未使用。 |
"example.com" |
iaeIpv6 |
否 |
string |
1~256个字符。 |
- |
主ipv6地址 |
"FC00::0" |
weight |
否 |
int32 |
[0-100] |
- |
权重。 |
80 |
slaveIaeId |
否 |
string |
36个字符。 |
- |
备远程IAE组件ID,废弃字段,未使用。 |
"ce67b74c-01ac-4e2a-81af-0908d98ea242" |
slaveIaeName |
否 |
string |
1~256个字符。 |
- |
备远程IAE组件名称,废弃字段,未使用。 |
"iae12" |
slaveIaeIp |
否 |
string |
7~15个字符。 |
- |
备远程IAE组件IP地址,废弃字段,未使用。 |
"192.168.1.1" |
slaveIaeAd |
否 |
string |
1~256个字符。 |
- |
备ad domain,废弃字段,未使用。 |
"example.com" |
slaveIaeIpv6 |
否 |
string |
1~256个字符。 |
- |
备ipv6地址,废弃字段,未使用。 |
"FC00::0" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverAddressType |
否 |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写, 则默认为ip |
"ip" |
serverAddress |
是 |
string |
- |
- |
服务器IP地址或者域名。 |
"192.168.1.1" |
port |
是 |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
weight |
是 |
int32 |
[0-100] |
80 |
权重。weight值越大,认证服务器优先使用。 |
80 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverAddressType |
否 |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写, 则默认为ip |
"ip" |
serverAddress |
是 |
string |
- |
- |
服务器IP地址或者域名。 |
"192.168.1.1" |
port |
是 |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
weight |
是 |
int32 |
[0-100] |
80 |
权重。weight值越大,计费服务器优先使用。 |
80 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverAddressType |
否 |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
否 |
string |
- |
- |
服务器IP地址或者域名,创建时必填。 |
"192.168.1.1" |
port |
否 |
int32 |
[1-65535] |
- |
服务器端口,创建时必填。 |
10 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverAddressType |
否 |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
否 |
string |
- |
- |
服务器IP地址或者域名。PUT操作时,如果备认证服务器中该字段设置为空字符串"",则将备认证服务器设置为空。 |
"192.168.1.2" |
port |
否 |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverAddressType |
否 |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
否 |
string |
- |
- |
服务器IP地址或者域名。PUT操作时,如果主计费服务器中该字段设置为空字符串"",则将主计费服务器设置为空。 |
"192.168.1.1" |
port |
否 |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
serverAddressType |
否 |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
否 |
string |
- |
- |
服务器IP地址或者域名。PUT操作时,如果备计费服务器中该字段设置为空字符串"",则将备计费服务器设置为空。 |
"192.168.1.2" |
port |
否 |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
realtimeEnable |
否 |
boolean |
|
false |
是否设置实时计费,如果为true,必须配置实时计费周期,且先配置主计费服务器。创建时,若不填则默认值为false。 |
true |
realtimeInterval |
否 |
int32 |
[1-65535] |
- |
实时计费周期,单位是分钟,当realTimeEnable为true时必填。 |
10 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
supportDpsk |
否 |
boolean |
|
false |
是否开启dpsk功能,true:开启,false:不开启,默认为false。 |
true |
dpskEncryptionMode |
否 |
string |
|
- |
dpsk加密方式,未开启dpsk时,不传值,开启后,需传值。 |
"aes256gcm" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
enable |
否 |
boolean |
|
false |
是否启动RADIUS禁用属性功能,创建时,若不填则默认值为false。 |
true |
attributes |
否 |
ARRAY_REFERENCE |
0-100个列表项,详细请参见表13。 |
RADIUS禁用属性列表,当enable为true时生效。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
attributeName |
是 |
string |
- |
- |
RADIUS属性名称,包括IETF标准属性,华为和三方厂商扩展属性。 |
"HW-Input-Peak-Information-Rate" |
prohibitReceive |
是 |
boolean |
|
- |
禁用接收报文中的RADIUS属性。 |
true |
prohibitSend |
是 |
boolean |
|
- |
禁用发送报文中的RADIUS属性。 |
true |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
enable |
否 |
boolean |
|
false |
是否启动RADIUS属性设置功能,创建时,若不填则默认值为false。 |
true |
attributes |
否 |
ARRAY_REFERENCE |
0-1个列表项,详细请参见表15。 |
RADIUS属性设置列表,当enable为true时生效。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
attributeName |
是 |
string |
- |
- |
RADIUS属性名称,当前只能为Service-Type。 |
"Service-Type" |
attributeValue |
否 |
string |
- |
- |
RADIUS属性值。范围为1-2147483647,当attributeValue有值时,macValue,dot1xValue和portalValue不生效。 |
"241" |
optionValue |
否 |
string |
- |
- |
RADIUS属性选项,当前只能为auth-type-mac。当attributeValue有值时,optionValue才生效。 |
"auth-type-mac" |
macValue |
否 |
string |
- |
- |
MAC认证属性值。范围为1-2147483647,不能与portalValue重复,默认值10。 |
"10" |
dot1xValue |
否 |
string |
- |
- |
802.1x认证属性值。范围为1-2147483647,不能与portalValue重复,默认值2。 |
"2" |
portalValue |
否 |
string |
- |
- |
portal认证属性值。范围为1-2147483647,默认值4。 |
"4" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
enable |
否 |
boolean |
|
false |
是否设置called-station-id属性,创建时,若不填则默认值为false。 |
true |
attributeValue |
否 |
string |
- |
- |
called-station-id属性封装的内容,只能为ap-mac,ap-location,当enable为true时必填。 |
"ap-mac" |
includeSsid |
否 |
boolean |
|
false |
called-station-id属性封装内容是否包含SSID,当enable为true时生效,创建时,若不填则默认值为false。 |
true |
delimiter |
否 |
string |
- |
- |
called-station-id属性封装内容包含SSID时,SSID前的分隔符,取值范围:\ / : < > | @ ' % * + - & ! # ^ ~,只能是1位,当includeSsid为true时必填。 |
"+" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
macFormat |
否 |
boolean |
|
- |
是否设置MAC地址格式。当macFormat为true时,letter、connector、mode生效且必填;当macFormat为false时,mac的格式为XXXXXXXXXXXX。 |
true |
letter |
否 |
string |
- |
- |
MAC地址大小写,取值范围:uppercase、lowercase,当macFormat为true时,必填。 |
"uppercase" |
connector |
否 |
string |
- |
- |
MAC地址连接符,取值范围:hyphen-split(代表“-”)、dot-split(代表“.”)、colon-split(代表“:”)、unformatted(代表无连接符),当macFormat为true时为必填项。 |
"hyphen-split" |
mode |
否 |
string |
- |
- |
MAC地址格式,取值范围:XXXX、XX,当connector为unformatted时,mode不需要赋值,否则必填。 |
"XX" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
name |
是 |
string |
1~128个字符。 |
- |
自动探测用户名称,同一租户下的探测用户名称不能重复。 |
"test" |
password |
是 |
password |
1~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 用户密码(英文字母、数字、除空格、单引号和问号外特殊符号,且不能全为*,建议长度为8位以上)。 |
"null" |
upServerInterval |
否 |
int32 |
[600-3600] |
- |
Up状态自动探测周期。单位:秒。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
timeoutRetransmissionTimes |
是 |
int32 |
[1-5] |
- |
超时重传次数。 |
3 |
timeoutInterval |
是 |
int32 |
[1-10] |
- |
超时时间。单位:秒。 |
5 |
serverDownDuration |
是 |
int32 |
[1-65535] |
- |
服务器Down持续时间。单位:分钟。 |
5 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
accessAccept |
是 |
boolean |
|
- |
是否对认证接受报文进行RADIUS属性转换,此开关与accountResponse开关至少有一个要打开 |
true |
accountResponse |
是 |
boolean |
|
- |
是否对计费响应报文进行RADIUS属性转换,此开关与accountAccept开关至少有一个要打开 |
false |
srcVendorId |
是 |
int32 |
[1-65535] |
- |
转换的RADIUS扩展属性的厂商ID。当前仅支持9。 |
9 |
srcSubId |
是 |
int32 |
[1-255] |
- |
转换的RADIUS属性的子属性编号,取值范围是1,2,23-33,35,36,101-117,141-150,187-198,208-210,212,217,218,233-235,242-244,250-253,255 |
2 |
destAttributeName |
是 |
string |
- |
- |
转换的目的属性名称 |
"HW-Input-Committed-Burst-Size" |
请求示例
POST /controller/campus/v1/networkservice/networkconfig/profile/radius 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" : "radius1", "description" : "radius1", "multipleBackupServerConfig" : true, "radiusServerType" : "thirdPartyServer", "iaeDtoList" : [ { "iaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "iaeName" : "iae12", "iaeIp" : "192.168.1.1", "iaeAd" : "example.com", "iaeIpv6" : "FC00::0", "weight" : 80, "slaveIaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "slaveIaeName" : "iae12", "slaveIaeIp" : "192.168.1.1", "slaveIaeAd" : "example.com", "slaveIaeIpv6" : "FC00::0" } ], "authServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "accountServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "masterAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "masterAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "realtimeAccounting" : { "realtimeEnable" : true, "realtimeInterval" : 10 }, "serverSelectionPolicy" : "master-backup", "serverSelectionAlgorithm" : "packets", "dpskConfig" : { "supportDpsk" : true, "dpskEncryptionMode" : "aes256gcm" }, "prohibitAttribute" : { "enable" : true, "attributes" : [ { "attributeName" : "HW-Input-Peak-Information-Rate", "prohibitReceive" : true, "prohibitSend" : true } ] }, "radiusAttributeConfig" : { "enable" : true, "attributes" : [ { "attributeName" : "Service-Type", "attributeValue" : "241", "optionValue" : "auth-type-mac", "macValue" : "10", "dot1xValue" : "2", "portalValue" : "4" } ] }, "calledStationId" : { "enable" : true, "attributeValue" : "ap-mac", "includeSsid" : true, "delimiter" : "+" }, "macFormatSetting" : { "macFormat" : true, "letter" : "uppercase", "connector" : "hyphen-split", "mode" : "XX" }, "enableAutomaticServerStatusDetection" : true, "automaticServerStatusDetection" : { "name" : "test", "password" : "null", "upServerInterval" : "" }, "enableAuthRequestRetransmitConfig" : true, "authRequestRetransmitConfig" : { "timeoutRetransmissionTimes" : 3, "timeoutInterval" : 5, "serverDownDuration" : 5 }, "sourceIpEnable" : true, "nassPortIdFormat" : "new", "translateExtendList" : [ { "accessAccept" : true, "accountResponse" : false, "srcVendorId" : 9, "srcSubId" : 2, "destAttributeName" : "HW-Input-Committed-Burst-Size" } ], "startAccountingFail" : true, "configName" : "abc", "shareKey" : "null" }
响应参数
返回状态码为201:成功创建的RADIUS模板信息。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
- |
- |
错误码。 |
"0" |
errmsg |
string |
- |
- |
错误信息。 |
"" |
data |
REFERENCE |
详细请参见表22。 |
RADIUS模板返回结构体 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
name |
string |
1~32个字符。 |
- |
RADIUS模板名称不能包含特殊字符 ~ $ @ # & ? = + % * ( ) { } < > ] [ ^ ! , : ; ` ' / | \ ",不能使用中文字符,且不能单独以-或- -作为模板名称。 |
"radius1" |
description |
string |
0~256个字符。 |
- |
RADIUS模板描述。 |
"radius1" |
multipleBackupServerConfig |
boolean |
|
true |
是否启用多backup服务器配置。radius模板为三方模板时,是否选择多backup服务器配置。当multipleBackupServerConfig为true时,authServerList参数必填。当multipleBackupServerConfig为false时,masterAuthServer参数必填。该值只在更新和创建作为入参时生效;作为返回值时为无效参数,请忽略。 |
true |
radiusServerType |
string |
|
- |
radius服务器类型:thirdPartyServer(第三方)、builtInServer(内置)、hybridServer(混合) |
"thirdPartyServer" |
iaeDtoList |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表23。 |
IAE服务,当radiusServerType为builtInServer或hybridServer时必填。 |
- |
|
authServerList |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表24。 |
认证服务器列表。当multipleBackupServerConfig为true时,authServerList必填。 |
- |
|
accountServerList |
ARRAY_REFERENCE |
0-8个列表项,详细请参见表25。 |
计费服务器列表。当multipleBackupServerConfig为true时,accountServerList必填。 |
- |
|
masterAuthServer |
REFERENCE |
详细请参见表26。 |
主认证服务器 |
- |
|
slaveAuthServer |
REFERENCE |
详细请参见表27。 |
副认证服务器 |
- |
|
masterAccountServer |
REFERENCE |
详细请参见表28。 |
主计费服务器 |
- |
|
slaveAccountServer |
REFERENCE |
详细请参见表29。 |
副计费服务器 |
- |
|
realtimeAccounting |
REFERENCE |
详细请参见表30。 |
实时计费 |
- |
|
serverSelectionPolicy |
string |
|
- |
服务器选择策略:master-backup(主备)、loading-share(负载均衡)。当multipleBackupServerConfig为true时,serverSelectionPolicy参数必填。 |
"master-backup" |
serverSelectionAlgorithm |
string |
|
- |
服务器选择算法:packets(基于报文数计算)、subscribers(基于用户数计算)。当multipleBackupServerConfig为true且服务器选择策略为loading-share(负载均衡)时,serverSelectionAlgorithm参数必填 |
"packets" |
dpskConfig |
REFERENCE |
详细请参见表31。 |
dpsk配置 |
- |
|
prohibitAttribute |
REFERENCE |
详细请参见表32。 |
禁止属性 |
- |
|
radiusAttributeConfig |
REFERENCE |
详细请参见表34。 |
RADIUS属性配置 |
- |
|
calledStationId |
REFERENCE |
详细请参见表36。 |
CALLED-STATION-ID |
- |
|
macFormatSetting |
REFERENCE |
详细请参见表37。 |
mac格式设置 |
- |
|
enableAutomaticServerStatusDetection |
boolean |
|
false |
是否配置服务器选择状态探测。当enableAutomaticServerStatusDetection为true时,automaticServerStatusDetection必填。 |
true |
automaticServerStatusDetection |
REFERENCE |
详细请参见表38。 |
自动服务器状态监测 |
- |
|
enableAuthRequestRetransmitConfig |
boolean |
|
false |
是否配置认证请求重传配置。当enableAuthRequestRetransmitConfig为true时,authRequestRetransmitConfig必填。 |
true |
authRequestRetransmitConfig |
REFERENCE |
详细请参见表39。 |
认证请求重传配置 |
- |
|
sourceIpEnable |
boolean |
|
- |
源IP配置使能 |
true |
nassPortIdFormat |
string |
|
- |
NAS-Port-Id属性封装的格式。修改模板时translateExtendList不为null,此项需必填。 |
"new" |
translateExtendList |
ARRAY_REFERENCE |
0-255个列表项,详细请参见表40。 |
RADIUS扩展属性转换列表。修改模板时translateExtendList为空列表且nassPortIdFormat为null时,第三方服务对接参数开关关闭。 |
- |
|
startAccountingFail |
boolean |
|
false |
计费逃生,true:允许,false:不允许。非必填,不填时为默认值false。在radiusServerType为thirdPartyServer时可以配置,否则只能为false或不填。 |
true |
configName |
string |
0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。 |
- |
配置名称标识,用于radius-server-name |
"abc" |
id |
string |
- |
- |
RADIUS模板ID,UUID格式。 |
"fbb684c8-0d37-496f-bafa-4b06db151e2e" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
iaeId |
string |
36个字符。 |
- |
主远程IAE组件ID |
"ce67b74c-01ac-4e2a-81af-0908d98ea242" |
iaeName |
string |
1~256个字符。 |
- |
主远程IAE组件名称 |
"iae12" |
iaeIp |
string |
7~15个字符。 |
- |
主远程IAE组件IP地址 |
"192.168.1.1" |
iaeAd |
string |
1~256个字符。 |
- |
主ad domain,废弃字段,未使用。 |
"example.com" |
iaeIpv6 |
string |
1~256个字符。 |
- |
主ipv6地址 |
"FC00::0" |
weight |
int32 |
[0-100] |
- |
权重。 |
80 |
slaveIaeId |
string |
36个字符。 |
- |
备远程IAE组件ID,废弃字段,未使用。 |
"ce67b74c-01ac-4e2a-81af-0908d98ea242" |
slaveIaeName |
string |
1~256个字符。 |
- |
备远程IAE组件名称,废弃字段,未使用。 |
"iae12" |
slaveIaeIp |
string |
7~15个字符。 |
- |
备远程IAE组件IP地址,废弃字段,未使用。 |
"192.168.1.1" |
slaveIaeAd |
string |
1~256个字符。 |
- |
备ad domain,废弃字段,未使用。 |
"example.com" |
slaveIaeIpv6 |
string |
1~256个字符。 |
- |
备ipv6地址,废弃字段,未使用。 |
"FC00::0" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverAddressType |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写, 则默认为ip |
"ip" |
serverAddress |
string |
- |
- |
服务器IP地址或者域名。 |
"192.168.1.1" |
port |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
weight |
int32 |
[0-100] |
80 |
权重。weight值越大,认证服务器优先使用。 |
80 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverAddressType |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写, 则默认为ip |
"ip" |
serverAddress |
string |
- |
- |
服务器IP地址或者域名。 |
"192.168.1.1" |
port |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
weight |
int32 |
[0-100] |
80 |
权重。weight值越大,计费服务器优先使用。 |
80 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverAddressType |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
string |
- |
- |
服务器IP地址或者域名,创建时必填。 |
"192.168.1.1" |
port |
int32 |
[1-65535] |
- |
服务器端口,创建时必填。 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverAddressType |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
string |
- |
- |
服务器IP地址或者域名。PUT操作时,如果备认证服务器中该字段设置为空字符串"",则将备认证服务器设置为空。 |
"192.168.1.2" |
port |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverAddressType |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
string |
- |
- |
服务器IP地址或者域名。PUT操作时,如果主计费服务器中该字段设置为空字符串"",则将主计费服务器设置为空。 |
"192.168.1.1" |
port |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
serverAddressType |
string |
0~10个字符。满足正则表达ip|domain。 |
ip |
服务器地址类型,如果不填写,则默认为ip |
"ip" |
serverAddress |
string |
- |
- |
服务器IP地址或者域名。PUT操作时,如果备计费服务器中该字段设置为空字符串"",则将备计费服务器设置为空。 |
"192.168.1.2" |
port |
int32 |
[1-65535] |
- |
服务器端口。 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
realtimeEnable |
boolean |
|
false |
是否设置实时计费,如果为true,必须配置实时计费周期,且先配置主计费服务器。创建时,若不填则默认值为false。 |
true |
realtimeInterval |
int32 |
[1-65535] |
- |
实时计费周期,单位是分钟,当realTimeEnable为true时必填。 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
supportDpsk |
boolean |
|
false |
是否开启dpsk功能,true:开启,false:不开启,默认为false。 |
true |
dpskEncryptionMode |
string |
|
- |
dpsk加密方式,未开启dpsk时,不传值,开启后,需传值。 |
"aes256gcm" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
enable |
boolean |
|
false |
是否启动RADIUS禁用属性功能,创建时,若不填则默认值为false。 |
true |
attributes |
ARRAY_REFERENCE |
0-100个列表项,详细请参见表33。 |
RADIUS禁用属性列表,当enable为true时生效。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
attributeName |
string |
- |
- |
RADIUS属性名称,包括IETF标准属性,华为和三方厂商扩展属性。 |
"HW-Input-Peak-Information-Rate" |
prohibitReceive |
boolean |
|
- |
禁用接收报文中的RADIUS属性。 |
true |
prohibitSend |
boolean |
|
- |
禁用发送报文中的RADIUS属性。 |
true |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
enable |
boolean |
|
false |
是否启动RADIUS属性设置功能,创建时,若不填则默认值为false。 |
true |
attributes |
ARRAY_REFERENCE |
0-1个列表项,详细请参见表35。 |
RADIUS属性设置列表,当enable为true时生效。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
attributeName |
string |
- |
- |
RADIUS属性名称,当前只能为Service-Type。 |
"Service-Type" |
attributeValue |
string |
- |
- |
RADIUS属性值。范围为1-2147483647,当attributeValue有值时,macValue,dot1xValue和portalValue不生效。 |
"241" |
optionValue |
string |
- |
- |
RADIUS属性选项,当前只能为auth-type-mac。当attributeValue有值时,optionValue才生效。 |
"auth-type-mac" |
macValue |
string |
- |
- |
MAC认证属性值。范围为1-2147483647,不能与portalValue重复,默认值10。 |
"10" |
dot1xValue |
string |
- |
- |
802.1x认证属性值。范围为1-2147483647,不能与portalValue重复,默认值2。 |
"2" |
portalValue |
string |
- |
- |
portal认证属性值。范围为1-2147483647,默认值4。 |
"4" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
enable |
boolean |
|
false |
是否设置called-station-id属性,创建时,若不填则默认值为false。 |
true |
attributeValue |
string |
- |
- |
called-station-id属性封装的内容,只能为ap-mac,ap-location,当enable为true时必填。 |
"ap-mac" |
includeSsid |
boolean |
|
false |
called-station-id属性封装内容是否包含SSID,当enable为true时生效,创建时,若不填则默认值为false。 |
true |
delimiter |
string |
- |
- |
called-station-id属性封装内容包含SSID时,SSID前的分隔符,取值范围:\ / : < > | @ ' % * + - & ! # ^ ~,只能是1位,当includeSsid为true时必填。 |
"+" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
macFormat |
boolean |
|
- |
是否设置MAC地址格式。当macFormat为true时,letter、connector、mode生效且必填;当macFormat为false时,mac的格式为XXXXXXXXXXXX。 |
true |
letter |
string |
- |
- |
MAC地址大小写,取值范围:uppercase、lowercase,当macFormat为true时,必填。 |
"uppercase" |
connector |
string |
- |
- |
MAC地址连接符,取值范围:hyphen-split(代表“-”)、dot-split(代表“.”)、colon-split(代表“:”)、unformatted(代表无连接符),当macFormat为true时为必填项。 |
"hyphen-split" |
mode |
string |
- |
- |
MAC地址格式,取值范围:XXXX、XX,当connector为unformatted时,mode不需要赋值,否则必填。 |
"XX" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
name |
string |
1~128个字符。 |
- |
自动探测用户名称,同一租户下的探测用户名称不能重复。 |
"test" |
password |
password |
1~128个字符。 |
- |
该字段可能包含敏感信息和个人数据,请妥善做好保护。 用户密码(英文字母、数字、除空格、单引号和问号外特殊符号,且不能全为*,建议长度为8位以上)。 |
"null" |
upServerInterval |
int32 |
[600-3600] |
- |
Up状态自动探测周期。单位:秒。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
timeoutRetransmissionTimes |
int32 |
[1-5] |
- |
超时重传次数。 |
3 |
timeoutInterval |
int32 |
[1-10] |
- |
超时时间。单位:秒。 |
5 |
serverDownDuration |
int32 |
[1-65535] |
- |
服务器Down持续时间。单位:分钟。 |
5 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
accessAccept |
boolean |
|
- |
是否对认证接受报文进行RADIUS属性转换,此开关与accountResponse开关至少有一个要打开 |
true |
accountResponse |
boolean |
|
- |
是否对计费响应报文进行RADIUS属性转换,此开关与accountAccept开关至少有一个要打开 |
false |
srcVendorId |
int32 |
[1-65535] |
- |
转换的RADIUS扩展属性的厂商ID。当前仅支持9。 |
9 |
srcSubId |
int32 |
[1-255] |
- |
转换的RADIUS属性的子属性编号,取值范围是1,2,23-33,35,36,101-117,141-150,187-198,208-210,212,217,218,233-235,242-244,250-253,255 |
2 |
destAttributeName |
string |
- |
- |
转换的目的属性名称 |
"HW-Input-Committed-Burst-Size" |
返回状态码为400:校验异常。
详细信息请参见实际响应消息体。
返回状态码为500:内部服务错误。
详细信息请参见实际响应消息体。
响应示例
返回状态码为201:成功创建的RADIUS模板信息。
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" : { "name" : "radius1", "description" : "radius1", "multipleBackupServerConfig" : true, "radiusServerType" : "thirdPartyServer", "iaeDtoList" : [ { "iaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "iaeName" : "iae12", "iaeIp" : "192.168.1.1", "iaeAd" : "example.com", "iaeIpv6" : "FC00::0", "weight" : 80, "slaveIaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "slaveIaeName" : "iae12", "slaveIaeIp" : "192.168.1.1", "slaveIaeAd" : "example.com", "slaveIaeIpv6" : "FC00::0" } ], "authServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "accountServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "masterAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "masterAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "realtimeAccounting" : { "realtimeEnable" : true, "realtimeInterval" : 10 }, "serverSelectionPolicy" : "master-backup", "serverSelectionAlgorithm" : "packets", "dpskConfig" : { "supportDpsk" : true, "dpskEncryptionMode" : "aes256gcm" }, "prohibitAttribute" : { "enable" : true, "attributes" : [ { "attributeName" : "HW-Input-Peak-Information-Rate", "prohibitReceive" : true, "prohibitSend" : true } ] }, "radiusAttributeConfig" : { "enable" : true, "attributes" : [ { "attributeName" : "Service-Type", "attributeValue" : "241", "optionValue" : "auth-type-mac", "macValue" : "10", "dot1xValue" : "2", "portalValue" : "4" } ] }, "calledStationId" : { "enable" : true, "attributeValue" : "ap-mac", "includeSsid" : true, "delimiter" : "+" }, "macFormatSetting" : { "macFormat" : true, "letter" : "uppercase", "connector" : "hyphen-split", "mode" : "XX" }, "enableAutomaticServerStatusDetection" : true, "automaticServerStatusDetection" : { "name" : "test", "password" : "null", "upServerInterval" : "" }, "enableAuthRequestRetransmitConfig" : true, "authRequestRetransmitConfig" : { "timeoutRetransmissionTimes" : 3, "timeoutInterval" : 5, "serverDownDuration" : 5 }, "sourceIpEnable" : true, "nassPortIdFormat" : "new", "translateExtendList" : [ { "accessAccept" : true, "accountResponse" : false, "srcVendorId" : 9, "srcSubId" : 2, "destAttributeName" : "HW-Input-Committed-Burst-Size" } ], "startAccountingFail" : true, "configName" : "abc", "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e" } }
返回状态码为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