-
响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errmsg" : "",
"errcode" : "",
"successList" : [
{
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33"
}
],
"failList" : [
{
"errmsg" : "",
"errcode" : "0",
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33"
}
]
} 返回状态码为207:部分成功。 HTTP/1.1 207 Multi-Status
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errmsg" : "",
"errcode" : "",
"successList" : [
{
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33"
}
],
"failList" : [
{
"errmsg" : "",
"errcode" : "0",
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33"
}
]
} 返回状态码为400:校验异常或全部失败。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errmsg" : "",
"errcode" : "",
"successList" : [
{
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33"
}
],
"failList" : [
{
"errmsg" : "",
"errcode" : "0",
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33"
}
]
} 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 POST /v1/portal/authfree-macs/batch-delete HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
{
"authType" : 0,
"authFreeMacs" : [
{
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33"
}
]
}
-
响应参数 返回状态码为200:操作成功。 表4 DelResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string 0~256个字符。 错误信息。 - errcode string 0~64个字符。 0 错误码。 - successList ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 删除成功列表。 - failList ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 删除失败列表。 - 表5 DelAuthFreeMac对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 userName string 1~256个字符。 - 用户名,不支持模糊匹配。 "user1" terminalMac string 12~17个字符。 - 终端MAC,大小写不敏感,支持的格式:xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33" 表6 DeleteFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string 0~256个字符。 错误信息。 "" errcode string 0~64个字符。 0 错误码。 "0" userName string 0~256个字符。 - 用户名 "user1" terminalMac string 12~17个字符。 - 终端MAC "aa-bb-cc-11-22-33" 返回状态码为207:部分成功。 DelResponseDto对象的参数列表,详细请参见表4。 返回状态码为400:校验异常或全部失败。 DelResponseDto对象的参数列表,详细请参见表4。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 删除条件。 - 表2 DelAuthFreeMacDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 authType 否 int32 [0-1] - 认证类型: 0:haca 1:portal2.0 0 authFreeMacs 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 免认证MAC表项。 - 表3 DelAuthFreeMac对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 userName 否 string 1~256个字符。 - 用户名,不支持模糊匹配。 "user1" terminalMac 否 string 12~17个字符。 - 终端MAC,大小写不敏感,支持的格式:xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33"
-
响应示例 返回状态码为200:查询成功。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"pageIndex" : 1,
"pageSize" : 20,
"totalRecords" : 1000,
"authFreeMacs" : [
{
"userName" : "user1",
"terminalMac" : "aa-bb-cc-11-22-33",
"expireTime" : 1529648614575,
"ssid" : "CloudCampus_Guest",
"siteName" : "site1"
}
]
}
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 GET /v1/portal/authfree-macs?authType=0&userName=user1&terminalMac=aa-bb-cc-11-22-33&pageIndex=1&pageSize=20 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
-
响应参数 返回状态码为200:查询成功。 表2 GetResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 免认证MAC表项dto - 表3 MacDataOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [1-100000] - 页面索引。 1 pageSize int32 [20-100] - 页面大小。 20 totalRecords int32 [0-2000000] - 总数据量。 1000 authFreeMacs ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 免认证MAC表项响应dto - 表4 MacOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 userName string 1~256个字符。 - 用户名,不支持模糊匹配。 "user1" terminalMac string 12~17个字符。 - 终端MAC,大小写不敏感,支持的格式:xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33" expireTime int64 [0-35627788800000] - 免认证到期时间 时间戳单位:ms 1529648614575 ssid string 0~64个字符。 - 接入SSID。 "CloudCampus_Guest" siteName string 0~64个字符。 - 接入站点名称 "site1" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
URI /v1/portal/authfree-macs 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 authType 否 int32 [0-1] - 免认证的类型 0:haca 1:portal2.0 0 userName 否 string 1~256个字符。 - 用户名,不支持模糊匹配。 "user1" terminalMac 否 string 12~17个字符。 - 终端MAC,大小写不敏感,支持的格式:xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33" pageIndex 否 int32 [1-100000] 1 页面索引。 1 pageSize 否 int32 [20-100] 20 每页显示记录数。 20