-
请求示例 HTTP的示例 POST /controller/campus/api/v1/networkconfig/apmesh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/mesh 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
{
"name" : "apmesh",
"radio2point4gEnable" : false,
"radio5gEnable" : false,
"radio5gSecondEnable" : false,
"scene" : "single",
"maxLinkNum" : 32,
"meshRouteAgingTime" : 5,
"memberDeviceInfos" : [
{
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"meshConfigRole" : "mpp",
"meshRouteAgingTime" : 5
}
],
"whiteListEnable" : false,
"whiteList" : [
"XX:XX:XX:XX:XX:XX"
],
"vlan" : "1"
}
-
响应示例 返回状态码为201：站点内创建Apmesh配置成功后的消息返回体。 HTTP/1.1 201 Created
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"meshId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "apmesh",
"radio2point4gEnable" : false,
"radio5gEnable" : false,
"radio5gSecondEnable" : false,
"scene" : "single",
"maxLinkNum" : 32,
"meshRouteAgingTime" : 5,
"whiteListEnable" : false,
"whiteList" : [
"XX:XX:XX:XX:XX:XX"
],
"vlan" : "1",
"memberDeviceInfos" : [
{
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"deviceEsn" : "AA02353VUTFIOJNKGG13",
"deviceStatus" : 3,
"deviceMeshRole" : "mpp",
"meshConfigRole" : "mpp",
"meshRouteAgingTime" : 5
}
]
}
} 返回状态码为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
-
响应示例 返回状态码为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,
"totalPage" : 10,
"totalRecords" : 10,
"QueryDeviceInfo" : [
{
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"deviceEsn" : "AA02353VUTFIOJNKGG13",
"deviceStatus" : 3,
"deviceMeshRole" : "mpp",
"meshConfigRole" : "mpp",
"meshId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"meshName" : "apmesh"
}
]
}
} 返回状态码为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
-
URI /controller/campus/api/v1/networkconfig/apmesh/sites/{siteId}/devices 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 filterCondition 是 string all inMesh notInMesh - 过滤条件。inMesh表示查询已加入Apmesh的设备。notInMesh表示查询未加入Apmesh的设备。all表示查询所有支持mesh功能的AP设备。 "all" pageIndex 是 int32 [1-65535] - 页面索引。 1 pageSize 是 int32 [1-100] - 每页显示记录数。 20
-
请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/apmesh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/devices?filterCondition=all&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：查询成功。 表3 QueryDeviceDtos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 站点内设备信息结构体 - 表4 QueryDeviceInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [1-65535] - 页面索引。 1 pageSize int32 [1-100] - 每页显示记录数。 20 totalPage int32 [1-65535] - 总页数。 10 totalRecords int32 [1-65535] - 总记录数。 10 QueryDeviceInfo ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 站点内设备信息结构体。 - 表5 QueryDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceName string 0~64个字符。 - 设备名称。 "AirEngine6760R-51_FBF792C3" deviceId string 36个字符。 - 设备Id。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceEsn string 20个字符。 - 设备esn。 "AA02353VUTFIOJNKGG13" deviceStatus int32 [0-5] - 设备状态。0 正常 1 告警 3 错误 4 未注册 3 deviceMeshRole string 0~64个字符。 - 设备上报的Mesh角色 mpp或者mp。 "mpp" meshConfigRole string 0~64个字符。 - Mesh配置角色 mpp或者mp。 "mpp" meshId string 36个字符。 - Apmesh唯一标识, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" meshName string 1~30个字符。 - Apmesh名称。 "apmesh" 返回状态码为400：校验失败。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：查询成功。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"pageIndex" : 1,
"pageSize" : 20,
"totalPage" : 10,
"totalRecords" : 10,
"ApmeshList" : [
{
"meshId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "apmesh",
"radio2point4gEnable" : false,
"radio5gEnable" : false,
"radio5gSecondEnable" : false,
"scene" : "single",
"maxLinkNum" : 32,
"meshRouteAgingTime" : 5,
"whiteListEnable" : false,
"whiteList" : [
"XX:XX:XX:XX:XX:XX"
],
"vlan" : "1",
"memberDeviceInfos" : [
{
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"deviceEsn" : "AA02353VUTFIOJNKGG13",
"deviceStatus" : 3,
"deviceMeshRole" : "mpp",
"meshConfigRole" : "mpp",
"meshRouteAgingTime" : 5
}
]
}
]
}
} 返回状态码为400：校验失败。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/apmesh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/mesh?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
-
URI /controller/campus/api/v1/networkconfig/apmesh/sites/{siteId}/mesh 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [1-65535] - 页面索引。 1 pageSize 是 int32 [1-100] - 每页显示记录数。 20
-
响应参数 返回状态码为200：查询成功。 表3 ApmeshGetResponseDtos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 apmesh数据结构。 - 表4 ApmeshResponseList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [1-65535] - 页面索引。 1 pageSize int32 [1-100] - 每页显示记录数。 20 totalPage int32 [1-65535] - 总页数。 10 totalRecords int32 [1-65535] - 总记录数。 10 ApmeshList ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 Apmesh配置。 - 返回状态码为400：校验失败。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：修改成功。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : ""
} 返回状态码为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
-
请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 connectkey 是 REFERENCE 详细请参见表3。 Mesh密钥。 - 表3 ConnectkeyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 meshPassword 是 password 8~63个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 Mesh密钥。密钥要求为8~63位数字、英文字母以及除问号与空格外的特殊字符的组合只能包含以下字符中的一种或者多种：小写字母、大写字母、数字、特殊字符，并且首尾不能是双引号不能含有全角字符，不能全为* "examplepassword"
-
请求示例 HTTP的示例 PUT /controller/campus/api/v1/networkconfig/apmesh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/connectkey 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
{
"meshPassword" : "examplepassword"
}
-
响应示例 返回状态码为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" : "",
"success" : [
{
"id" : "b0ce6863-cf72-4a9a-aad2-04b1131f18ef",
"name" : "example",
"description" : "test"
}
],
"fail" : {
"errcode" : "0x00c80014",
"errmsg" : "The id does not exist.",
"data" : [
{
"id" : "b0ce6863-cf72-4a9a-aad2-04b1131f18ef",
"name" : "example",
"description" : "test"
}
]
}
} 返回状态码为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
-
响应参数 返回状态码为200：删除成功。 表4 ApmeshDeleteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-64个列表项，详细请参见表5。 删除成功的Apmesh配置。 - fail REFERENCE 详细请参见表6。 删除失败的Apmesh配置 - 表5 DeleteApmeshInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 36个字符。 - Apmesh id。 "b0ce6863-cf72-4a9a-aad2-04b1131f18ef" name string 0~128个字符。 - 名称。 "example" description string 0~128个字符。 - 描述。 "test" 表6 ApmeshDeleteResponseFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0x00c80014" errmsg string 0~256个字符。 - 错误信息。 "The id does not exist." data ARRAY_REFERENCE 0-64个列表项，详细请参见表5。 删除apmesh返回体 - 返回状态码为400：校验失败。 详细信息请参见实际响应消息体。
