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

查询负载均衡服务器组的后端服务器列表，支持按服务器名称模糊搜索、启用状态过滤以及按服务器名称等字段排序，名称与 IP 由后端关联云主机信息后返回

查询负载均衡服务器组的后端服务器列表，支持按服务器名称模糊搜索、启用状态过滤以及按服务器名称等字段排序，名称与 IP 由后端关联云主机信息后返回

GET/zstack/v1/load-balancers/listeners/{listenerUuid}/backendservers

操作 ID

GetLoadBalancerServerGroupBackendServer

起始版本

5.5.38

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • listenerUuid
    String必填

    监听器 UUID，返回该监听器下所有服务器组的后端服务器

查询参数

  • serverGroupUuid
    String

    服务器组 UUID，可选过滤，不填返回该监听器下所有服务器组的后端服务器

  • limit
    Integer

    分页大小，默认 1000

  • start
    Integer

    分页起始偏移，默认 0

  • name
    String

    服务器名称，模糊匹配，不填返回全部

  • state
    String

    启用状态过滤，Enabled 表示启用，Disabled 表示禁用，不填返回全部

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    请求是否成功

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • total
    Long必填

    过滤后的后端服务器总数

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

      后端服务器唯一 UUID，由服务器类型和记录 ID 确定性生成，跨请求稳定

    • serverGroupName
      String必填

      服务器组名称

    • listenerUuid
      String必填

      监听器 UUID，state 为该监听器视角的启停状态

    • serverGroupUuid
      String必填

      服务器组UUID

    • loadBalancerUuid
      String必填

      负载均衡器UUID

    • serverType
      String必填

      后端服务器类型,云主机网卡为VmInstance,外部IP为ServerIp

    • vmNicUuid
      String必填

      云主机网卡 UUID，serverType 为 ServerIp 时为 null

    • vmInstanceUuid
      String必填

      云主机 UUID，serverType 为 ServerIp 时为 null

    • serverName
      String必填

      服务器名称,云主机后端为云主机名称,外部IP后端为IP地址

    • ip
      String必填

      后端服务器IP地址

    • l3NetworkUuid
      String必填

      网卡所在三层网络 UUID，serverType 为 ServerIp 时为 null

    • weight
      Long必填

      权重

    • ipVersion
      Integer必填

      IP 协议版本，serverType 为 ServerIp 时为 null

    • state
      String必填

      启用状态，Enabled 表示已启用，Disabled 表示已禁用；不指定 listenerUuid 时为聚合结果

    • runtimeStatus
      String必填

      云主机运行联动状态，Active 表示运行中，Inactive 表示已停止，Pending 表示等待中

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间