-
响应示例 返回状态码为200:查询拓扑节点成功,响应体参考TopoNodeInfoDto。 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" : "",
"errmsg" : "",
"nodeData" : {
"nodeData" : [
{
"label" : "AP1",
"resId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0",
"nativeId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0",
"nodeSize" : 64,
"ownerId" : 654321,
"parentResId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0",
"posX" : "103.28",
"posY" : "37.66"
}
],
"hasNext" : false,
"marker" : "1009"
},
"linkData" : {
"linkData" : [
{
"label" : "21980109442SL4600519_GigabitEthernet0/0/1_DHCPSW_85.7.22.2:10031_GigabitEthernet0/0/7",
"resId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0",
"topoId" : 5000,
"typeId" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0",
"leftId" : 0,
"rightId" : 0,
"leftFdn" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0",
"rightFdn" : "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0",
"leftObjType" : 0,
"rightObjType" : 0,
"linkClass" : 0,
"className" : "EntNetworkElement",
"isLinkSet" : 0,
"lineType" : 0,
"lineWidth" : 0,
"direction" : 0,
"aPortName" : "GigabitEthernet0/0/24",
"zPortName" : "GigabitEthernet0/0/24",
"linkStatus" : 0
}
],
"hasNext" : false,
"marker" : "1009"
}
}
-
响应参数 返回状态码为200:查询拓扑节点成功,响应体参考TopoNodeInfoDto。 表2 TopoNodeInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码,成功返回null。 - errmsg string - - 错误描述,成功返回null。 - nodeData REFERENCE 详细请参见表3。 - - linkData REFERENCE 详细请参见表5。 - - 表3 TopoNodeDtos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nodeData ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 拓扑节点信息。 - hasNext boolean true false - 是否还有数据,默认为false。 false marker string - - 下一页查询条件。 "1009" 表4 TopoNodeDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 label string - - 资源名称。 "AP1" resId string - - 资源ID,包含组织、站点、设备。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" nativeId string - - 资源的原生标识。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" nodeSize integer - - 节点大小。 64 ownerId int64 - - 拥有者。 654321 parentResId string - - 上层resId。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" posX string 0~64个字符。 - 物理视图横坐标。 "103.28" posY string 0~64个字符。 - 物理视图纵坐标。 "37.66" 表5 TopoLinkDtos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkData ARRAY_REFERENCE 0-1000个列表项,详细请参见表6。 链路数据。 - hasNext boolean true false - 是否有下一页,默认为false。 false marker string - - 下一页查询条件。 "1009" 表6 TopoLinkDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 label string - - 资源名称。 "21980109442SL4600519_GigabitEthernet0/0/1_DHCPSW_85.7.22.2:10031_GigabitEthernet0/0/7" resId string - - 资源ID,包含组织、站点、设备。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" topoId integer - - 拓扑ID。 5000 typeId string - - 链路类型ID。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" leftId integer - - 左节点拓扑ID。 0 rightId integer - - 右节点拓扑ID。 0 leftFdn string - - 左节点resId。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" rightFdn string - - 右节点resId。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" leftObjType integer - - 左节点类型。 0 rightObjType integer - - 右节点类型。 0 linkClass integer - - 链路类型。 0 className string - - 对象类名。 "EntNetworkElement" isLinkSet integer - - 是否为链路集,对应传统Topo字段Category。 0 lineType integer - - 链路线型。 0 lineWidth integer - - 链路线宽。 0 direction integer - - 链路方向。 0 aPortName string - - A端的端口信息,对应leftFdn。 "GigabitEthernet0/0/24" zPortName string - - Z端的端口信息,对应rightFdn。 "GigabitEthernet0/0/24" linkStatus integer - - 链路状态,包含:正常(0)、未知(1)、重要故障(2)、紧急故障(3)、离线(4)、不管理(5) 0
-
URI /controller/campus/v1/networkresource/topomanager/device/node 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentResId 否 string 0~36个字符。 - 组织/站点ID,UUID格式。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0" limit 否 integer [0-1000] - 最大返回数量,最大查询1000条。 100 marker 否 string - - 剩余数据查询条件。 "1009"
-
请求示例 HTTP的示例 GET /controller/campus/v1/networkresource/topomanager/device/node?parentResId=d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0&limit=100&marker=1009 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:查询成功。 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" : 1,
"pageIndex" : 1,
"pageSize" : 20,
"data" : {
"lldp" : [
{
"localIfName" : "interface 0/0/0",
"remoteIfName" : "interface 0/0/1",
"sysName" : "10",
"sysDescription" : "xx:xx:xx:xx:xx:xx",
"remoteMac" : "xx:xx:xx:xx:xx:xx",
"sysCapEnabled" : "cap-bridge cap-router",
"sysCapSupported" : "cap-router"
}
]
}
}
-
响应参数 返回状态码为200:查询成功。 表3 NeighborsInfoResultDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误描述。 "" totalRecords integer - - 当前查询LLDP连接的总数。 1 pageIndex integer - - 分页的序号。 1 pageSize integer - - 分页的大小。 20 data REFERENCE 详细请参见表4。 - - 表4 data对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 lldp ARRAY_REFERENCE 0-65535个列表项,详细请参见表5。 LLDP数据。 - 表5 NeighborsInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 localIfName string - - 本端接口名称。 "interface 0/0/0" remoteIfName string - - 远端接口名称。 "interface 0/0/1" sysName string - - 远端系统名称。 "10" sysDescription string - - 远端系统描述。 "xx:xx:xx:xx:xx:xx" remoteMac string - - 远端系统MAC。 "xx:xx:xx:xx:xx:xx" sysCapEnabled string - - 对端设备支持的能力:cap-other、cap-repeater、cap-bridge、cap-wlan-access-point、cap-router、cap-telephone、cap-docsis-cable-device、cap-station-only;多个能力时以空格间隔。 "cap-bridge cap-router" sysCapSupported string - - 对端设备使能的能力:cap-other、cap-repeater、cap-bridge、cap-wlan-access-point、cap-router、cap-telephone、cap-docsis-cable-device、cap-station-only;多个能力时以空格间隔。 "cap-router"
-
请求示例 HTTP的示例 GET /controller/campus/v1/networkresource/topomanager/device/d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0/neighbors?localIfName=GigabitEthernet0/0/0&pageIndex=0&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