ListServerGroupServers - 查询服务器

更新时间: 2023-08-23 21:04:06

查询服务器组中的服务器。

调试

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

调试

授权信息

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

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

请求参数

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

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

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

本次读取的最大数据记录数量。取值范围:1~100,入参为空时,默认值为20

50
ServerGroupIdstring

服务器组ID。

rg-atstuj3rtop****
ServerIdsarray

服务器ID列表。

string

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

  • 当服务器组为Instance类型时,该参数为Ecs、Eni、Eci的资源Id。
  • 当服务器组为Ip类型时,该参数为IP地址。
  • 当服务器组为Fc时,该参数为函数计算的ARN标识。
i-bp1e0u8f10by57wl****
Tagobject []

服务器组绑定的标签列表。一次请求中,绑定的标签列表中最多支持10个标签。

Keystring

标签键。最多支持10个标签键。

最多支持64个字符,不能以aliyunacs:开头,不能包含http://或者https://

Test
Valuestring

标签值。最多支持10个标签值。

最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

Test

返回参数

名称类型描述示例值
object

返回数据结构体。

MaxResultsinteger

本次请求所返回的最大记录条数。

50
NextTokenstring

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

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

请求ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Serversobject []

服务器列表。

Descriptionstring

后端服务器描述。

test
Portinteger

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

80
ServerIdstring

后端服务器ID。

说明 ServerTypeFc时,ServerId为函数计算的ARN标识。
i-bp1f9kdprbgy9uiu****
ServerIpstring

ENI多IP模式时指定的IP地址。

192.168.XX.XX
ServerTypestring

后端服务器类型。

Ecs
Statusstring

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

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

后端服务器的权重。权重越高的服务器将被分配到更多的访问请求。

100
ServerGroupIdstring

服务器组ID。

sgp-qy042e1jabmprh****
RemoteIpEnabledboolean

是否开启远端IP。取值:

  • true:是。
  • false:否。
true
TotalCountinteger

本次请求条件下的数据总量。

3

示例

正常返回示例

JSON格式

{
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f8****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Servers": [
    {
      "Description": "test",
      "Port": 80,
      "ServerId": "i-bp1f9kdprbgy9uiu****",
      "ServerIp": "192.168.XX.XX",
      "ServerType": "Ecs",
      "Status": "Available",
      "Weight": 100,
      "ServerGroupId": "sgp-qy042e1jabmprh****",
      "RemoteIpEnabled": true
    }
  ],
  "TotalCount": 3
}

错误码

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

阿里云首页 负载均衡 相关技术圈