文档目录

查询物理网口LLDP配置(QueryHostNetworkInterfaceLldp)

API请求

URLs
GET zstack/v1/hostNetworkInterface/lldp/all
GET zstack/v1/hostNetworkInterface/lldp/{interfaceUuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hostNetworkInterface/lldp/all
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hostNetworkInterface/lldp/{interfaceUuid}

可查询字段

运行zstack-cli命令行工具,输入QueryHostNetworkInterfaceLldp并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "interfaceUuid": "d90dd5538ca2343099ea96cb89857aca",
      "mode": "rx_only"
    }
  ]
}
名字 类型 描述 起始版本
success boolean 5.0.0
lldp List 详情参考inventories 5.0.0
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 5.0.0
#inventories
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 5.0.0
interfaceUuid String 物理网口Uuid 5.0.0
mode String LLDP工作模式 5.0.0
createDate Timestamp 创建时间 5.0.0
lastOpDate Timestamp 最后一次修改时间 5.0.0
lldp HostNetworkInterfaceLldpRefInventory 详情参考lldp 5.0.0
#lldp
名字 类型 描述 起始版本
lldpUuid String LLDP UUID 5.0.0
chassisId String 机箱标识 5.0.0
timeToLive Integer 生存时间 5.0.0
managementAddress String 管理地址 5.0.0
systemName String 系统名称 5.0.0
systemDescription String 系统描述 5.0.0
systemCapabilities String 系统能力 5.0.0
portId String 端口标识 5.0.0
portDescription String 端口描述 5.0.0
vlanId Integer VLAN标识 5.0.0
aggregationPortId Long 聚合端口标识 5.0.0
mtu Integer 最大传输单元 5.0.0
createDate Timestamp 创建时间 5.0.0
lastOpDate Timestamp 最后一次修改时间 5.0.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 5.0.0
description String 错误的概要描述 5.0.0
details String 错误的详细信息 5.0.0
elaboration String 保留字段,默认为null 5.0.0
opaque LinkedHashMap 保留字段,默认为null 5.0.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 5.0.0

SDK示例

Java SDK
QueryHostNetworkInterfaceLldpAction action = new QueryHostNetworkInterfaceLldpAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHostNetworkInterfaceLldpAction.Result res = action.call();
Python SDK
QueryHostNetworkInterfaceLldpAction action = QueryHostNetworkInterfaceLldpAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryHostNetworkInterfaceLldpAction.Result res = action.call()
开发手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心