调用 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。|\ | | | | ||\ | | | | |* 参数 \- N：表示服务器组的序号，取值范围 1～100。|\ | | | | |* 多个服务器组ID间使用&分隔。 | |MaxResult |Integer |否 |10 |分页查询时每页的行数，取值范围为1 ~ 20，默认值为10。 | |NextToken |String |否 |caeba0bbb2be03f84eb48b699f0a\*\*\*\* |分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。 | |ProjectName |String |否 |default |服务器组所属项目的名称。 | |TagFilters.N.Key |String |否 |TagFilters.1.Key=k1&TagFilters.2.Key=k2 |标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的服务器组。|\ | | | | ||\ | | | | |* 参数 \- N：表示标签键的序号，取值范围为1～10。|\ | | | | |* 多个标签键之间使用&分隔。 | |TagFilters.N.Values.N |String |否 |TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3 |标签的标签值。|\ | | | | ||\ | | | | |* 第一个N：表示标签键的序号，取值范围 1～10。|\ | | | | |* 第二个N：表示标签值的序号，取值范围 1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的资源。|\ | | | | |* 多个标签值之间使用&分隔。|\ | | | | ||\ | | | | |:::tip|\ | | | | ||\ | | | | |* 如果传入该参数，则必须先传入`TagFilters.N.Key`。|\ | | | | |* 该参数传入空值时，表示查询指定标签键下标签值为空的资源。|\ | | | | ||\ | | | | |:::| ## 返回参数 |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |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转发流量到后端服务器时使用的通信协议。|\ | | | ||\ | | | |* TCP|\ | | | |* UDP | |Status |String |Active |服务器组的状态。 | |VpcId |String |vpc\-p2ed5i6eaefh\*\*\*\* |服务器组所属的私有网络ID。 | |ServerGroupName |String |myservergroup |服务器组的名称。 | |Type |String |instance |服务器组的类型。|\ | | | ||\ | | | |* instance：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。|\ | | | |* ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。 | |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协议。取值如下：|\ | | | ||\ | | | |* off：关闭。|\ | | | |* standard：开启。NLB将通过Proxy\-Protocol协议携带客户端源IP地址转发至服务器，还需要在服务器上配置Proxy\-Protocol。 | |HealthCheck |Array of Struct |\-\- |服务器组中后端服务器的健康检查信息。具体请参见下表“**HealthCheck**”。 | |RelatedLoadBalancerIds |Array of String |["nlb\-qwdekht56fvb\*\*\*\*", "nlb\-wtglishtbg0oi\*\*\*\*"] |服务器组关联的NLB实例。 | |ServerCount |Integer |1 |服务器组中后端服务器的数量。 | |BypassSecurityGroupEnabled|Boolean |false|是否开启了**放通后端安全组**功能。|\ | | | ||\ | | | |* true：开启。|\ | | | |* false：未开启。 | |TimestampRemoveEnabled|Boolean|false|是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。|\ | | | ||\ | | | |* true：开启。|\ | | | |* false：不开启。|\ | | | ||\ | | | |:::tip|\ | | | |本功能正在邀测中，如需试用，请联系客户经理。|\ | | | ||\ | | | |:::| |Tags |Array of Struct |\-\- |服务器组的标签信息。具体请参见下表“**Tags**”。 | **HealthCheck** |**名称** |**类型** |**示例值** |**说明** | |---|---|---|---| |Enabled |Boolean |true |是否开启健康检查功能。 | |Type |String |TCP |健康检查的类型。|\ | | | ||\ | | | |* TCP：发送SYN握手报文，以此检测后端服务器端口的状态是否正常。|\ | | | |* HTTP：发送HEAD或GET请求模拟浏览访问行为，以此检测后端服务器应用是否正常。|\ | | | |* UDP：发送ICMP或UDP探测报文，以此检测后端服务器是否正常。 | |Port |Integer |10 |健康检查的端口。|\ | | | |0表示使用后端服务器的端口进行健康检查。 | |Interval |Integer |2 |健康检查的时间间隔。 | |HealthyThreshold |Integer |3 |健康检查的健康阈值。|\ | | | |连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。 | |UnHealthyThreshold |Integer |3 |健康检查的不健康阈值。|\ | | | |连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查“异常”。 | |Timeout |Integer |2 |健康检查的响应超时时间。|\ | | | |如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。 | |Method |String |GET |健康检查的方法。|\ | | | ||\ | | | |* GET：服务器需支持GET方法。|\ | | | |* HEAD：服务器仅返回HEAD头部信息，可以降低后端开销，但要求服务器支持HEAD方法。|\ | | | ||\ | | | |:::tip|\ | | | |仅参数`Type`为“HTTP”时，返回该参数。|\ | | | ||\ | | | |:::| |Uri |String |/ |健康检查的路径。|\ | | | |:::tip|\ | | | |仅参数`Type`为“HTTP”时，返回该参数。|\ | | | ||\ | | | |:::| |Domain |String |www.test |健康检查的域名。 | |HttpCode |String |http_2xx,http_3xx |健康检查正常的HTTP状态码。|\ | | | |:::tip|\ | | | |仅参数`Type`为“HTTP”时，返回该参数。|\ | | | ||\ | | | |:::| |UdpRequest |String |Request123 |UDP健康检查的请求字符串。 | |UdpExpect |String |Expect123 |UDP健康检查的预期响应字符串。 | **Tags** |名称 |类型 |示例值 |描述 | |---|---|---|---| |Key |String |k1 |标签的标签键。 | |Value |String |v1 |标签的标签值。 | ## 请求示例 ```Plain Text 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 ``` ## 返回示例 ```Plain Text { "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": [] } ] } } ``` ## 错误码此处仅展示当前API的错误码，更多错误码请参见[公共错误码](https://www.volcengine.com/docs/6406/1264688)。 |HttpCode |错误码 |错误信息 |描述 | |---|---|---|---| |400|DryRunOperation|Exception raised to indicate a successfully authorized action when the DryRun flag is set to true. |该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。 |\ | | | | | |400 |IdempotentParameterMismatch |Arguments on this idempotent request are inconsistent with arguments used in previous request(s). |此幂等请求的参数与前一个请求中使用的参数不一致。 | |400 |InvalidClientToken.Malformed |The specified ClientToken is malformed. |指定的 ClientToken 参数格式不合法。 | |400 |InvalidIncorrectOrder.Malformed |The specified index order is malformed. |指定的索引顺序参数格式不合法。 | |400 |InvalidMaxResult.Malformed |The specified MaxResult is malformed. |指定的 MaxResult 参数格式不合法。 | |400 |InvalidMaxResults.Malformed |The specified MaxResults is malformed. |指定的 MaxResults 参数格式不合法。 | |400 |InvalidNextToken.Malformed |The specified NextToken is malformed. |指定的 NextToken 参数格式不合法。 | |400 |InvalidPaging.Malformed |The specified PageNumber or PageSize is malformed. |指定的分页参数格式不合法。 | |400 |InvalidServerGroupName.Malformed |The specified ServerGroupName is malformed. |指定的 ServerGroupName 参数格式不合法。 | |400 |InvalidTagKey.Malformed |The specified TagKey is malformed. |指定的 TagKey 参数格式不合法。 | |400 |InvalidTagValue.Malformed |The specified TagValue is malformed. |指定的 TagValue 参数格式不合法。 | |400 |InvalidType.Malformed |The specified Type is malformed. |指定的 Type 参数格式不合法。 | |400 |LimitExceeded.ServerGroupId |You've reached the limit on the number of ServerGroupId that you can operate. |已达到单次可操作后端服务器组的资源数量上限。 | |400|LimitExceeded.TagFilterKey |You've reached the limit on the number of tag keys that you can filter. |已达到单次可指定过滤标签键数量的上限。 |\ | | | | | |400 |LimitExceeded.TagFilterValues |You've reached the limit on the number of tag values that you can filter. |已达到单次可指定过滤标签键值数量的上限。 | |400 |MissingParameter|The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''. |该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如。 |\ | | | | | |409 |InvalidOperation.Conflict |The specified resource operation conflicts. |指定的资源操作冲突。 | |412 |IdempotentProcessing|The request uses the same client token as a previous one that is still in process. |幂等请求处理中。 |\ | | | | | |500 |InternalError |An internal error has occurred. |发生内部错误。 |

负载均衡