ListServerGroups - 查询服务器组 - 负载均衡

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ServerGroupIds	array	否	服务器组 ID。一次最多支持查询 20 个服务器组 ID。
ServerGroupId	string	否	服务器组 ID。一次最多支持查询 20 个服务器组 ID。	sgp-atstuj3rtoptyui****
ServerGroupNames	array	否	服务器组名称，一次最多支持查询 20 个服务器组名称。
ServerGroupName	string	否	服务器组名称，一次最多支持查询 20 个服务器组名称。	NLB_ServerGroup
ResourceGroupId	string	否	服务器组所属的资源组 ID。	rg-atstuj3rtop****
ServerGroupType	string	否	服务器组类型。取值： Instance：服务器类型，该类型服务器组支持添加 Ecs、Ens、Eci 类型实例。 Ip：IP 地址类型，该类型服务器组支持直接添加 IP 地址。	Instance
VpcId	string	否	服务器组所在 VPC 的 ID。	vpc-bp15zckdt37pq72zv****
Tag	array<object>	否	标签。
	object	否	标签。
Key	string	否	标签键。最多支持 10 个标签键。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`者 https://`。	Test
Value	string	否	标签值。最多支持 10 个标签值。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	Test
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。	20
RegionId	string	否	网络型负载均衡实例所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	查询服务器组。
RequestId	string	请求 ID。	54B28E3D-DF70-471B-AA93-08E683A1B45
ServerGroups	array<object>	后端服务器组列表。
ServerGroup	object	后端服务器组列表。
RegionId	string	网络型负载均衡实例所在的地域 ID。	cn-hangzhou
ServerGroupId	string	服务器组 ID。	sgp-atstuj3rtoptyui****
ServerGroupName	string	服务器组名称。	NLB_ServerGroup
ServerGroupType	string	服务器组类型。取值： Instance：服务器类型，该类型服务器组支持添加 Ecs、Ens、Eci 类型实例。 Ip：IP 地址类型，该类型服务器组支持直接添加 IP 地址。	Instance
AddressIPVersion	string	协议版本。取值： Ipv4：ipv4 类型。 DualStack：双栈类型。	ipv4
VpcId	string	服务器组所在 VPC 的 ID。	vpc-bp15zckdt37pq72zv****
Scheduler	string	调度算法。取值： Wrr：加权轮询，权重值越高的后端服务器，被轮询到的概率也越高。 Wlc：加权最小连接数，除了根据每台后端服务器设定的权重值来进行轮询，同时还考虑后端服务器的实际负载（即连接数）。当权重值相同时，当前连接数越小的后端服务器被轮询到的概率也越高。 rr：轮询，按照访问顺序依次将外部请求分发到后端服务器 sch：源 IP 哈希：相同的源地址会调度到相同的后端服务器。 sch：源 IP 哈希，相同的源地址会调度到相同的后端服务器。 tch：四元组哈希，基于四元组（源 IP、目的 IP、源端口和目的端口）的一致性哈希，相同的流会调度到相同的后端服务器。 qch：QUIC ID 哈希，支持将同一个 QUIC ID 的请求哈希到同一台后端服务器上。	Wrr
Protocol	string	后端转发协议，取值：TCP、UDP。	TCP
HealthCheck	object	健康检查配置信息。
HealthCheckEnabled	boolean	是否开启健康检查，取值： true：开启。 false：关闭。	false
HealthCheckType	string	健康检查协议。取值： TCP HTTP UDP	TCP
HealthCheckConnectPort	integer	健康检查的后端服务器的端口。取值范围： 0~65535。 0 表示使用后端服务器的端口进行健康检查。	200
HealthyThreshold	integer	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值范围：2~10。	2
UnhealthyThreshold	integer	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值范围：2~10。	3
HealthCheckConnectTimeout	integer	健康检查响应的最大超时时间。单位：秒。取值范围：1~300。	200
HealthCheckInterval	integer	健康检查的时间间隔。单位：秒。取值范围：1~50。	10
HealthCheckDomain	string	用于健康检查的域名。取值： $SERVER_IP：使用后端服务器内网 IP。 domain：指定特定域名。长度限制 1~80 个字符，只能使用小写字母、数字、短划线（-）、半角句号（.）。说明仅 HealthCheckType 为 HTTP 时，该参数生效。	$SERVER_IP
HealthCheckUrl	string	健康检查路径。说明仅 HealthCheckType 为 HTTP 时，该参数生效。	/test/index.html
HealthCheckHttpCode	array	健康状态返回码，多个状态码用半角逗号（,）分隔。取值：http_2xx、http_3xx、http_4xx和http_5xx。说明仅 HealthCheckType 为 HTTP 时，该参数生效。
HealthCheckHttpCode	string	健康状态返回码，多个状态码用半角逗号（,）分隔。取值：http_2xx、http_3xx、http_4xx和http_5xx。说明仅 HealthCheckType 为 HTTP 时，该参数生效。	http_2xx
HttpCheckMethod	string	健康检查方法，取值：GET 或 HEAD。说明仅 HealthCheckType 为 HTTP 时，该参数生效。	GET
HealthCheckReq	string	UDP 监听健康检查的请求串。只允许包含字母、数字，最大长度限制为 64 个字符。	hello
HealthCheckExp	string	UDP 监听健康检查的响应串。只允许包含字母、数字，最大长度限制为 64 个字符。	ok
ConnectionDrainEnabled	boolean	是否开启连接优雅中断。取值： true：开启。 false：关闭。	false
ConnectionDrainTimeout	integer	设置连接优雅中断超时时间。单位：秒。取值范围：10~900。	200
PreserveClientIpEnabled	boolean	是否开启客户端地址保持功能。取值： true：开启。 false：关闭。说明特殊说明：AddressIPVersion 为 ipv4 类型时默认为 true。AddressIPVersion 为 ipv6 值时只能是 false，后续待底层支持后可以为 true。	true
AnyPortEnabled	boolean	是否开启全端口转发。取值： true：开启。 false：关闭。	false
ResourceGroupId	string	服务器组所属的资源组 ID。	rg-atstuj3rtop****
ServerGroupStatus	string	服务器组状态。取值： Creating：创建中。 Available：可用。 Configuring：变配中。	Available
AliUid	long	用户 UID。	165820696622****
Tags	array<object>	标签。
Tag	object	标签。
Key	string	标签键。最多支持 10 个标签键。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`者 https://`。	Test
Value	string	标签值。最多支持 10 个标签值。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	Test
RelatedLoadBalancerIds	array	网络型负载均衡实例列表。
LoadbalancerId	string	网络型负载均衡实例列表。	nlb-83ckzc8d4xlp8o****
ServerCount	integer	后端服务器数量。	2
TotalCount	integer	列表条目数。	1
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	分批次查询时每次显示的条目数。取值范围：1~100。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "54B28E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroups": [
    {
      "RegionId": "cn-hangzhou",
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerGroupName": "NLB_ServerGroup",
      "ServerGroupType": "Instance",
      "AddressIPVersion": "ipv4",
      "VpcId": "vpc-bp15zckdt37pq72zv****",
      "Scheduler": "Wrr",
      "Protocol": "TCP",
      "HealthCheck": {
        "HealthCheckEnabled": false,
        "HealthCheckType": "TCP",
        "HealthCheckConnectPort": 200,
        "HealthyThreshold": 2,
        "UnhealthyThreshold": 3,
        "HealthCheckConnectTimeout": 200,
        "HealthCheckInterval": 10,
        "HealthCheckDomain": "$SERVER_IP",
        "HealthCheckUrl": "/test/index.html",
        "HealthCheckHttpCode": [
          "http_2xx"
        ],
        "HttpCheckMethod": "GET",
        "HealthCheckReq": "hello",
        "HealthCheckExp": "ok"
      },
      "ConnectionDrainEnabled": false,
      "ConnectionDrainTimeout": 200,
      "PreserveClientIpEnabled": true,
      "AnyPortEnabled": false,
      "ResourceGroupId": "rg-atstuj3rtop****",
      "ServerGroupStatus": "Available",
      "AliUid": 0,
      "Tags": [
        {
          "Key": "Test",
          "Value": "Test"
        }
      ],
      "RelatedLoadBalancerIds": [
        "nlb-83ckzc8d4xlp8o****"
      ],
      "ServerCount": 2
    }
  ],
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

错误码

HTTP status code	错误码	错误信息	描述
400	SystemBusy	System is busy, please try again later.	系统繁忙，请稍后重试
403	Forbidden.%s	Authentication is failed for %s.	当前资源或者操作%s鉴权失败
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	因为账号没有权限，所以鉴权失败。

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

变更历史

变更时间	变更内容概要	操作
2024-06-25	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-26	OpenAPI 错误码发生变更	查看变更详情
2023-09-18	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-08-22	OpenAPI 错误码发生变更	查看变更详情