API 名称：DescribeServerGroupAttributes。
API 域名：open.volcengineapi.com 。
API 描述：查询服务器组的详细信息。
节流限制：每秒最多提交 200 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。
| 名称 | 类型 | 是否必选 | 格式 | 说明 |
|---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称，如 DescribeServerGroupAttributes。 |
| Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
| X-Expires | int | 否 | 900 | 表示签名的有效时间，单位是秒，默认值是900。 |
在使用该 API 提交请求时，请求参数中可以包含的参数如下。
| 参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
|---|---|---|---|---|
ServerGroupId | String | 是 | 后端服务器组ID。 | rsp-bp1o94dp5i6ea**** |
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
RequestId | String | 请求ID。 | 20210811152539010225146063030**** |
| ServerGroupId | String | 后端服务器组的ID。 | rsp-bp1o94dp5i6ea**** |
| ServerGroupName | String | 后端服务器组的名称。 | default_servergroup |
ServerGroupType | String | 后端服务器组的类型。取值：
| instance |
| Description | String | 后端服务器组的描述。 | This is the default servergroup |
Status | String | 服务器组状态。
| Active |
| VpcId | String | 后端服务器组所属 Vpc 的 ID。 | vpc-3th8z3ajkd4bwbhc**** |
Scheduler | String | 调度算法。取值：
| wrr |
| HealthCheck | Array | 服务器组健康检查配置信息。具体参见下表 HealthCheck 。 | - |
| Listeners | Array | 后端服务器组关联的监听器信息。具体参见下表 Listeners 。 | - |
| Servers | Array | 后端服务器组中服务器的信息。具体参见下表 Servers 。 | - |
| StickySessionConfig | Array | 会话保持功能的参数信息。具体参见下表 StickySessionConfig 。 | - |
| ProjectName | String | 后端服务器组所属项目名称。 | default |
| Tags | Array | 服务器组所属标签，具体参见下表Tags。 | - |
HealthCheck
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
HealthCheck.Enabled | String | 监听器是否开启健康检查功能。取值：
| on |
| HealthCheck.Interval | Integer | 执行健康检查的时间间隔。 单位：秒，取值：1~60s，默认值为 2。 | 2 |
HealthCheck.Timeout | Integer | 健康检查的响应超时时间。
| 2 |
HealthCheck.HealthyThreshold | Integer | 健康检查的健康阈值。
| 3 |
HealthCheck.UnhealthyThreshold | Integer | 健康检查的不健康阈值。
| 3 |
HealthCheck.Method | String | 健康检查的方法。只有Protocol为 HTTP 时才存在该参数。取值：
| HEAD |
| HealthCheck.Domain | String | 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有Protocol为 HTTP 时才存在该参数。 | www.test.com |
| HealthCheck.URI | String | 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有Protocol为 HTTP 时才存在该参数。 | health |
HealthCheck.HttpCode | String | 健康检查正常的HTTP状态码，多个状态码间用半角逗号","分隔。只有Protocol为 HTTP 时才存在该参数。取值如下：
| "http_2xx,http_3xx" |
| HealthCheck.Protocol | String | 健康检查协议，当前支持 HTTP、TCP。默认值为 HTTP。 | HTTP |
HealthCheck.HttpVersion | String | 健康检查HTTP协议版本，只有Protocol为 HTTP 时才存在该参数。取值：
| HTTP1.0 |
Listeners
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
ListenerId | String | 监听器的ID。 | lsn-2fek3rgsxhrsw5oxruwec**** |
Servers
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
ServerId | String | 后端服务器ID。 | rs-3cig8e5o0kxs06c6rrsqn**** |
| InstanceId | String | 云服务器实例或网卡的ID。 | i-3tkuehz8oa3vj0wz**** |
Type | String | 后端服务器实例类型： 支持：
| ecs |
RemoteEnabled | String | 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。取值：
| on |
| Weight | Integer | 后端服务器的权重。 | 100 |
| Ip | String | 后端服务器的私网IP地址。 | 192.XX.XX.2 |
| Port | Integer | 后端服务器接收请求的端口号。 | 88 |
| Description | String | 后端服务器的描述。 | This is a backend server |
StickySessionConfig
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
StickySessionEnabled | String | 是否开启会话保持。取值如下：
| off |
StickySessionType | String | 对 Cookie 的处理方式。取值如下：
| insert |
Cookie | String | 服务配置的会话保持 Cookie 名称。 | MY_COOKIE |
CookieTimeout | Integer | 会话保持 Cookie 超时时间。超时时间的取值范围：1～86400。 单位：秒。 | 1000 |
Tags
| 参数 | 类型 | 参数说明 | 示例 |
|---|---|---|---|
Key | String | 用户标签的标签键。具体规则如下：
| key |
Value | String | 用户标签的标签键。同一资源的标签键不允许重复。具体规则如下：
| value |
GET /?Action=DescribeServerGroupAttributes&ServerGroupId=rsp-bp1o94dp5i6ea****&Version=2020-04-01 HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: alb
{ "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 的错误码，更多错误码请参见公共错误码。
HTTP Code | 错误码 | 错误信息 | 错误描述 |
|---|---|---|---|
| 404 | InvalidServerGroup.NotFound | The specified ServerGroup does not exist. | 指定的服务器组不存在。 |