调用ListServerGroups接口查询服务器组列表-负载均衡-阿里云-负载均衡(SLB)-阿里云帮助中心

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

gwlb:ListServerGroups

get

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/*

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

无

请求参数

名称	类型	必填	描述	示例值
ServerGroupIds	array	否	服务器组 ID 列表。一次最多支持查询 20 个服务器组 ID。
	string	否	服务器组 ID。	sgp-atstuj3rtoptyui****
ServerGroupNames	array	否	服务器组名称列表。一次最多支持查询 20 个服务器组名称。
	string	否	服务器组名称。	testServerGroupName
ServerGroupType	string	否	服务器组类型。取值： Instance：服务器类型，该类型服务器组支持添加 Ecs、Eni、Eci 类型实例。 Ip：IP 地址类型，该类型服务器组支持直接添加 IP 地址类型的后端服务器。	Instance
ResourceGroupId	string	否	资源组 ID。	rg-atstuj3rtop****
Tag	array<object>	否	标签列表。一次调用最多支持 20 个标签。
	object	否	标签。
Key	string	否	标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	testTagKey
Value	string	否	标签值。最多支持 256 个字符，不能包含`http://`或`https://`。	testTagValue
VpcId	string	否	专有网络 ID。	vpc-bp15zckdt37pq72zv****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~1000。默认值：20。	20
Skip	integer	否	查询时跳过指定的条目数。	1

返回参数

名称	类型	描述	示例值
	object	返回数据结构体。
MaxResults	integer	分批次查询时每次显示的条目数。取值范围：1~1000。	20
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	请求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroups	array<object>	后端服务器组列表。
	array<object>	后端服务器组。
ConnectionDrainConfig	object	连接优雅中断相关配置。
ConnectionDrainEnabled	boolean	是否开启连接优雅中断。取值： true：开启。 false：关闭。	false
ConnectionDrainTimeout	integer	连接优雅中断超时时间。单位：秒。取值范围：1~3600。	300
CreateTime	string	资源创建时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。	2024-08-05T18:24:07Z
HealthCheckConfig	object	健康检查相关配置。
HealthCheckConnectPort	integer	健康检查使用的后端服务器的端口。取值范围： 1~65535。	80
HealthCheckConnectTimeout	integer	健康检查响应的最大超时时间。单位：秒。取值范围：1~300。	5
HealthCheckDomain	string	用于健康检查的域名。取值： $SERVER_IP：使用后端服务器内网 IP。 domain：指定特定域名。长度限制 1~80 个字符，只能使用大小写字母、数字、短划线（-）、半角句号（.）。说明仅 HealthCheckProtocol 为 HTTP 时，该参数生效。	$SERVER_IP
HealthCheckEnabled	boolean	是否开启健康检查，取值： true：开启。 false：关闭。	true
HealthCheckHttpCode	array	健康状态返回码列表。
	string	健康状态返回码，多个状态码用半角逗号（,）分隔。取值： http_2xx http_3xx http_4xx http_5xx 默认值：http_2xx 。说明仅 HealthCheckProtocol 为 HTTP 时，该参数生效。	http_2xx
HealthCheckInterval	integer	健康检查的时间间隔。单位：秒。取值范围：1~50。	10
HealthCheckPath	string	健康检查路径。长度为 1~80 个字符，只能使用大小写英文字母、数字、字符`-/.%?#&`。必须以正斜线（/）开头。说明仅 HealthCheckProtocol 为 HTTP 时，该参数生效。	/test/index.html
HealthCheckProtocol	string	健康检查协议，取值： TCP：通过发送 SYN 握手报文来检测服务器端口是否存活。 HTTP：通过发送 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。	TCP
HealthyThreshold	integer	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值范围：2~10。	2
UnhealthyThreshold	integer	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值范围：2~10。	2
HealthCheckReq	string
HealthCheckExp	string
Protocol	string	后端转发协议。取值： GENEVE。	GENEVE
RelatedLoadBalancerIds	array	关联的负载均衡实例 ID 列表。
	string	关联的负载均衡实例 ID。	gwlb-cp6prgqy40hols****
ResourceGroupId	string	资源组 ID。	rg-atstuj3rtop****
Scheduler	string	调度算法。取值： 5TCH：五元组哈希，基于五元组（源 IP、目的 IP、源端口、目的端口和协议）的一致性哈希，相同的流会调度到相同的后端服务器。 3TCH：三元组哈希，基于三元组（源 IP、目的 IP 和协议）的一致性哈希，相同的流会调度到相同的后端服务器。 2TCH：二元组哈希，基于二元组（源 IP 和目的 IP）的一致性哈希，相同的流会调度到相同的后端服务器。	5TCH
ServerCount	integer	后端服务器数量。	2
ServerGroupId	string	服务器组 ID。	sgp-atstuj3rtoptyui****
ServerGroupName	string	服务器组名称。	testServerGroupName
ServerGroupStatus	string	服务器组状态。取值： Creating：创建中。 Available：可用。 Configuring：变配中。	Available
ServerGroupType	string	服务器组类型。取值： Instance：服务器类型，该类型服务器组支持添加 Ecs、Eni、Eci 类型实例。 Ip：IP 地址类型，该类型服务器组支持直接添加 IP 地址类型的后端服务器。	Instance
ServerFailoverMode	string	服务器异常时，存量流量的处理方式。取值： NoRebalance：不重新平衡现有流量。 Rebalance：重新平衡现有流量。	NoRebalance
Tags	array<object>	标签列表。
	object	标签。
Key	string	标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	testTagKey
Value	string	标签值。最多支持 256 个字符，不能包含`http://`或`https://`。	testTagValue
VpcId	string	专用网络 ID。	vpc-bp15zckdt37pq72zv****
TotalCount	integer	列表条目数。	1

示例

正常返回示例

JSON格式

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroups": [
    {
      "ConnectionDrainConfig": {
        "ConnectionDrainEnabled": false,
        "ConnectionDrainTimeout": 300
      },
      "CreateTime": "2024-08-05T18:24:07Z",
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckConnectTimeout": 5,
        "HealthCheckDomain": "$SERVER_IP",
        "HealthCheckEnabled": true,
        "HealthCheckHttpCode": [
          "http_2xx"
        ],
        "HealthCheckInterval": 10,
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "TCP",
        "HealthyThreshold": 2,
        "UnhealthyThreshold": 2,
        "HealthCheckReq": "",
        "HealthCheckExp": ""
      },
      "Protocol": "GENEVE",
      "RelatedLoadBalancerIds": [
        "gwlb-cp6prgqy40hols****"
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "5TCH",
      "ServerCount": 2,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerGroupName": "testServerGroupName",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "ServerFailoverMode": "NoRebalance",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-bp15zckdt37pq72zv****"
    }
  ],
  "TotalCount": 1
}

错误码

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

变更历史

更多信息，参考变更详情。