ListServerGroups - 负载均衡

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListServerGroups	系统规定参数。取值：ListServerGroups。
ServerGroupIds.N	String	否	sgp-atstuj3rtop****	服务器组ID，一次最多支持查询20个服务器组ID。
ServerGroupNames.N	String	否	Group3	服务器组名称，一次最多支持查询10个服务器组名称。
ResourceGroupId	String	否	rg-atstuj3rtop****	资源组ID。
NextToken	String	否	FFmyTO70tTpLG6I3FmYAXG****	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults	Integer	否	20	分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。
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://`。

返回数据


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

示例

请求示例

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

正常返回示例

XML格式

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

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  } ],
  "TotalCount" : 1000
}

错误码

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