DescribeServerGroupBackendServers--应用型负载均衡-火山引擎

文档中心

立即注册

导航

DescribeServerGroupBackendServers

最近更新时间：2025.04.17 11:56:34首次发布时间：2025.04.17 11:56:34

请求说明

API 名称：DescribeServerGroupBackendServers。
API 域名：open.volcengineapi.com。
API 描述：查询服务器组内的后端服务器的信息。

使用限制

节流限制：每秒最多提交 200 个 API 请求。

调试

API Explorer

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

去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称	类型	是否必选	格式	说明
Action	String	是	[a-zA-Z]+	API 名称，如 DescribeServerGroupBackendServers。
Version	String	是	YYYY-MM-DD	API 版本信息。该参数的取值是 2020-04-01 。
X-Expires	Integer	否	900	表示签名的有效时间，单位是秒，默认值是 900。

请求参数

在使用该 API 提交请求时，请求中可以包含的参数如下。

参数	类型	是否必选	参数说明	示例值
ServerGroupId	String	是	后端服务器组的 ID。	rsp-bp1o94dp5i6ea****
InstanceIds.N	String	否	后端服务器的实例 ID。 N：表示后端服务器的序号。取值范围： 1 ～ 20。多个 ID 间使用“&”分隔。参数值说明：后端服务器为云服务器时，参数值为云服务器的 ID。后端服务器为辅助网卡时，参数值为辅助网卡的 ID。后端服务器为 IP 地址时，参数值为 IP 地址。您也可以通过 `Ips.N` 参数来指定 IP 类型的后端服务器。	InstanceIds.1=i-3tkuehz8oa3vj0wz****
Ips.N	String	否	后端服务器的私网 IP 地址。 N：表示后端服务器的序号。取值范围： 1～20。	Ips.1=192.168.1.10
PageSize	Integer	否	分页查询时每页的行数。取值范围：1~100。默认值：10。当您仅指定 PageSize、未指定 PageNumber 时，返回第 1 页的数据。当您仅指定 PageNumber、未指定 PageSize 时，返回指定页的 10 条数据。但是如果指定页上没有数据，返回为空。当 PageSize 和 PageNumber 都未指定时，返回第 1 页的 10 条数据。	10
PageNumber	Integer	否	列表的页码。默认值：1。	1

返回参数

参数	类型	参数说明	示例值
RequestId	String	请求 ID。	20210811152539010225146063030****
PageSize	Integer	当前分页的行数。	20
PageNumber	Integer	当前页码。	1
TotalCount	Integer	符合条件的后端服务器总数。	50
Servers	Array	后端服务器的信息。具体参见下表 Servers 。	-

Servers

参数	类型	参数说明	示例值
ServerId	String	后端服务器的 ID。	rs-3cig8e5o0kxs06c6rrsqn****
InstanceId	String	后端服务器的实例 ID。参数值说明：后端服务器为云服务器时，参数值为云服务器的 ID。后端服务器为辅助网卡时，参数值为辅助网卡的 ID。后端服务器为 IP 地址时，参数值为 IP 地址。	i-3tkuehz8oa3vj0wz****
Type	String	后端服务器的类型： ecs：云服务器。 eni：辅助网卡。 ip：IP 地址。	ecs
RemoteEnabled	String	是否已开启远端 IP 功能。仅当后端服务器类型为 IP 地址时，会返回该参数。 on：已开启。 off：未开启。	on
Weight	Integer	后端服务器的权重。	100
Ip	String	后端服务器的私网 IP 地址。	192.XX.XX.2
Port	Integer	后端服务器接收请求的端口。	88
Description	String	后端服务器的描述。	This is a backend server

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025030616563****2252431000306F1F2",
        "Action": "DescribeServerGroupBackendServers",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2025030616563****252431000306F1F2",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "Servers": [
            {
                "ServerId": "rs-3ciw6son****46c6rrtl3tpi3",
                "InstanceId": "i-3tli51pv****j0wuvaeh",
                "Type": "ecs",
                "Weight": 100,
                "Ip": "172.**.**.242",
                "Port": 1,
                "Description": "test"
            }
        ]
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

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