华为乾坤-查询设备日志服务器下已使用站点:响应参数

时间:2025-02-17 11:37:31

响应参数

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

表3 SyslogSitesRsp对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

-

-

错误码:0 表示接口执行成功,非0 表示接口执行失败。

"0"

errmsg

string

-

-

错误信息。

""

pageIndex

int32

-

-

当前页。

0

pageSize

int32

-

-

页大小。

10

totalRecords

int32

-

-

总数。

100

data

ARRAY_REFERENCE

0-1000个列表项,详细请参见表4

主体数据。

-

表4 SyslogSiteInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

siteId

string

-

-

站点ID。

"00000000-0000-0000-0000-000000000000"

siteName

string

-

-

站点名称。

"site1"

platform

string

-

-

站点下设备是否是V600系列版本的标识。pnf表示是V600系列版本的设备。

"pnf"

associatedType

string

-

-

关联方式,存在如下两种:overlay、underlay。

"overlay"

vpnId

string

-

-

VPN ID。

"00000000-0000-0000-0000-000000000000"

vpnName

string

-

-

VPN名称。

"vpn1"

SyslogDeviceInfo

ARRAY_REFERENCE

0-1000个列表项,详细请参见表5

设备日志服务器关联设备点信息。

-

表5 SyslogDeviceInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

deviceId

string

-

-

设备ID。

"00000000-0000-0000-0000-000000000000"

deviceName

string

-

-

设备名称。

"device1"

configuredSourceIp

string

-

-

配置过的设备日志源Ip,用于记录V600系列版本的设备配置,或者二进制日志场景设备。

"192.168.0.1"

configuredSourcePort

integer

[10240-55534]

-

二进制日志场景设备日志源端口。

-

linkInfos

ARRAY_REFERENCE

0-100个列表项,详细请参见表6

underlay关联时,该设备下所有链路信息。

-

sourceInfos

ARRAY_REFERENCE

0-100个列表项,详细请参见表7

overlay关联时,该设备当前vpnId下所有loopback口信息。

-

isConfigured

boolean

  • true

  • false

-

当前设备是否配置了设备日志服务器。true表示已配置,false表示未配置。

true

表6 LinkInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

linkId

string

-

-

链路ID。

"00000000-0000-0000-0000-000000000000"

linkName

string

-

-

链路名称。

"link1"

used

boolean

  • true

  • false

-

该链路是否已经被使用,true为是,false为否。

true

表7 SourceInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

sourceIp

string

-

-

loopback口的Ip。

"192.168.0.1"

sourceInterface

string

-

-

loopback口的接口名。

"loopback601"

used

boolean

  • true

  • false

-

该loopback口是否已经被使用,true为是,false为否。

true

返回状态码为400:请求参数错误。

详细信息请参见实际响应消息体。

返回状态码为500:内部异常。

详细信息请参见实际响应消息体。

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000001870548581.html