全部产品
Search
文档中心

负载均衡:ListServerGroupServers - 查询服务器组中的服务器列表

更新时间:Nov 11, 2024

查询负载均衡服务器组中的服务器列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gwlb:ListServerGroupServersget
  • ServerGroup
    acs:gwlb:{#regionId}:{#accountId}:servergroup/*
  • ServerGroup
    acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

请求参数

名称类型必填描述示例值
ServerGroupIdstring

服务器组 ID。

sgp-atstuj3rtoptyui****
ServerIdsarray

服务器 ID 列表。

单次调用最多支持展示 200 个服务器。

ServerIdstring

服务器 ID。

  • 当服务器组为 Instance 类型时,该参数为 EcsEniEci 的资源 ID。

  • 当服务器组为 Ip 类型时,该参数为 IP 地址。

i-bp67acfmxazb4p****
ServerIpsarray

服务器 IP 地址列表。

单次调用最多支持展示 200 个服务器。

ServerIpstring

服务器 IP 地址。

192.168.xxx.xxx
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

取值范围:1~1000。

默认值:20。

20
Skipinteger

查询时跳过指定的条目数。

1

返回参数

名称类型描述示例值
object

返回数据结构体。

MaxResultsinteger

分批次查询时每次显示的条目数。

取值范围:1~1000。

20
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
Serversarray<object>

后端服务器列表。

Serverobject

后端服务器。

Portinteger

后端服务器使用的端口,取值:

  • 6081
6081
ServerGroupIdstring

服务器组 ID。

sgp-atstuj3rtoptyui****
ServerIdstring

后端服务器 ID。

i-bp67acfmxazb4p****
ServerIpstring

后端服务器 IP 地址。

192.168.xxx.xxx
ServerTypestring

后端服务器类型,取值:

  • Ecs:ECS 实例。
  • Eni:ENI 弹性网卡实例。
  • Eci:ECI 弹性容器。
  • Ip:Ip 地址。
Ecs
Statusstring

后端服务器的状态。取值:

  • Adding:添加中。
  • Available:正常可用状态。
  • Draining:连接优雅中断中。
  • Removing:移除中。
  • Replacing:替换中。
Available
TotalCountinteger

列表条目数。

1

示例

正常返回示例

JSON格式

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "Servers": [
    {
      "Port": 6081,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerId": "i-bp67acfmxazb4p****",
      "ServerIp": "192.168.xxx.xxx",
      "ServerType": "Ecs",
      "Status": "Available"
    }
  ],
  "TotalCount": 1
}

错误码

访问错误中心查看更多错误码。