DescribeNLBServerGroupAttributes--负载均衡-火山引擎

文档中心

导航

DescribeNLBServerGroupAttributes

最近更新时间：2024.12.04 17:10:14首次发布时间：2024.12.04 17:10:14

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

请求参数

名称	类型	是否必选	示例值	说明
Action	String	是	DescribeNLBServerGroupAttributes	要执行的操作，取值为DescribeNLBServerGroupAttributes。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ServerGroupId	String	是	rsp-bp1o94dp5i6ea****	服务器组ID。您可以调用DescribeNLBServerGroups接口获取服务器组ID。

返回参数

名称	类型	示例值	描述
RequestId	String	2024092952539010225146063030****	请求ID。
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	服务器组的类型。 instance：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为服务器。 ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为服务器。
Description	String	test	服务器组的描述。
Scheduler	String	wrr	调度算法。
IpAddressVersion	String	ipv4	服务器组的IP版本。
AnyPortEnabled	Boolean	true	是否开启全端口转发。 true：开启。 false：关闭。
ConnectionDrainEnabled	Boolean	true	是否开启连接优雅中断。 true：开启。 false：关闭。
ConnectionDrainTimeout	Integer	60	连接优雅中断超时时间。
PreserveClientIpEnabled	Boolean	true	是否开启源地址保持。 true ：开启。 false：关闭。
SessionPersistenceEnabled	Boolean	true	是否开启会话保持。
SessionPersistenceTimeout	Integer	60	会话保持超时时间。
ProxyProtocolType	String		是否启用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	服务器组中后端服务器的数量。
Tags	Array of Struct	--	服务器组的标签信息。具体请参见下表“Tags”。

HealthCheck

名称	类型	示例值	说明
Enabled	Boolean	true	监听器是否开启健康检查功能。 true ：开启。 false：关闭。
Type	String	HTTP	健康检查的类型。 TCP：通过发送SYN握手报文来检测服务器端口是否可达。 HTTP：通过发送请求模拟浏览器访问行为，来检测服务器应用是否健康。
Port	Integer	10	健康检查的端口。 0表示使用后端服务器的端口进行健康检查。
Interval	Integer	2	健康检查的时间间隔。
HealthyThreshold	Integer	3	健康检查的健康阈值。连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
UnHealthyThreshold	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”时，返回该参数。

Tags

名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

Servers

名称	类型	示例值	说明
ServerId	String	rs-wgftyj4fk****	后端服务器的ID。
InstanceId	String	eni-wghjtfg4rth5****	后端服务器的实例ID或IP地址。
Type	String	eni	后端服务器的类型。 ecs：云服务器实例（即主网卡） eni：辅助网卡 ip：IP地址
Weight	Integer	100	后端服务器的权重，取值：0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
Ip	String	192.XX.XX.3	后端服务器的私网IP地址。
Port	Integer	80	后端服务器提供服务的端口。
Description	String	test	后端服务器的描述。
ZoneId	String	cn-guangzhou-a	后端服务器支持接收哪些可用区的访问流量。

请求示例

GET /?Action=DescribeNLBServerGroupAttributes&Version=2020-04-01&ServerGroupId=rsp-2fe5fln405oxruwbagicr**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024092952539010225146063030****",
        "Action": "DescribeNLBServerGroupAttributes",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "2024092952539010225146063030****",
        "CreateTime": "2024-09-29T03:48:47Z",
        "UpdateTime": "2024-09-29T03:50:57Z",
        "AccountId": "210005****",
        "ProjectName": "default",
        "ServerGroupId": "rsp-2fe5fln405oxruwbagicr****",
        "Protocol": "TCP",
        "Status": "Active",
        "VpcId": "vpc-impu4x01bta88gbssymw****",
        "ServerGroupName": "hyh-q",
        "Type": "instance",
        "Description": "",
        "Scheduler": "wrr",
        "IpAddressVersion": "ipv4",
        "AnyPortEnabled": true,
        "ConnectionDrainEnabled": false,
        "PreserveClientIpEnabled": true,
        "SessionPersistenceEnabled": false,
        "ProxyProtocolType": "off",
        "HealthCheck": {
            "Enabled": true,
            "Type": "HTTP",
            "Port": 80,
            "Interval": 10,
            "HealthyThreshold": 3,
            "UnhealthyThreshold": 3,
            "Timeout": 3,
            "Method": "HEAD",
            "Uri": "/",
            "Domain": "www.test.com",
            "HttpCode": "http_2xx"
        },
        "RelatedLoadBalancerIds": [],
        "ServerCount": 0,
        "Tags": [],
        "Servers": [
            {
                "ServerId": "rs-2fe5ag46tuku859gp67lb****",
                "InstanceId": "i-yddygw0cn4h9l3bp****",
                "Type": "ecs",
                "Weight": 100,
                "Ip": "192.XX.XX.5",
                "Port": 80,
                "Description": "",
                "ZoneID": "cn-guangzhou-a"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。