调用ListServerGroups接口查询网络型负载均衡实例的服务器组列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListServerGroups

系统规定参数。取值：ListServerGroups。
ServerGroupIds.N String 否 sgp-atstuj3rtoptyui****

服务器组ID。一次最多支持查询20个服务器组ID。
ServerGroupNames.N String 否 NLB_ServerGroup

服务器组名称，一次最多支持查询20个服务器组名称。
ResourceGroupId String 否 rg-atstuj3rtop****

服务器组所属的资源组ID。
ServerGroupType String 否 Instance

服务器组类型。取值：

  • Instance：服务器类型，该类型服务器组支持添加Ecs、Ens、Eci类型实例。
  • Ip：IP地址类型，该类型服务器组支持直接添加IP地址。
VpcId String 否 vpc-bp15zckdt37pq72zv****

服务器组所在VPC的ID。
Tag.N.Key String 否 Test

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

最多支持64个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
Tag.N.Value String 否 Test

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

最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
NextToken String 否 FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults Integer 否 20

分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。
RegionId String 否 cn-hangzhou

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

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

返回数据

名称 类型 示例值 描述
RequestId String 54B28E3D-DF70-471B-AA93-08E683A1B45

请求ID。
ServerGroups Array of ServerGroup

后端服务器组列表。
RegionId String cn-hangzhou

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

ServerGroupId String sgp-atstuj3rtoptyui****

服务器组ID。
ServerGroupName String NLB_ServerGroup

服务器组名称。
ServerGroupType String Instance

服务器组类型。取值：

  • Instance：服务器类型，该类型服务器组支持添加Ecs、Ens、Eci类型实例。
  • Ip：IP地址类型，该类型服务器组支持直接添加IP地址。
AddressIPVersion String ipv4

协议版本。取值：

  • ipv4：IPv4类型。
  • DualStack：双栈类型。
VpcId String vpc-bp15zckdt37pq72zv****

服务器组所在VPC的ID。
Scheduler String Wrr

调度算法。取值：

  • Wrr：加权轮询，权重值越高的后端服务器，被轮询到的概率也越高。
  • rr：轮询，按照访问顺序依次将外部请求分发到后端服务器sch：源IP哈希：相同的源地址会调度到相同的后端服务器。
  • sch：源IP哈希，相同的源地址会调度到相同的后端服务器。
  • tch：四元组哈希，基于四元组（源IP、目的IP、源端口和目的端口）的一致性哈希，相同的流会调度到相同的后端服务器。
  • qch：QUIC ID哈希，支持将同一个QUIC ID的请求哈希到同一台后端服务器上。
Protocol String TCP

后端转发协议，取值：TCP、UDP或TCPSSL。
HealthCheck Object

健康检查配置信息。
HealthCheckEnabled Boolean false

是否开启健康检查，取值：

  • true：开启。
  • false：关闭。
HealthCheckType String TCP

健康检查协议。取值：TCP或HTTP。
HealthCheckConnectPort Integer 200

健康检查的后端服务器的端口。

取值范围： 0~65535。

0表示使用后端服务器的端口进行健康检查。
HealthyThreshold Integer 2

健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。

取值范围：2~10。
UnhealthyThreshold Integer 3

健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。

取值范围：2~10。
HealthCheckConnectTimeout Integer 200

健康检查响应的最大超时时间。单位：秒。

取值范围：1~300。
HealthCheckInterval Integer 200

健康检查的时间间隔。单位：秒。

取值范围：5~50。
HealthCheckDomain String $SERVER_IP

用于健康检查的域名。取值：

  • $SERVER_IP：使用后端服务器内网IP。
  • domain：指定特定域名。长度限制1~80个字符，只能使用小写字母、数字、短划线（-）、半角句号（.）。
说明 仅 HealthCheckType为 HTTP时，该参数生效。
HealthCheckUrl String /test/index.html

健康检查路径。

说明 仅 HealthCheckType为 HTTP时，该参数生效。
HealthCheckHttpCode Array of String http_2xx

健康状态返回码，多个状态码用半角逗号（,）分隔。

取值：http_2xx、http_3xx、http_4xx和http_5xx。

说明 仅 HealthCheckType为 HTTP时，该参数生效。
HttpCheckMethod String GET

健康检查方法，取值：GET或HEAD。

说明 仅 HealthCheckType为 HTTP时，该参数生效。
ConnectionDrainEnabled Boolean false

是否开启连接优雅中断。取值：

  • true：开启。
  • false：关闭。
ConnectionDrainTimeout Integer 200

设置连接优雅中断超时时间。单位：秒。

取值范围：10~900。
PreserveClientIpEnabled Boolean true

是否开启客户端地址保持功能。取值：

  • true：开启。
  • false：关闭。
说明 特殊说明： AddressIPVersion为 ipv4类型时默认为 true。 AddressIPVersion为 ipv6值时只能是 false，后续待底层支持后可以为 true。
AnyPortEnabled Boolean false

是否开启全端口转发。取值：

  • true：开启。
  • false：关闭。
ResourceGroupId String rg-atstuj3rtop****

服务器组所属的资源组ID。
ServerGroupStatus String Available

服务器组状态。取值：

  • Creating：创建中。
  • Available：可用。
  • Configuring：变配中。
AliUid Long 165820696622****

用户UID。
Tags Array of Tag

标签。
Key String Test

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

最多支持64个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
Value String Test

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

最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
RelatedLoadBalancerIds Array of String nlb-83ckzc8d4xlp8o****

网络型负载均衡实例列表。
ServerCount Integer 2

后端服务器数量。
TotalCount Integer 1

列表条目数。
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值，该取值表示下一次查询开始的令牌。
MaxResults Integer 20

分批次查询时每次显示的条目数。取值范围：1~100。

示例

请求示例

http(s)://[Endpoint]/?Action=ListServerGroups
&ServerGroupIds=["sgp-atstuj3rtoptyui****"]
&ServerGroupNames=["NLB_ServerGroup"]
&ResourceGroupId=rg-atstuj3rtop****
&ServerGroupType=Instance
&VpcId=vpc-bp15zckdt37pq72zv****
&Tag=[{"Key":"Test","Value":"Test"}]
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : 200,
      "HealthCheckDomain" : "$SERVER_IP",
      "HealthCheckUrl" : "/test/index.html",
      "HealthCheckHttpCode" : [ "http2xx" ],
      "HttpCheckMethod" : "GET"
    },
    "ConnectionDrainEnabled" : false,
    "ConnectionDrainTimeout" : 200,
    "PreserveClientIpEnabled" : true,
    "AnyPortEnabled" : false,
    "ResourceGroupId" : "rg-atstuj3rtop****",
    "ServerGroupStatus" : "Available",
    "Tags" : [ {
      "Key" : "Test",
      "Value" : "Test"
    } ],
    "RelatedLoadBalancerIds" : [ "nlb-83ckzc8d4xlp8o****" ],
    "ServerCount" : 2
  } ],
  "TotalCount" : 1,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 20
}

错误码

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