跳转到主要内容
ZStack
资源中心/网络服务/网络服务相关接口/负载均衡相关接口

查询负载均衡器

查询负载均衡器

GET/zstack/v1/load-balancers
GET/zstack/v1/load-balancers/{uuid}

操作 ID

QueryLoadBalancer

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

调用该 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

    • name
      String必填

      资源名称

    • uuid
      String必填

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

    • description
      String必填

      资源的详细描述

    • state
      String必填

      当前状态。

    • vipUuid
      String必填

      暂无描述。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • listeners
      List必填

      详情参考listeners

      • uuid
        String必填

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

      • name
        String必填

        资源名称

      • description
        String必填

        资源的详细描述

      • loadBalancerUuid
        String必填

        负载均衡器UUID

      • instancePort
        Integer必填

        实例端口。

      • loadBalancerPort
        Integer必填

        加载balancer端口。

      • protocol
        String必填

        认证协议。

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • vmNicRefs
        List必填

        详情参考vmNicRefs

        • id
          Long必填

          资源ID。

        • listenerUuid
          String必填

          暂无描述。

        • vmNicUuid
          String必填

          云主机网卡UUID

        • status
          String必填

          状态信息。

        • createDate
          Timestamp必填

          创建时间

        • lastOpDate
          Timestamp必填

          最后一次修改时间

      • certificateRefs
        List必填

        详情参考certificateRefs

        • id
          Long必填

          资源ID。

        • listenerUuid
          String必填

          暂无描述。

        • certificateUuid
          String必填

          暂无描述。

        • createDate
          Timestamp必填

          创建时间

        • lastOpDate
          Timestamp必填

          最后一次修改时间