API Reference | ZStack ZSphere · ZVF | ZStack Resource Center

API Request

URLs

GET zstack/v1/hostNetworkInterface/lldp/{interfaceUuid}/info

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hostNetworkInterface/lldp/e1b5f128aa183da6a6b719f136fdc5d2/info

Parameter List

Name	Type	Location	Description	Starting Version
interfaceUuid	String	url	Physical Network Interface UUID	4.1.0
systemTags (Optional)	List	query	System Tags	4.1.0
userTags (Optional)	List	query	User Tags	4.1.0

API Response

Response Example

{
  "lldp": {
    "lldpUuid": "6b7c1267888a38779eac7694315855f0",
    "chassisId": "mac 00:1e:08:1d:05:ba",
    "timeToLive": 120,
    "managementAddress": "172.25.2.4",
    "systemName": "BM-MN-3",
    "systemDescription": " CentecOS software, E530, Version 7.4.7 Copyright (C) 2004-2021 Centec Networks Inc.  All Rights Reserved.",
    "systemCapabilities": "Bridge, on  Router, on",
    "portId": "ifname eth-0-5",
    "portDescription": "eth-0-4",
    "vlanId": 3999,
    "aggregationPortId": 4294965248,
    "mtu": 9600
  }
}

Name	Type	Description	Starting Version
success	boolean	Whether the operation succeeded.	4.1.0
lldp	HostNetworkInterfaceLldpRefInventory	See lldp for details	4.1.0
error	ErrorCode	Error code. If not null, the operation failed. If null, the operation succeeded. See error for details	4.1.0

#lldp

Name	Type	Description	Starting Version
lldpUuid	String	LLDP UUID	4.1.0
chassisId	String	Chassis identifier	4.1.0
timeToLive	Integer	Time to live	4.1.0
managementAddress	String	Management address	4.1.0
systemName	String	System name	4.1.0
systemDescription	String	System description	4.1.0
systemCapabilities	String	System capabilities	4.1.0
portId	String	Port identifier	4.1.0
portDescription	String	Port description	4.1.0
vlanId	Integer	VLAN identifier	4.1.0
aggregationPortId	Long	Aggregation port identifier	4.1.0
mtu	Integer	Maximum transmission unit	4.1.0
createDate	Timestamp	Create time	4.1.0
lastOpDate	Timestamp	Last update time	4.1.0

#error

Name	Type	Description	Starting Version
code	String	Error code number. Globally unique identifier of the error, for example SYS.1000, HOST.1001.	4.1.0
description	String	Brief error description	4.1.0
details	String	Detailed error information	4.1.0
elaboration	String	Reserved field, defaults to null	4.1.0
opaque	LinkedHashMap	Reserved field, defaults to null	4.1.0
cause	ErrorCode	Root cause error. The error that caused the current error. If there is no original error, this field is null.	4.1.0

SDK Examples

Java SDK

GetHostNetworkInterfaceLldpAction action = new GetHostNetworkInterfaceLldpAction();
action.interfaceUuid = "e1b5f128aa183da6a6b719f136fdc5d2";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetHostNetworkInterfaceLldpAction.Result res = action.call();

Python SDK

GetHostNetworkInterfaceLldpAction action = GetHostNetworkInterfaceLldpAction()
action.interfaceUuid = "e1b5f128aa183da6a6b719f136fdc5d2"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetHostNetworkInterfaceLldpAction.Result res = action.call()