-
响应示例 返回状态码为200：查询AP VPN成功，响应体参考GetApVpnResponseDto。 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" : "",
"vpnList" : [
{
"id" : "e4d2b0e95bb94ef0a75b6a530d0b41be",
"ipsecConnectionName" : "vpn1",
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"peerAddress" : "192.168.1.1" ,
"localIdType" : "ip",
"localIdValue" : "myhost.example.com",
"refinedAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"filterAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a",
"preSharedKey" : "IAm@example"
}
],
"pageIndex" : 1,
"pageSize" : 1,
"total" : 1
} 返回状态码为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 /controller/campus/api/v1/networkconfig/apvpn/site/fbb684c8-0d37-496f-bafa-4b06d5151e2e/apvpn?pageIndex=1&pageSize=1 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
-
URI /controller/campus/api/v1/networkconfig/apvpn/site/{siteId}/apvpn 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-100] 1 第几页的数据。 1 pageSize 否 int32 [1-100] 20 一页多少条数据。 1
-
响应示例 返回状态码为200：删除AP VPN配置成功，响应体参考DeleteApVpnResponseDto。 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" : "e4d2b0e95bb94ef0a75b6a530d0b41be",
"name" : "apvpn",
"description" : "The VPN policy not exists."
}
],
"fail" : [
{
"id" : "e4d2b0e95bb94ef0a75b6a530d0b41be",
"name" : "apvpn",
"description" : "The VPN policy not exists."
}
]
} 返回状态码为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
-
响应参数 返回状态码为200：删除AP VPN配置成功，响应体参考DeleteApVpnResponseDto。 表3 DeleteApVpnResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 删除AP VPN成功列表。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 删除AP VPN失败列表。 - 表4 ApVpnBaseInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32个字符。 - VPNid。 "e4d2b0e95bb94ef0a75b6a530d0b41be" name string 1~94个字符。 - VPN名称。 "apvpn" description string 1~256个字符。 - 删除结果描述信息。 "The VPN policy not exists." 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/api/v1/networkconfig/apvpn 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
{
"id" : "e4d2b0e95bb94ef0a75b6a530d0b41be",
"ipsecConnectionName" : "vpn1",
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"peerAddress" : "192.168.1.1" ,
"localIdType" : "ip",
"localIdValue" : "myhost.example.com",
"refinedAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"filterAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a",
"preSharedKey" : "IAm@example"
}
-
响应示例 返回状态码为201：创建AP VPN配置成功，响应体参考ApVpnResponseDto。 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" : {
"id" : "e4d2b0e95bb94ef0a75b6a530d0b41be",
"ipsecConnectionName" : "vpn1",
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"peerAddress" : "192.168.1.1" ,
"localIdType" : "ip",
"localIdValue" : "myhost.example.com",
"refinedAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"filterAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a",
"preSharedKey" : "IAm@example"
}
} 返回状态码为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的示例 PUT /controller/campus/api/v1/networkconfig/apvpn 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
{
"id" : "e4d2b0e95bb94ef0a75b6a530d0b41be",
"ipsecConnectionName" : "vpn1",
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"peerAddress" : "192.168.1.1" ,
"localIdType" : "ip",
"localIdValue" : "myhost.example.com",
"refinedAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"filterAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a",
"preSharedKey" : "IAm@example"
}
-
响应示例 返回状态码为200：修改AP VPN配置成功，响应体参考ApVpnResponseDto。 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" : {
"id" : "e4d2b0e95bb94ef0a75b6a530d0b41be",
"ipsecConnectionName" : "vpn1",
"deviceName" : "AirEngine6760R-51_FBF792C3",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"peerAddress" : "192.168.1.1" ,
"localIdType" : "ip",
"localIdValue" : "myhost.example.com",
"refinedAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"filterAcl" : [
{
"priority" : 1,
"action" : true,
"protocol" : "tcp",
"sourceIp" : "192.168.1.0/24",
"sourceIpPort" : "1000",
"desIp" : "192.168.1.0/24",
"port" : "1000",
"description" : "acl信息"
}
],
"ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a",
"preSharedKey" : "IAm@example"
}
} 返回状态码为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
