调用ListServerGroups查询服务器组列表。

调试

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

请求参数

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

要执行的操作。取值:ListServerGroups

ServerGroupIds Array of String sgp-atstuj3rtop****

服务器组ID,一次最多支持查询20个服务器组ID。

ServerGroupNames Array of String Group3

服务器组名称,一次最多支持查询10个服务器组名称。

ResourceGroupId String rg-atstuj3rtop****

资源组ID

NextToken String FFmyTO70tTpLG6I3FmYAXG****

用来标记当前开始读取的位置,置空表示从头开始。

MaxResults Integer 50

本次读取的最大数据记录数量,此参数为可选参数,取值1~100,入参为空时,默认值为20

VpcId String vpc-bp15zckdt37pq72zv****

VPC实例ID

返回数据

名称 类型 示例值 描述
MaxResults Integer 50

本次请求所返回的最大记录条数。

NextToken String caeba0bbb2be03f8****

用来表示当前调用返回读取到的位置,返回为空代表数据已经读取完毕。

RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID

ServerGroups Array of ServerGroup

后端服务器组列表

HealthCheckConfig Object

健康检查配置结构体

HealthCheckConnectPort Integer 80

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

取值:0~65535

默认为0,设置为0时代表使用后端服务器的端口进行健康检查。

HealthCheckEnabled Boolean true

是否启用健康检查,取值:

  • true(默认值):启用
  • false:不启用
HealthCheckHost String www.test.com

健康检查域名。字符要求:

  • 长度限制为1~80个字符。
  • 可包含小写字母、数字、短划线(-)和半角句号(.)。
  • 至少包含一个半角句号(.),半角句号(.)不能出现在开头或结尾。
  • 最右侧的地域标签,只能包含字母,不能包含数字或短划线(-)。
  • 其他地域标签,短划线(-)不能出现在开头或结尾。
说明 只有HealthCheckProtocol设置为HTTP时才需配置该参数。
HealthCheckCodes Array of String 200

健康检查正常的状态码,多个状态码用列表传入。

说明 HealthCheckProtocol为HTTP时才有该参数。

取值:http_2xxhttp_3xxhttp_4xxhttp_5xx。默认值:http_2xx

HealthCheckHttpVersion String HTTP1.1

健康检查HTTP协议版本,取值:HTTP1.0HTTP1.1(默认值)。

说明 只有HealthCheckProtocol设置为HTTP时才需配置该参数。
HealthCheckInterval Integer 5

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

取值:1~50

默认值:2

HealthCheckMethod String HEAD

健康检查方法,取值:GETHEAD(默认值)。

说明 只有HealthCheckProtocol设置为HTTP时才需配置该参数。
HealthCheckPath String /test/index.html

健康检查的转发规则路径。

长度限制为1~80,只能使用字母、数字、字符-/.%?#&=以及扩展字符_;~!()*[]@$^:',+。 URL必须以/开头。

说明 只有HealthCheckProtocol设置为HTTP时才需配置该参数。
HealthCheckProtocol String HTTP

健康检查协议,取值:HTTPTCP

HealthCheckTimeout Integer 3

接收来自运行状况检查的响应需要等待的时间。如果后端ECS在指定的时间内没有正确响应,则判定为健康检查失败。单位:秒。

取值:1~300

默认值:5

说明 如果HealthCHeckTimeout的值小于HealthCheckInterval的值,则HealthCHeckTimeout无效,超时时间为HealthCheckInterval的值。
HealthyThreshold Integer 4

健康检查连续成功多少次后,将后端服务器的健康检查状态由fail判定为success

取值:2~10

默认值:3

UnhealthyThreshold Integer 4

健康检查连续失败多少次后,将后端服务器的健康检查状态由success判定为fail

取值:2~10

默认值:3

Protocol String HTTP

后端协议,取值:

  • HTTP(默认值):支持关联HTTPS、HTTP和QUIC监听。
  • HTTPS:支持关联HTTPS监听。
ResourceGroupId String rg-atstuj3rtop****

资源组ID

Scheduler String Wrr

调度算法。取值:

  • Wrr(默认值):权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • Wlc:除了根据每台后端服务器设定的权重值来进行轮询,同时还考虑后端服务器的实际负载(即连接数)。当权重值相同时,当前连接数越小的后端服务器被轮询到的次数(概率)也越高。
  • Sch:源IP一致性Hash。
ServerGroupId String sgp-cige6j****

服务器组ID

ServerGroupName String Group3

服务器组名称

ServerGroupStatus String Available

服务器组状态。

  • Provisioning:创建中。
  • Available:可用。
  • Configuring:变配中。
StickySessionConfig Object

会话保持配置结构体

Cookie String B490B5EBF6F3CD402E515D22BCDA****

服务器上配置的Cookie。

长度为1~200个字符,只能包含ASCII英文字母和数字字符,不能包含半角逗号(,)、半角分号(;)或空格,也不能以美元符号($)开头。

说明StickySessionOnStickySessionTypeserver时,该参数必选。
CookieTimeout Integer 1000

Cookie超时时间。单位:秒。

取值:1~86400

默认值:1000

说明StickySessionEnabledtrueStickySessionTypeInsert时,该参数必选。
StickySessionEnabled Boolean true

是否启用会话保持,取值:truefalse(默认值)。

StickySessionType String Insert

Cookie的处理方式。取值:

  • Insert(默认值):植入Cookie。

    客户端第一次访问时,负载均衡会在返回请求中植入Cookie(即在HTTP或HTTPS响应报文中插入SERVERID),下次客户端携带此Cookie访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器上。

  • Server:重写Cookie。

    负载均衡发现用户自定义了Cookie,将会对原来的Cookie进行重写,下次客户端携带新的Cookie访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器。

说明StickySession的值为On时,必须指定该参数。
VpcId String vpc-bp15zckdt37pq72zv****

VPC实例ID

TotalCount Integer 1000

本次请求条件下的数据总量

示例

请求示例

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

正常返回示例

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.test.com</HealthCheckHost>
            <HealthCheckCodes>200</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>
        <StickySessionConfig>
            <Cookie>B490B5EBF6F3CD402E515D22BCDA****</Cookie>
            <CookieTimeout>1000</CookieTimeout>
            <StickySessionEnabled>true</StickySessionEnabled>
            <StickySessionType>Insert</StickySessionType>
        </StickySessionConfig>
        <VpcId>vpc-bp15zckdt37pq72zv****</VpcId>
    </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.test.com",
      "HealthCheckCodes" : [ "200" ],
      "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",
    "StickySessionConfig" : {
      "Cookie" : "B490B5EBF6F3CD402E515D22BCDA****",
      "CookieTimeout" : 1000,
      "StickySessionEnabled" : true,
      "StickySessionType" : "Insert"
    },
    "VpcId" : "vpc-bp15zckdt37pq72zv****"
  } ],
  "TotalCount" : 1000
}

错误码

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