跳转到主要内容
ZStack
资源中心/网络资源/二层网络资源相关接口

查询物理交换机信息

查询物理交换机信息

GET/zstack/v1/topo/physical-switches
GET/zstack/v1/topo/physical-switches/{uuid}

操作 ID

QueryPhysicalSwitch

起始版本

5.4.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • q
    String

    查询条件。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • success
    boolean必填

    操作是否成功。

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • fabricIds
      String必填

      暂无描述。

    • sdnControllerUuid
      String必填

      SDN控制器uuid

    • deleted
      Boolean必填

      已删除。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • uuid
    String必填

    资源UUID。

  • name
    String必填

    资源名称。

  • description
    String必填

    资源的详细描述。

  • ethTrunkName
    String必填

    暂无描述。

  • portType
    String必填

    端口类型。

  • peerInterfaceUuid
    String必填

    暂无描述。

  • switchUuid
    String必填

    暂无描述。

  • sdnControllerUuid
    String必填

    暂无描述。

  • createDate
    Timestamp必填

    最后操作时间。

  • lastOpDate
    Timestamp必填

    最后操作时间。

变更历史

查看全部变更历史

  • 变更时间

    新增响应字段 ethTrunkName, peerInterfaceUuid, portType...
    查看 API