跳转到主要内容
ZStack
资源中心/网络服务/网络服务相关接口/端口镜像相关接口

查询端口镜像

查询端口镜像

GET/zstack/v1/port-mirrors
GET/zstack/v1/portMirrors/{uuid}

操作 ID

QueryPortMirror

起始版本

3.7.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • q
    String

    查询条件。

响应状态

200 OK
200 OK

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

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

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

    • name
      String必填

      资源名称

    • description
      String

      资源的详细描述

    • mirrorNetworkUuid
      String必填

      mirror网络UUID。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • state
      PortMirrorState必填

      详情参考state

      • Enabled
        PortMirrorState必填

        是否已启用状态。

      • Disabled
        PortMirrorState必填

        是否已禁用状态。

    • sessions
      List必填

      详情参考sessions

      • uuid
        String必填

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

      • name
        String必填

        资源名称

      • description
        String

        资源的详细描述

      • internalId
        Long必填

        内部ID。

      • srcEndPoint
        String必填

        源端点。

      • dstEndPoint
        String必填

        destination端点。

      • portMirrorUuid
        String必填

        端口mirror UUID。

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • status
        SessionStatus必填

        详情参考status

        • Created
          SessionStatus必填

          已创建状态。

        • Active
          SessionStatus必填

          激活状态。

        • Inactive
          SessionStatus必填

          inactive状态。

      • type
        SessionType必填

        详情参考type

        • Ingress
          SessionType必填

          Ingress流量方向。

        • Egress
          SessionType必填

          egress流量方向。

        • Bidirection
          SessionType必填

          bidirectional流量方向。