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

文档中心

立即注册

导航

DescribeServerGroupAttributes

最近更新时间：2024.10.22 14:30:43首次发布时间：2021.08.31 10:37:27

调用 DescribeServerGroupAttributes 接口，查看指定后端服务器组的详情。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeServerGroupAttributes	要执行的操作，取值为DescribeServerGroupAttributes。
Version	String	是	2020-04-01	API版本信息，当前版本为：2020-04-01。
ServerGroupId	String	是	rsp-bp1o94dp5i6ea****	后端服务器组ID。您可以调用DescribeServerGroups接口，查询后端服务器组ID。

返回参数

名称	类型	示例值	描述
RequestId	String	20210811152539010225146063030****	请求ID。
LoadBalancerId	String	clb-bp1o94dp5i6ea****	后端服务器组所属的负载均衡实例ID。
ServerGroupId	String	rsp-bp1o94dp5i6ea****	后端服务器组ID。
ServerGroupName	String	myservergroup	后端服务器组名称。
Description	String	test	后端服务器组的描述。
Listeners	Array of String	-	后端服务器组关联的监听器信息。具体请参见下表“ Listeners ”。
Servers	Array of Struct	-	后端服务器组中服务器的信息。具体请参见下表“ Servers ”。
Type	String	instance	后端服务器组的类型。 instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。 ip：表示该后端服务器组只能添加IP地址作为后端服务器。
AddressIpVersion	String	ipv4	后端服务器组的IP地址类型。 ipv4：IPv4类型。 ipv6：IPv6类型。支持IPv6后端的功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。
Tags	Array of Struct	-	标签信息。具体请参见下表“Tags”。

Listeners

名称	类型	示例值	描述
ListenerId	String	lsn-2fek3rgsxhrsw5oxruwec****	监听器的ID。

Servers

名称	类型	示例值	描述
ServerId	String	rs-3cig8e5o0kxs06c6rrsqn****	后端服务器ID。
InstanceId	String	i-3tkuehz8oa3vj0wz****	云服务器实例或网卡的ID。
Type	String	ecs	后端服务器实例类型。 ecs：云服务器实例。 eni：辅助网卡。 ip：IP地址。
Weight	Integer	100	后端服务器的权重。
Ip	String	192.XX.XX.2	后端服务器的私网IP地址。
AnyPortEnabled	String	off	是否开启全端口转发。 on：开启。 off：关闭。说明本参数功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。
Port	Integer	88	后端服务器接收请求的端口号。说明参数AnyPortEnabled为“on”时，该参数返回空。
Description	String	This is a server.	后端服务器的描述。

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

请求示例

GET /?Action=DescribeServerGroupAttributes&Version=2020-04-01&ServerGroupId=rsp-bp1o94dp5i6ea**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeServerGroupAttributes",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "LoadBalancerId": "clb-bp1o94dp5i6ea****",
        "ServerGroupId": "rsp-2fel9y8pxr56o5oxruuuu****",
        "ServerGroupName": "myservergroup",
        "Description": "test",
        "Type": "instance",
        "AddressIpVersion": "ipv4",
        "Servers": [
            {
                "ServerId": "rs-3cig8e5o0kxs06c6rrsqn****",
                "InstanceId": "i-3tkuehz8oa3vj0wz****",
                "Type": "ecs",
                "Weight": 100,
                "Ip": "192.XX.XX.2",
                "AnyPortEnabled": "off",
                "Port": 88,
                "Description": "This is a server."
            }
        ],
        "Listeners": [
            "lsn-2fek3rgsxhrsw5oxruwec****"
        ],
        "Tags": [
            {
                "Key": "k1",
                "Value": "v1"
            },
            {
                "Key": "k2",
                "Value": ""
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
404	InvalidServerGroup.NotFound	The specified ServerGroup does not exist.	指定的后端服务器组不存在。