调用 DescribeNLBServerGroups 接口，查询满足指定条件的服务器组。
| 名称 | 类型 | 是否必选 | 示例值 | 说明 |
|---|---|---|---|---|
| Action | String | 是 | DescribeNLBServerGroups | 要执行的操作，取值为DescribeNLBServerGroups。 |
| Version | String | 是 | 2020-04-01 | API版本信息，当前版本为2020-04-01。 |
| VpcId | String | 否 | vpc-bp1o94dp5i6ea**** | 服务器所属的私有网络ID。 |
| ServerGroupName | String | 否 | myservergroup | 服务器组的名称。 |
| Type | String | 否 | instance | 服务器组类型。 |
ServerGroupIds.N | String | 否 | ServerGroupIds.1=rsp-2fel9y8pxr56o5oxruuuu****&ServerGroupIds.2=rsp-1g0ogy36a8t8g8ibuxwy5**** | 服务器组的ID。
|
| MaxResult | Integer | 否 | 10 | 分页查询时每页的行数，取值范围为1 ~ 20，默认值为10。 |
| NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。 |
TagFilters.N.Key | String | 否 | TagFilters.1.Key=k1&TagFilters.2.Key=k2 | 标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的服务器组。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3 | 标签的标签值。
说明
|
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 2024092952539010225146063030**** | 请求ID。 |
| NextToken | String | caeba0bbb2be03f84eb48b699f0a**** | 本次调用返回的查询凭证值，返回为空表示没有下一页。 |
| ServerGroups | Array of Struct | -- | 符合条件的服务器组的详细信息。具体请参见下表“ ServerGroups ”。 |
ServerGroups
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CreateTime | String | 2024-08-11T16:37:37Z | 服务器组的创建时间。 |
| UpdateTime | String | 2024-08-11T16:37:37Z | 服务器组的最近操作时间。 |
| AccountId | String | 2100066126 | 服务器组所属的账号ID。 |
| ProjectName | String | default | 服务器组所属项目的名称。 |
| ServerGroupId | String | rsp-bp1o94dp5i6ea**** | 服务器组的ID。 |
| Protocol | String | TCP | NLB转发流量到后端服务器时使用的通信协议。 |
| Status | String | Active | 服务器组的状态。 |
| VpcId | String | vpc-p2ed5i6eaefh**** | 服务器组所属的私有网络ID。 |
| ServerGroupName | String | myservergroup | 服务器组的名称。 |
Type | String | instance | 服务器组的类型。
|
| Description | String | test | 服务器组的描述。 |
| Scheduler | String | wrr | 调度算法。 |
| IpAddressVersion | String | ipv4 | 服务器组的IP版本。 |
| AnyPortEnabled | Boolean | true | 是否开启全端口转发。 |
| ConnectionDrainEnabled | Boolean | true | 是否开启连接优雅中断。 |
| ConnectionDrainTimeout | Integer | 60 | 连接优雅中断超时时间。 |
| PreserveClientIpEnabled | Boolean | true | 是否开启源地址保持。 |
| SessionPersistenceEnabled | Boolean | true | 是否开启会话保持。 |
| SessionPersistenceTimeout | Integer | 60 | 会话保持超时时间。 |
ProxyProtocolType | String | off | 是否启用Proxy-Protocol协议。取值如下：
|
| HealthCheck | Array of Struct | -- | 服务器组中后端服务器的健康检查信息。具体请参见下表“HealthCheck”。 |
| RelatedLoadBalancerIds | Array of String | ["nlb-qwdekht56fvb****", "nlb-wtglishtbg0oi****"] | 服务器组关联的NLB实例。 |
| ServerCount | Integer | 1 | 服务器组中后端服务器的数量。 |
| Tags | Array of Struct | -- | 服务器组的标签信息。具体请参见下表“Tags”。 |
HealthCheck
| 名称 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| Enabled | Boolean | true | 是否开启健康检查功能。 |
Type | String | TCP | 健康检查的类型。取值如下：
|
Port | Integer | 10 | 健康检查的端口。 |
| Interval | Integer | 2 | 健康检查的时间间隔。 |
HealthyThreshold | Integer | 3 | 健康检查的健康阈值。 |
UnHealthyThreshold | Integer | 3 | 健康检查的不健康阈值。 |
Timeout | Integer | 2 | 健康检查的响应超时时间。 |
Method | String | GET | 健康检查的方法。
说明 仅参数 |
Uri | String | / | 健康检查的路径。 说明 仅参数 |
| Domain | String | www.test | 健康检查的域名。 |
HttpCode | String | http_2xx,http_3xx | 健康检查正常的HTTP状态码。 说明 仅参数 |
Tags
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | k1 | 标签的标签键。 |
| Value | String | v1 | 标签的标签值。 |
GET /?Action=DescribeNLBServerGroups&Version=2020-04-01&ServerGroupIds.1=rsp-2fe5afscd6nls59gp67fk****&ServerGroupIds.2=rsp-2fe5afmf9uhog59gp680g**** HTTP/1.1 Host: open.volcengineapi.com Region: cn-guangzhou Service: clb
{ "ResponseMetadata": { "RequestId": "2024092952539010225146063030****", "Action": "DescribeNLBServerGroups", "Version": "2020-04-01", "Service": "clb", "Region": "cn-guangzhou" }, "Result": { "RequestId": "2024092952539010225146063030****", "NextToken": "", "ServerGroups": [ { "CreateTime": "2024-09-25T06:30:23Z", "UpdateTime": "2024-09-25T06:33:58Z", "AccountId": "210005****", "ProjectName": "default", "ServerGroupId": "rsp-2fe5afscd6nls59gp67fk****", "Protocol": "TCP", "Status": "Active", "VpcId": "vpc-12auqlk66uvi817q7y20e****", "ServerGroupName": "hyh-2", "Type": "instance", "Description": "", "Scheduler": "wrr", "IpAddressVersion": "ipv4", "AnyPortEnabled": false, "ConnectionDrainEnabled": false, "PreserveClientIpEnabled": true, "SessionPersistenceEnabled": false, "ProxyProtocolType": "off", "HealthCheck": { "Enabled": true, "Type": "TCP", "Interval": 10, "HealthyThreshold": 3, "UnhealthyThreshold": 3, "Timeout": 5 }, "RelatedLoadBalancerIds": [ "nlb-2fe5af0pxlvy859gp68ag****" ], "ServerCount": 1, "Tags": [] }, { "CreateTime": "2024-09-25T06:28:05Z", "UpdateTime": "2024-09-25T06:28:06Z", "AccountId": "210005****", "ProjectName": "default", "ServerGroupId": "rsp-2fe5afmf9uhog59gp680g****", "Protocol": "TCP", "Status": "Active", "VpcId": "vpc-12agbbyq03ls017q7y2o5****", "ServerGroupName": "hyh", "Type": "instance", "Description": "", "Scheduler": "wrr", "IpAddressVersion": "ipv4", "AnyPortEnabled": false, "ConnectionDrainEnabled": false, "PreserveClientIpEnabled": true, "SessionPersistenceEnabled": false, "ProxyProtocolType": "off", "HealthCheck": { "Enabled": true, "Type": "TCP", "Interval": 10, "HealthyThreshold": 3, "UnhealthyThreshold": 3, "Timeout": 5 }, "RelatedLoadBalancerIds": [ "nlb-2fe5ahfkoi9s059gp683y****" ], "ServerCount": 0, "Tags": [] } ] } }
您可访问公共错误码，获取更多错误码信息。