You need to enable JavaScript to run this app.
导航

DescribeServerGroupAttributes

最近更新时间2024.03.22 08:27:45

首次发布时间2021.08.31 10:37:27

调用 DescribeServerGroupAttributes 接口查询指定后端服务器组的详细信息。

调试

请求参数

名称类型是否必填示例值
描述
ActionStringDescribeServerGroupAttributes要执行的操作,取值为DescribeServerGroupAttributes。
VersionString2020-04-01API版本信息,当前版本为:2020-04-01。
ServerGroupIdStringrsp-bp1o94dp5i6ea****后端服务器组ID。您可以调用DescribeServerGroups接口获取后端服务器组ID。

返回参数

字段类型示例值
描述
RequestIdString20210811152539010225146063030****请求ID。
LoadBalancerIdStringclb-bp1o94dp5i6ea****后端服务器组所属的负载均衡实例ID。
ServerGroupIdStringrsp-bp1o94dp5i6ea****后端服务器组ID。
ServerGroupNameStringmyservergroup后端服务器组名称。
DescriptionStringtest后端服务器组的描述。
ListenersArray of String-后端服务器组关联的监听器信息。具体请参见下表“ Listeners ”。
ServersArray of Struct-后端服务器组中服务器的信息。具体请参见下表“ Servers ”。

Type

String

instance

后端服务器组的类型。

  • instance:表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。
  • ip:表示该后端服务器组只能添加IP地址作为后端服务器。

AddressIpVersion

String

ipv4

后端服务器组的IP地址类型。

  • ipv4:表示该后端服务器组为IPv4类型。
  • ipv6:表示该后端服务器组为IPv6类型。

支持IPv6后端的功能正在邀测中,如需使用,请联系客户经理申请权限。

TagsArray of Struct-标签信息。具体请参见下表“Tags”。

Listeners

字段类型示例值
描述
ListenerIdStringlsn-2fek3rgsxhrsw5oxruwec****监听器的ID。

Servers

字段类型示例值
描述
ServerIdStringrs-3cig8e5o0kxs06c6rrsqn****后端服务器ID。
InstanceIdStringi-3tkuehz8oa3vj0wz****云服务器实例或网卡的ID。

Type

String

ecs

后端服务器实例类型。

  • ecs:云服务器实例。
  • eni:网卡。
WeightInteger100后端服务器的权重。
IpString192.XX.XX.2后端服务器的私网IP地址。
PortInteger88后端服务器接收请求的端口号。
DescriptionStringThis is a server.后端服务器的描述。

Tags

名称类型示例值描述
KeyStringk1标签的标签键。
ValueStringv1标签的标签值。

请求示例

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",
                "Port": 88,
                "Description": "This is a server."
            }
        ],
        "Listeners": [
            "lsn-2fek3rgsxhrsw5oxruwec****"
        ],
        "Tags": [
            {
                "Key": "k1",
                "Value": "v1"
            },
            {
                "Key": "k2",
                "Value": ""
            }
        ]
    }
}

错误码

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

HttpCode错误码错误信息描述

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如XXX

说明

其中,XXX表示缺少的参数名称。

404InvalidServerGroup.NotFoundThe specified ServerGroup does not exist.指定的后端服务器组不存在。