You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /应用型负载均衡/开发指南/API 参考/服务器组接口/DescribeServerGroups
DescribeServerGroups
最近更新时间：2024.07.19 16:53:03首次发布时间：2022.05.20 22:06:30
我的收藏

请求说明

API 名称：DescribeServerGroups。
API 域名：open.volcengineapi.com 。
API 描述：查询服务器组列表。

使用限制

节流限制：每秒最多提交 200 个 API 请求。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称，如 DescribeServerGroups 。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint否900表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数类型是否必选参数说明示例值
VpcId
String否后端服务器组所属 Vpc 的 ID。
vpc-3th8z3ajkd4bwbhc****
ServerGroupIds.N

List of String

否

后端服务器组的ID。

  • - N：表示后端服务器组的序号，取值：1 ～ 20。

  • 多个后端服务器组ID间使用“&”分隔。
ServerGroupIds.1=rsp-2fel9y8pxr56o5oxruuuu****&ServerGroupIds.2=rsp-1g0ogy36a8t8g8ibuxwy5****
ServerGroupNames.N

List of String

否

后端服务器组的名称。

  • - N：表示后端服务器组的序号，取值：1 ～ 10。

  • 多个后端服务器组ID间使用“&”分隔。
ServerGroupNames.1=servergroup_1&ServerGroupNames.2=servergroup_2

ServerGroupType

String

否

后端服务器组的类型。取值：

  • instance（默认值）：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。

  • ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。

instance

PageSize
Integer否分页查询时每页的行数，取值1~100，默认为10。10
PageNumber
Integer否列表的页码，默认值为1。1
ProjectNameString否后端服务器组所属项目名称。default
TagFiltersArray否服务器组所属标签，具体参见下表 TagFilters。

TagFilters

参数类型是否必选参数说明示例

TagFilters.N.Key

String

否

ALB服务器组标签的标签键。 指定多个标签键时，表示查询同时包含所有指定标签键的ALB服务器组。

TagFilters.1.Key=k1&TagFilters.2.Key=k2

TagFilters.N.Values.N

String

否

ALB服务器组标签的标签值。如果传入该参数，则必须先传入TagFilters.N.Key。具体规则如下：

  • 每个标签键最多可指定3个标签值。

  • 同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联ALB服务器组的集合。

  • 未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的ALB服务器组。

  • 该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的ALB服务器组。

TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3

返回参数

参数类型参数说明示例值
RequestId
String
请求ID。
20210811152539010225146063030****
PageSizeInteger当前分页的行数。20
PageNumberInteger当前页码。1
TotalCountInteger符合条件的后端服务器组总数。50
ServerGroupsArray符合条件的后端服务器组详细信息。具体参见下表 ServerGroup 。-

ServerGroup

参数类型参数说明示例值
ServerGroupId
String
后端服务器组的ID。
rsp-2fel9y8pxr56o5oxruuuu****
ServerGroupNameString后端服务器组的名称。default_servergroup

ServerGroupType

String

后端服务器组的类型。取值：

  • instance（默认值）：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。

  • ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。

instance

DescriptionString后端服务器组的描述。this is the default servergroup
CreateTimeString后端服务器组的创建时间。2021-08-11T16:37:37Z
UpdateTimeString后端服务器组的最近操作时间。2021-08-11T16:37:37Z
VpcIdString后端服务器组所属 Vpc 的 ID。vpc-3th8z3ajkd4bwbhc****

Status

String

服务器组状态。

  • Creating：创建中。
  • Active：运行中。
  • Configuring：配置中。
  • Deleting：删除中。

Active

Scheduler

String

调度算法。取值：

  • wrr（默认值）：加权轮询。

  • wlc：加权最小连接数。

  • sh：源地址哈希。

wrr

ServerCountInteger服务器组内后端服务器的个数。50
ListenersArray后端服务器组关联的监听器信息。具体参见下表 Listeners 。-
HealthCheckArray服务器组健康检查配置信息。具体参见下表 HealthCheck 。-
StickySessionConfigArray会话保持功能的参数信息。具体参见下表 StickySessionConfig 。-
ProjectNameString后端服务器组所属项目名称。default
TagsArray服务器组所属标签，具体参见下表 Tags。-

Listeners

参数类型参数说明示例值
ListenerId
String
监听器的ID。
lsn-2fek3rgsxhrsw5oxruwec****

HealthCheck

参数类型参数说明示例值

HealthCheck.Enabled

String

监听器是否开启健康检查功能。取值：

  • on：开启（默认值）。

  • off：不开启。

on

HealthCheck.IntervalInteger执行健康检查的时间间隔。 单位：秒，取值：1~60s，默认值为 2。2

HealthCheck.Timeout

Integer

