调用 DescribeServerGroupAttributes 接口，查询服务器组的详细信息。 ## 使用说明每秒最多提交 200 个 API 请求。 ## 调试 ## 请求参数 **Action** `String` %%require%% 示例值：`DescribeServerGroupAttributes` 接口名称。当前 API 的名称为 `DescribeServerGroupAttributes`。 **Version** `String` %%require%% 示例值：`2020-04-01` 接口版本。当前 API 的版本为 `2020-04-01`。 **ServerGroupId** `String` %%require%% 示例值：`rsp-bp1o94dp5i6ea****` 后端服务器组ID。 ## 返回参数 **RequestId** `String` `可选` 示例值：`20210811152539010225146063030****` 请求ID。 **ServerGroupId** `String` `可选` 示例值：`rsp-bp1o94dp5i6ea****` 后端服务器组的ID。 **ServerGroupName** `String` `可选` 示例值：`default_servergroup` 后端服务器组的名称。 **ServerGroupType** `String` `可选` 示例值：`instance` 后端服务器组的类型。 * instance：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。 * ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。 **Description** `String` `可选` 示例值：`This is the default servergroup` 后端服务器组的描述。 **Status** `String` `可选` 示例值：`Active` 服务器组状态。 * Creating：创建中。 * Active：运行中。 * Configuring：配置中。 * Deleting：删除中。 **VpcId** `String` `可选` 示例值：`vpc-3th8z3ajkd4bwbhc****` 后端服务器组所属 Vpc 的 ID。 **Scheduler** `String` `可选` 示例值：`wrr` 调度算法。 * wrr：加权轮询。 * wlc：加权最小连接数。 * sh：源地址哈希。 **HealthCheck** `Object` `可选` 示例值：`-` 服务器组健康检查配置信息。 **Enabled** `String` `可选` 示例值：`on` 监听器是否开启健康检查功能。 * on：开启。 * off：不开启。 **Interval** `Integer` `可选` 示例值：`2` 执行健康检查的时间间隔。单位：秒，取值：1~60s，默认值为 2。 **Timeout** `Integer` `可选` 示例值：`2` 健康检查的响应超时时间。 * 表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。 * 单位：秒，取值：1~60，默认值为 2。 **HealthyThreshold** `Integer` `可选` 示例值：`3` 健康检查的健康阈值。 * 表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。 * 单位：次，取值：2~10，默认值为 3。 **UnhealthyThreshold** `Integer` `可选` 示例值：`3` 健康检查的不健康阈值。 * 表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。 * 单位：次，取值：2~10，默认值为 3。 **Method** `String` `可选` 示例值：`HEAD` 健康检查的方法。只有 Protocol 为 HTTP 时才存在该参数。 * GET：服务器需支持GET方法。 * HEAD：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但是服务器需要支持HEAD方法。 **Domain** `String` `可选` 示例值：`www.test.com` 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 Protocol 为 HTTP 时才存在该参数。 **URI** `String` `可选` 示例值：`health` 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 Protocol 为 HTTP 时才存在该参数。 **HttpCode** `String` `可选` 示例值：`"http_2xx,http_3xx"` 健康检查正常的HTTP状态码，多个状态码间用半角逗号","分隔。只有 Protocol 为 HTTP 时才存在该参数。 * http_2xx（默认值）。 * http_3xx（默认值）。 * http_4xx 。 * http_5xx 。 **Protocol** `String` `可选` 示例值：`HTTP` 健康检查协议，当前支持 HTTP、TCP。 **Port** `Integer` `可选` 示例值：`80` 健康检查端口。参数值为0时，表示使用后端服务器端口进行健康检查。 **HttpVersion** `String` `可选` 示例值：`HTTP1.0` 健康检查HTTP协议版本，只有 Protocol 为 HTTP 时才存在该参数。 * HTTP1.0（使用API时，HTTP协议版本默认值）。 * HTTP1.1。 **Listeners** `String[]` `可选` 示例值：`[lsn-2fek3rgsxhrsw5oxruwec****,lsn-3fek4rgsxhrsw5oxruwec****]` 后端服务器组关联的监听器。 **Servers** `Object[]` `可选` 示例值：`-` 后端服务器组中服务器的信息。 **ServerId** `String` `可选` 示例值：`rs-3cig8e5o0kxs06c6rrsqn****` 后端服务器ID。 **InstanceId** `String` `可选` 示例值：`i-3tkuehz8oa3vj0wz****` 云服务器实例或网卡的ID。 **Type** `String` `可选` 示例值：`ecs` 后端服务器实例类。 * ecs：云服务器实例。 * eni：辅助网卡。 * ip：IP地址（仅 Ip 类型服务器组有效）。 **RemoteEnabled** `String` `可选` 示例值：`on` 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。 * on：开启。 * off：不开启。 **Weight** `Integer` `可选` 示例值：`100` 后端服务器的权重。 **Ip** `String` `可选` 示例值：`192.XX.XX.2` 后端服务器的私网IP地址。 **Port** `Integer` `可选` 示例值：`88` 后端服务器接收请求的端口号。 **Description** `String` `可选` 示例值：`This is a backend server` 后端服务器的描述。 **StickySessionConfig** `Object` `可选` 示例值：`-` 会话保持功能的参数信息。 **Cookie** `String` `可选` 示例值：`MY_COOKIE` 服务配置的会话保持 Cookie 名称。 **CookieTimeout** `Integer` `可选` 示例值：`1000` 会话保持 Cookie 超时时间。超时时间的取值范围：1～86400。单位：秒。 **StickySessionType** `String` `可选` 示例值：`insert` 对 Cookie 的处理方式。取值如下： * insert：植入 Cookie；ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。 * server：重写 Cookie；开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。 **StickySessionEnabled** `String` `可选` 示例值：`off` 是否开启会话保持。取值如下： * on：开启； * off：关闭。 **Protocol** `String` `可选` 示例值：`HTTP` 后端协议。 * HTTP * HTTPS **CrossZoneEnabled** `String` `可选` 示例值：`on` 服务器组是否已开启跨可用区负载均衡功能。 * on：已开启。 * off：未开启。 **ProjectName** `String` `可选` 示例值：`default` 后端服务器组所属项目名称。 **Tags** `Object[]` `可选` 示例值：`-` 服务器组所属标签。 **Key** `String` `可选` 示例值：`key` 用户标签的标签键。 **Value** `String` `可选` 示例值：`value` 用户标签的标签值。 **IpAddressType** `String` `可选` 示例值：`IPv4` 服务器组IP地址类型。 * IPv4：IPv4类型。 ## 请求示例 ```JSON GET /?Action=DescribeServerGroupAttributes&ServerGroupId=rsp-bp1o94dp5i6ea****&Version=2020-04-01 HTTP/1.1 Host: alb.cn-beijing.volcengineapi.com X-Date: 20251121T094038Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f ``` ## 返回示例 ```JSON { "ResponseMetadata": { "RequestId": "2021081716563****2252431000306F1F2", "Action": "DescribeServerGroupAttributes", "Version": "2020-04-01", "Service": "alb", "Region": "cn-beijing" }, "Result": { "RequestId": "20210817165634****252431000306F1F2", "ServerGroupId": "rsp-2fe5fl****n405oxruwbagicr", "ServerGroupName": "default_servergroup", "VpcId": "vpc-bp1aevy8sofi8mh1****", "Description": "this is the default servergroup", "HealthCheck": { "Enabled": "off", "Protocol": "HTTP", "Interval": 2, "Timeout": 2, "HealthyThreshold": 3, "UnhealthyThreshold": 3, "Method": "HEAD", "URI": "/", "Domain": "", "HttpCode": "http_2xx,http_3xx" }, "Servers": [ { "ServerId": "rs-3ciw6son****46c6rrtl3tpi3", "InstanceId": "i-3tli51pv****j0wuvaeh", "Type": "ecs", "Weight": 100, "Ip": "172.**.**.242", "Port": 1, "Description": "test" } ], "Listeners": [ "lsn-2fehbe8v****5oxruvprs4j5" ], "StickySessionConfig": { "StickySessionEnabled": "on", "StickySessionType": "insert", "Cookie": "", "CookieTimeout": 1000 }, } } ``` ## 错误码如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见[公共错误码](https://www.volcengine.com/docs/6406/113579)。 |**状态码** |**错误码** |**错误信息** |**说明** | |---|---|---|---| |404 |InvalidServerGroup.NotFound |The specified ServerGroup does not exist. |指定的服务器组不存在。 |