调用ListServerGroups查询服务器组_负载均衡-阿里云帮助中心

查询指定地域的服务器组。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alb:ListServerGroups	List	ALB acs:alb:{#regionId}:{#accountId}:servergroup/*	无	无

请求参数

名称	类型	必填	描述	示例值
ServerGroupIds	array	否	服务器组ID列表。
	string	否	服务器组ID，一次最多支持查询20个服务器组ID。	sgp-atstuj3rtop****
ServerGroupNames	array	否	服务器组名称列表，最多10个。
	string	否	服务器组名称，一次最多支持查询10个服务器组名称。	Group3
ResourceGroupId	string	否	资源组ID。	rg-atstuj3rtop****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。	20
VpcId	string	否	VPC实例ID。	vpc-bp15zckdt37pq72zv****
Tag	object []	否	服务器组绑定的标签列表。一次请求中，绑定的标签列表中最多支持10个标签。
Key	string	否	标签键。最多支持10个标签键。最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	Test
Value	string	否	标签值。最多支持10个标签值。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	Test

返回参数

名称	类型	描述	示例值
	object	返回数据结构体。
MaxResults	integer	分批次查询时每次显示的条目数。	50
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。	caeba0bbb2be03f8****
RequestId	string	请求ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
ServerGroups	object []	后端服务器组列表。
HealthCheckConfig	object	健康检查配置。
HealthCheckConnectPort	integer	健康检查的后端服务器的端口。取值范围：0~65535。返回为0时代表使用后端服务器的端口进行健康检查。	80
HealthCheckEnabled	boolean	是否启用健康检查，取值： true：启用。 false：不启用。	true
HealthCheckHost	string	健康检查域名。字符要求：长度限制为1~80个字符。可包含小写字母、数字、短划线（-）和半角句号（.）。至少包含一个半角句号（.），半角句号（.）不能出现在开头或结尾。最右侧的域标签，只能包含字母，不能包含数字或短划线（-）。短划线（-）不能出现在开头或结尾。说明只有HealthCheckProtocol设置为HTTP时，该参数生效。	www.example.com
HealthCheckCodes	array	健康检查正常的状态码列表。
	string	健康检查正常的状态码。当HealthCheckProtocol取值为HTTP时，HealthCheckCodes可以选择http_2xx、 http_3xx、http_4xx和http_5xx。多个状态码用半角逗号（,）分隔。当HealthCheckProtocol取值为gRPC时，HealthCheckCodes状态码范围：0~99。支持范围输入，最多支持20个范围值，多个范围值使用半角逗号（,）隔开。说明 HealthCheckProtocol为HTTP或gRPC时，该参数生效。	http_2xx
HealthCheckHttpVersion	string	健康检查HTTP协议版本。取值：HTTP1.0或HTTP1.1。说明只有HealthCheckProtocol设置为HTTP时，该参数生效。	HTTP1.1
HealthCheckInterval	integer	健康检查的时间间隔。单位：秒。取值范围：1~50。	5
HealthCheckMethod	string	健康检查方法。取值： GET：如果响应报文长度超过8K，会被截断，但不会影响健康检查结果的判定。 POST：gRPC监听健康检查默认采用POST方法。 HEAD：HTTP监听健康检查默认采用HEAD方法。说明只有HealthCheckProtocol设置为HTTP或gRPC时，该参数生效。	HEAD
HealthCheckPath	string	健康检查的转发规则路径。说明只有HealthCheckProtocol设置为HTTP时，该参数生效。	/test/index.html
HealthCheckProtocol	string	健康检查协议。取值： HTTP：通过发送HEAD或GET请求模拟浏览器的访问行为来检查服务器应用是否健康。 TCP：通过发送SYN握手报文来检测服务器端口是否存活。 gRPC：通过发送POST或GET请求来检查服务器应用是否健康。	HTTP
HealthCheckTimeout	integer	接收来自运行状况检查的响应需要等待的时间。如果后端服务器在指定的时间内没有正确响应，则判定为健康检查失败。单位：秒。	3
HealthyThreshold	integer	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。	4
UnhealthyThreshold	integer	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。	4
Protocol	string	后端协议类型。取值： HTTP：支持关联HTTPS、HTTP和QUIC监听。 HTTPS：支持关联HTTPS监听。 GRPC：关联HTTPS和QUIC监听。	HTTP
ResourceGroupId	string	资源组ID。	rg-atstuj3rtop****
Scheduler	string	调度算法。取值： Wrr：加权轮询，权重值越高的后端服务器，被轮询到的概率也越高。 Wlc：加权最小连接数，除了根据每台后端服务器设定的权重值来进行轮询，同时还考虑后端服务器的实际负载（即连接数）。当权重值相同时，当前连接数越小的后端服务器被轮询到的概率也越高。 Sch：一致性哈希，相同的源地址会调度到相同的后端服务器。	Wrr
ServerGroupId	string	服务器组ID。	sgp-cige6j****
ServerGroupName	string	服务器组名称。	Group3
ServerGroupStatus	string	服务器组状态。取值： Creating：创建中。 Available：可用。 Configuring：变配中。	Available
ServerGroupType	string	服务器组类型。取值： Instance：服务器类型。 Ip：IP类型。 Fc：函数计算类型。	Instance
StickySessionConfig	object	会话保持配置结构体。
Cookie	string	服务器上配置的Cookie。	B490B5EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	Cookie超时时间。单位：秒。取值范围：1~86400。说明当StickySessionEnabled为true且StickySessionType为Insert时，该参数生效。	1000
StickySessionEnabled	boolean	是否启用会话保持。取值： true：开启。 false：关闭。	false
StickySessionType	string	Cookie的处理方式。取值： Insert：植入Cookie。客户端第一次访问时，负载均衡会在返回请求中植入Cookie（即在HTTP或HTTPS响应报文中插入SERVERID），下次客户端携带此Cookie访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器上。 Server：重写Cookie。负载均衡发现用户自定义了Cookie，将会对原来的Cookie进行重写，下次客户端携带新的Cookie访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器。	Insert
VpcId	string	VPC实例ID。	vpc-bp15zckdt37pq72zv****
Tags	object []	服务器组绑定的标签列表。
Key	string	标签键。	Test
Value	string	标签值。	Test
ConfigManagedEnabled	boolean	是否开启配置管理。取值： true：开启。 false：关闭。	false
UpstreamKeepaliveEnabled	boolean	是否开启后端长链接。取值： true：开启。 false：关闭。	false
Ipv6Enabled	boolean	是否支持IPv6。取值： true：支持。 false：不支持。	false
ServerCount	integer	服务器组内服务器数量。	1
ServiceName	string	服务名称。	test
UchConfig	object	url一致性hash参数配置
Type	string	参数类型	QueryString
Value	string	一致性hash参数值	abc
TotalCount	integer	列表条目数。	1000

示例

正常返回示例

JSON格式

{
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f8****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ServerGroups": [
    {
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckEnabled": true,
        "HealthCheckHost": "www.example.com",
        "HealthCheckCodes": [
          "http_2xx"
        ],
        "HealthCheckHttpVersion": "HTTP1.1",
        "HealthCheckInterval": 5,
        "HealthCheckMethod": "HEAD",
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "HTTP",
        "HealthCheckTimeout": 3,
        "HealthyThreshold": 4,
        "UnhealthyThreshold": 4
      },
      "Protocol": "HTTP",
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "Wrr",
      "ServerGroupId": "sgp-cige6j****",
      "ServerGroupName": "Group3",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "StickySessionConfig": {
        "Cookie": "B490B5EBF6F3CD402E515D22BCDA****",
        "CookieTimeout": 1000,
        "StickySessionEnabled": false,
        "StickySessionType": "Insert"
      },
      "VpcId": "vpc-bp15zckdt37pq72zv****",
      "Tags": [
        {
          "Key": "Test",
          "Value": "Test"
        }
      ],
      "ConfigManagedEnabled": false,
      "UpstreamKeepaliveEnabled": false,
      "Ipv6Enabled": false,
      "ServerCount": 1,
      "ServiceName": "test",
      "UchConfig": {
        "Type": "QueryString",
        "Value": "abc"
      },
      "CreateTime": ""
    }
  ],
  "TotalCount": 1000
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-04-11

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更