文档

ListServerGroupServers - 查询服务器

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

服务器组 ID。

sgp-atstuj3rtoptyui****
ServerIdsarray

服务器 ID 列表。单次调用最多支持展示 40 个服务器。

string

服务器 ID 列表。单次调用最多支持展示 40 个服务器。

i-bp67acfmxazb4p****
ServerIpsarray

服务器 IP 列表。单次调用最多支持展示 40 个服务器。

string

服务器 IP 列表。单次调用最多支持展示 40 个服务器。

192.168.6.3
NextTokenstring

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

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

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
RegionIdstring

网络型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

查询服务器。

RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
Serversobject []

服务器列表。

ServerIdstring

后端服务器 ID。

i-bp67acfmxazb4p****
ServerTypestring

后端服务器类型,取值:

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

后端服务器 IP 地址。

192.168.2.1
Portinteger

后端服务器使用的端口。取值范围:1~65535

80
Weightinteger

后端服务器的权重。

100
ServerGroupIdstring

服务器组 ID。

sgp-atstuj3rtoptyui****
Descriptionstring

后端服务器描述。

ECS
ZoneIdstring

服务器对应的可用区 ID。

cn-hangzhou-a
Statusstring

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

  • Adding:添加中。
  • Available:正常可用状态。
  • Configuring:配置中。
  • Removing:移除中。
Available
TotalCountinteger

列表条目数。

10
NextTokenstring

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

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

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

20

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "Servers": [
    {
      "ServerId": "i-bp67acfmxazb4p****",
      "ServerType": "Ecs",
      "ServerIp": "192.168.2.1",
      "Port": 80,
      "Weight": 100,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "Description": "ECS",
      "ZoneId": "cn-hangzhou-a",
      "Status": "Available"
    }
  ],
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

错误码

HTTP status code错误码错误信息描述
400SystemBusySystem is busy, please try again later.系统繁忙,请稍后重试
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。
404ResourceNotFound.serverGroupThe specified resource of serverGroup is not found.找不到指定的服务器组资源,请检查输入参数。

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

变更历史

变更时间变更内容概要操作
2023-10-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
    新增错误码:400
2023-09-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
2023-09-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:RegionId
2023-09-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:403
    新增错误码:404