健康检查的响应超时时间。

  • 表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。

  • 单位：秒，取值：1~60，默认值为 2。

2

HealthCheck.HealthyThreshold

Integer

健康检查的健康阈值。

  • 表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。

  • 单位：次，取值：2~10，默认值为 3。

3

HealthCheck.UnhealthyThreshold

Integer

健康检查的不健康阈值。

  • 表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。

  • 单位：次，取值：2~10，默认值为 3。

3

HealthCheck.Method

String

健康检查的方法。只有 Protocol 为 HTTP 时才存在该参数。取值：

  • GET（默认）：服务器需支持GET方法。

  • HEAD：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但是服务器需要支持HEAD方法。

HEAD

HealthCheck.DomainString健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 Protocol 为 HTTP 时才存在该参数。www.test.com
HealthCheck.URIString健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 Protocol 为 HTTP 时才存在该参数。health

HealthCheck.HttpCode

String

健康检查正常的HTTP状态码，多个状态码间用半角逗号","分隔。只有 Protocol 为 HTTP 时才存在该参数。取值如下：

  • http_2xx（默认值）。

  • http_3xx（默认值）。

  • http_4xx 。

  • http_5xx 。

"http_2xx,http_3xx"
HealthCheck.ProtocolString健康检查协议，当前支持HTTP、TCP。默认值为 HTTP。HTTP

HealthCheck.HttpVersion

String

健康检查HTTP协议版本，只有 Protocol 为 HTTP 时才存在该参数。取值：

  • HTTP1.0（使用API时，HTTP协议版本默认值）。

  • HTTP1.1。

HTTP1.0

StickySessionConfig

参数类型参数说明示例值

StickySessionConfig.StickySessionEnabled

String

是否开启会话保持。取值如下：

  • on：开启；

  • off：关闭。

off

StickySessionConfig.StickySessionType

String

对 Cookie 的处理方式。取值如下：

  • insert：植入 Cookie；

    ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

  • server：重写 Cookie；

    开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

insert

StickySessionConfig.Cookie

String

服务配置的会话保持 Cookie 名称。

MY_COOKIE

StickySessionConfig.CookieTimeout

Integer

会话保持 Cookie 超时时间。超时时间的取值范围：1～86400。 单位：秒。

1000

Tags

参数类型参数说明示例

Key

String

用户标签的标签键。具体规则如下：

  • 长度限制为1～128个字符。

  • 大小写敏感。

  • 不能以volc:的任意大小写组合开头。

  • 不能以空格开头或结尾。

  • 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

  • 同一资源的标签键不允许重复。

key

Value

String

用户标签的标签键。同一资源的标签键不允许重复。具体规则如下：

  • 长度限制为1～128个字符。

  • 大小写敏感。

  • 不能以volc:的任意大小写组合开头。

  • 不能以空格开头或结尾。

  • 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

  • 同一资源的标签键不允许重复。

value

示例

请求示例

GET /?Action=DescribeServerGroups&ServerGroupIds.1=rsp-1g0lh2f1a****8ibuxx6z7fm8&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "DescribeServerGroups",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },      
    "Result": {
        "RequestId": "2021081217541****225142142051FC26C",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "ServerGroups": [
            {
                "CreateTime": "2021-08-12T17:27:23z",
                "UpdateTime": "2021-08-12T17:27:23z",
                "ServerGroupId": "rsp-1g0lh2f1****k8ibuxx6z7fm8",
                "ServerGroupName": "test",
                "Description": "test",
                "VpcId": "vpc-bp1aevy8sofi8mh1****",
                "Scheduler": "wrr",
                "ServerCount": "10",
                "HealthCheck": {
                    "Enabled": "on",
                    "Interval": 2,
                    "Timeout": 2,
                    "HealthyThreshold": 3,
                    "UnHealthyThreshold": 3,
                    "Method": "GET",
                    "Domain": "www.test.com",
                    "URI": "/",
                    "HttpCode": "http_2xx,http_3xx"
                }
            }
        ],
        "Listeners": [
            "lsn-1g0swr****gu88ibuxwmboj9h",
            "lsn-1g0swr****gu88ibuxwmboj9x"
        ],
        "StickySessionConfig": {
            "StickySessionEnabled": "on",
            "StickySessionType": "insert",
            "Cookie": "",
            "CookieTimeout": 1000
        },
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code

错误码

错误信息

错误描述

400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。

400

LimitExceed.ServerGroup

You've reached the limit on the number of server groups that you can operate at a time.

已达到单次可操作的服务器组的数量上限。

400

InvalidServerGroupName.Malformed

The specified ServerGroupName is malformed.

指定的 ServerGroupName 参数格式不合法。

400

InvalidServerGroupType.Malformed

The specified ServerGroupType is malformed.

指定的 ServerGroupType 参数格式不合法。