调用 DescribeNLBServerGroupAttributes 接口，查询指定服务器组的详细信息。

调试

API Explorer

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

去调试

请求参数

Action String 必选示例值：DescribeNLBServerGroupAttributes

要执行的操作，取值为 DescribeNLBServerGroupAttributes。

Version String 必选示例值：2020-04-01

API版本信息，当前版本为 2020-04-01。

ServerGroupId String 必选示例值：rsp-bp1o94dp5i6ea****

服务器组ID。

您可以调用DescribeNLBServerGroups接口，查询服务器组ID。

返回参数

RequestId String 示例值：2024092952539010225146063030****

请求ID。

ServerGroupName String 示例值：myservergroup

服务器组的名称。

Description String 示例值：test

服务器组的描述。

ServerGroupId String 示例值：rsp-bp1o94dp5i6ea****

服务器组的ID。

AccountId String 示例值：2100066126

服务器组所属的账号ID。

Protocol String 示例值：TCP

NLB转发流量到后端服务器时使用的通信协议。

TCP

UDP

Type String 示例值：instance

服务器组的类型。

instance：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为服务器。

ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为服务器。

IpAddressVersion String 示例值：ipv4

服务器组的IP版本。

Scheduler String 示例值：wrr

调度算法。

VpcId String 示例值：vpc-p2ed5i6eaefh****

服务器组所属的私有网络ID。

ServerCount Integer 示例值：1

服务器组中后端服务器的数量。

Servers Object[] 示例值：--

服务器组中后端服务器的信息。

ServerId String 示例值：rs-wgftyj4fk****

后端服务器的ID。

InstanceId String 示例值：eni-wghjtfg4rth5****

后端服务器的实例ID或IP地址。

Type String 示例值：eni

后端服务器的类型。

ecs：云服务器实例（即主网卡）

eni：辅助网卡

ip：IP地址

Weight Integer 示例值：100

后端服务器的权重。

取值范围：0 ～ 100。

权重为0，表示不会将请求转发给该服务器。

Ip String 示例值：192.XX.XX.3

后端服务器的私网IP地址。

Port Integer 示例值：80

后端服务器提供服务的端口。

Description String 示例值：test

后端服务器的描述。

HealthCheck Object 示例值：--

服务器组中后端服务器的健康检查信息。

Enabled Boolean 示例值：true

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

true ：开启。

false：关闭。

Type String 示例值：HTTP

健康检查的类型。

TCP：发送SYN握手报文，以此检测后端服务器端口的状态是否正常。

HTTP：发送HEAD或GET请求模拟浏览访问行为，以此检测后端服务器应用是否正常。

UDP：发送ICMP或UDP探测报文，以此检测后端服务器是否正常。

Port Integer 示例值：10

健康检查的端口。

0表示使用后端服务器的端口进行健康检查。

Interval Integer 示例值：2

健康检查的时间间隔。

HealthyThreshold Integer 示例值：3

健康检查的健康阈值。

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

Timeout Integer 示例值：2

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

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

Method String 示例值：GET

健康检查的方法。

GET：服务器需支持GET方法。

HEAD：服务器仅返回HEAD头部信息，可以降低后端开销，但要求服务器支持HEAD方法。

说明

仅参数Type为“HTTP”时，返回该参数。

Uri String 示例值：/

健康检查的路径。

说明

仅参数Type为“HTTP”时，返回该参数。

Domain String 示例值：www.test

健康检查的域名。

HttpCode String 示例值：http_2xx,http_3xx

健康检查正常的HTTP状态码。

说明

仅参数Type为“HTTP”时，返回该参数。

UdpRequest String 示例值：Request123

UDP健康检查的请求字符串。

UdpExpect String 示例值：Expect123

UDP健康检查的预期响应字符串。

UnhealthyThreshold Integer 示例值：3

健康检查的不健康阈值。

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

RelatedLoadBalancerIds String[] 示例值：["nlb-qwdekht56fvb****", "nlb-wtglishtbg0oi****"]

服务器组关联的NLB实例。

BypassSecurityGroupEnabled Boolean 示例值：false

是否开启了放通后端安全组功能。

true：开启。

false：未开启。

ProxyProtocolType String 示例值：off

是否启用Proxy-Protocol协议。取值如下：

off：关闭。

standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至服务器，还需要在服务器上配置Proxy-Protocol。

AnyPortEnabled Boolean 示例值：true

是否开启全端口转发。

true：开启。

false：关闭。

ConnectionDrainEnabled Boolean 示例值：true

是否开启连接优雅中断。

true：开启。

false：关闭。

ConnectionDrainTimeout Integer 示例值：60

连接优雅中断超时时间。

PreserveClientIpEnabled Boolean 示例值：true

是否开启源地址保持。

true ：开启。

false：关闭。

SessionPersistenceEnabled Boolean 示例值：true

是否开启会话保持。

SessionPersistenceTimeout Integer 示例值：60

会话保持超时时间。

TimestampRemoveEnabled Boolean 示例值：false

是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。

true：开启。

false：不开启。

说明

本功能正在邀测中，如需试用，请联系客户经理。

Tags Object[] 示例值：--

服务器组的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

ProjectName String 示例值：default

服务器组所属项目的名称。

Status String 示例值：Active

服务器组的状态。

CreateTime String 示例值：2024-08-11T16:37:37Z

服务器组的创建时间。

UpdateTime String 示例值：2024-08-11T16:37:37Z

服务器组的最近操作时间。

请求示例

返回示例

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

状态码	错误码	错误信息	说明
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 参数格式不合法。
404	InvalidServerGroup.NotFound	The specified ServerGroup does not exist.	指定的后端服务器组不存在。
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.	幂等请求处理中。

负载均衡