-
URI /controller/campus/api/v1/networkconfig/loopback/site/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d6151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 filter 否 string 0~256个字符。 - 过滤条件。需要标注设备类型为AP "deviceType::AP|pageIndex::1|pageSize::20|keyWord::1"
-
请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/loopback/site/fbb684c8-0d37-496f-bafa-4b06d6151e2e?filter=deviceType::AP|pageIndex::1|pageSize::20|keyWord::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
-
响应示例 返回状态码为200:查询Loopback成功,响应体参考GetLoopbackResponseDto。 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" : {
"loopbackConfigList" : [
{
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"id" : "fbb684c80d37496fbafa4b06d5151e2e",
"deviceName" : "device1",
"esn" : "1019A063325",
"nameAllocMode" : "manual",
"loopBackName" : "LoopBack1",
"ipAddress" : "192.168.0.1",
"mask" : 24,
"description" : "description"
}
],
"pageIndex" : 1,
"pageSize" : 1,
"totalRecords" : 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
-
响应示例 返回状态码为200:接口调用成功,响应体参考LoopbackResponse。 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" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"wanLinkId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"interfaceName" : "LoopBack601",
"ipAddress" : "10.1.1.1",
"prefixLength" : 24,
"deviceName" : "device1"
}
],
"fail" : [
{
"errcode" : "1",
"errmsg" : "",
"data" : {
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"wanLinkId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"interfaceName" : "LoopBack601",
"ipAddress" : "10.1.1.1",
"prefixLength" : 24,
"deviceName" : "device1"
}
}
]
} 返回状态码为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/v1/sdwan/net/loopbacks 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
{
"Loopbacks" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"wanLinkId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"interfaceName" : "LoopBack601",
"ipAddress" : "10.1.1.1",
"prefixLength" : 24,
"deviceName" : "device1"
}
]
}
-
响应示例 返回状态码为200:修改Loopback配置成功,响应体参考LoopbackResponseDto。 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" : {
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"id" : "fbb684c80d37496fbafa4b06d5151e2e",
"deviceName" : "device1",
"esn" : "1019A063325",
"nameAllocMode" : "manual",
"loopBackName" : "LoopBack1",
"ipAddress" : "192.168.0.1",
"mask" : 24,
"description" : "description"
}
} 返回状态码为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/loopback/device/fbb684c8-0d37-496f-bafa-4b06d5151e2e 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
{
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"id" : "fbb684c80d37496fbafa4b06d5151e2e",
"deviceName" : "device1",
"esn" : "1019A063325",
"nameAllocMode" : "manual",
"loopBackName" : "LoopBack1",
"ipAddress" : "192.168.0.1",
"mask" : 24,
"description" : "description"
}
-
URI /controller/campus/v1/sdwan/net/loopbacks 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 端口ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" pageIndex 否 int32 - 1 当前页数,默认是1。 1 pageSize 否 int32 - 20 每页显示数量,默认是20。 20 vpnId 否 uuid - - VPN Id,UUID格式。 "00000000-0000-0000-0000-000000000000" siteId 否 uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" keyWord 否 string - - 查询关键字。 "LoopBack200"
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/loopbacks?id=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&pageIndex=1&pageSize=20&vpnId=00000000-0000-0000-0000-000000000000&siteId=00000000-0000-0000-0000-000000000000&keyWord=LoopBack200 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:接口调用成功,响应体参考QueryLoopbackResponse。 表2 QueryLoopbackResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码:0 表示接口执行成功,非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 分页数。 20 pageIndex int32 - - 当前页数 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 端口信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:接口调用成功,响应体参考QueryLoopbackResponse。 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" : "",
"totalRecords" : 200,
"pageSize" : 20,
"pageIndex" : 1,
"data" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"wanLinkId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"deviceId" : "00000000-0000-0000-0000-000000000000",
"interfaceName" : "LoopBack601",
"ipAddress" : "10.1.1.1",
"prefixLength" : 24,
"deviceName" : "device1"
}
]
} 返回状态码为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:创建Loopback配置成功,响应体参考,返回结构体参见LoopbackResponseDtoLoopbackResponseDto。 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" : {
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"id" : "fbb684c80d37496fbafa4b06d5151e2e",
"deviceName" : "device1",
"esn" : "1019A063325",
"nameAllocMode" : "manual",
"loopBackName" : "LoopBack1",
"ipAddress" : "192.168.0.1",
"mask" : 24,
"description" : "description"
}
} 返回状态码为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的示例 POST /controller/campus/api/v1/networkconfig/loopback/device/fbb684c8-0d37-496f-bafa-4b06d5151e2e 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
{
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"id" : "fbb684c80d37496fbafa4b06d5151e2e",
"deviceName" : "device1",
"esn" : "1019A063325",
"nameAllocMode" : "manual",
"loopBackName" : "LoopBack1",
"ipAddress" : "192.168.0.1",
"mask" : 24,
"description" : "description"
}
-
响应参数 返回状态码为200:创建Loopback配置成功,响应体参考,返回结构体参见LoopbackResponseDtoLoopbackResponseDto。 表4 LoopbackResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 描述,一个中文占三个字符,结构体参见LoopbackDto。 - 表5 LoopbackDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" id string 32~36个字符。 - Loopback的id。创建时无需填写自动生成,创建成功后会返回id。修改时该id标识为需要修改的Loopback。 "fbb684c80d37496fbafa4b06d5151e2e" deviceName string 0~64个字符。 - 设备名称。 "device1" esn string 10~40个字符。 - 设备ESN。 "1019A063325" nameAllocMode string auto manual - 名称配置方式。auto表示自动分配,manual表示手动分配。 "manual" loopBackName string 9~10个字符。 - loopback名称,云杉AP最大限制8,其他设备类型15,不允许修改,另当nameAllocMode为auto的时候loopBackName不生效。 "LoopBack1" ipAddress string 0~64个字符。 - ip地址。 "192.168.0.1" mask int32 [1-32] - 掩码。 24 description string 0~242个字符。 - 描述,一个中文占三个字符。 "description" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误。 详细信息请参见实际响应消息体。
-
请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 创建Loopback配置信息,结构体参见LoopbackDto。 - 表3 LoopbackDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" id 否 string 32~36个字符。 - Loopback的id。创建时无需填写自动生成,创建成功后会返回id。修改时该id标识为需要修改的Loopback。 "fbb684c80d37496fbafa4b06d5151e2e" deviceName 否 string 0~64个字符。 - 设备名称。 "device1" esn 否 string 10~40个字符。 - 设备ESN。 "1019A063325" nameAllocMode 否 string auto manual - 名称配置方式。auto表示自动分配,manual表示手动分配。 "manual" loopBackName 否 string 9~10个字符。 - loopback名称,云杉AP最大限制8,其他设备类型15,不允许修改,另当nameAllocMode为auto的时候loopBackName不生效。 "LoopBack1" ipAddress 否 string 0~64个字符。 - ip地址。 "192.168.0.1" mask 否 int32 [1-32] - 掩码。 24 description 否 string 0~242个字符。 - 描述,一个中文占三个字符。 "description"