更新时间:2025-07-07 GMT+08:00
分享

查询端口

典型场景

进入单设备详情,查询设备连接控制器端口。

接口功能

查询设备连接控制器端口。

接口约束

1、NCE-Campus LANWAN场景该接口支持北向管理员访问,必须在用户会话建立后使用。

2、NCE-Campus LAN场景,不支持该接口。

调用方法

GET

URI

/controller/campus/v1/oamservice/device/queryControllerPort/{deviceId}

表1 path参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

deviceId

UUID

-

-

设备标识,UUID格式。

"af348227-0b07-4468-900c-d1b1637a8e97"

请求参数

请求示例

HTTP的示例
GET /controller/campus/v1/oamservice/device/queryControllerPort/af348227-0b07-4468-900c-d1b1637a8e97 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:查询成功,响应体参考QueryControllerPort。

表2 QueryControllerPort对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

0~256个字符。

-

错误码,0表示成功,非0表示失败。

"0"

errmsg

string

0~256个字符。

-

错误信息。

-

data

ARRAY_REFERENCE

0-2147483647个列表项,详细请参见表3

连接端口信息。

-

表3 ControllerPortDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

deviceId

string

-

-

设备标识,UUID格式。

"ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"

devInterface

string

-

-

控制器连接端口。

"GigabitEthernet0/0/2"

ip

string

-

-

端口IP。

"10.1.1.1"

响应示例

返回状态码为200:查询成功,响应体参考QueryControllerPort。

HTTP/1.1 200 OK
Date: Sun,06 Jul 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" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca",
			"devInterface" : "GigabitEthernet0/0/2",
			"ip" : "10.1.1.1"
		}
	]
}

相关文档

    OSZAR »