You need to enable JavaScript to run this app.
文档中心
负载均衡

负载均衡

复制全文
下载 pdf
服务器组
DescribeServerGroupBackendServers - 查询服务器组的后端服务器信息
复制全文
下载 pdf
DescribeServerGroupBackendServers - 查询服务器组的后端服务器信息
调用 DescribeServerGroupBackendServers 接口,查询服务器组的后端服务器信息。​
使用说明​
每秒最多提交 200 个 API 请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeServerGroupBackendServers​
要执行的操作,取值:DescribeServerGroupBackendServers。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
ServerGroupId string 必选 示例值:rsp-bp1o94dp5i6ea****​
后端服务器组的 ID。​
​
InstanceIds.N string[] 可选 示例值:InstanceIds.1=i-3tkuehz8oa3vj0wz****​
后端服务器的实例 ID。​
  • 参数-N:表示后端服务器的序号。取值范围: 1~20。​
  • 多个 ID 间使用“&”分隔。​
参数值说明:​
  • 后端服务器为云服务器时,参数值为云服务器的 ID。​
  • 后端服务器为辅助网卡时,参数值为辅助网卡的 ID。​
  • 后端服务器为 IP 地址时,参数值为 IP 地址。您也可以通过 Ips.N 参数来指定 IP 类型的后端服务器。​
​
Ips.N string[] 可选 示例值:Ips.1=192.168.1.10​
后端服务器的私网 IP 地址。​
参数 - N:表示后端服务器的序号。取值范围: 1~20。​
​
PageSize integer 可选 示例值:10​
分页查询时每页的行数。​
  • 取值范围:1~100。默认值:10。​
  • 当您仅指定 PageSize、未指定 PageNumber 时,返回第 1 页的数据。当您仅指定 PageNumber、未指定 PageSize 时,返回指定页的 10 条数据。但是如果指定页上没有数据,返回为空。当 PageSize 和 PageNumber 都未指定时,返回第 1 页的 10 条数据。​
​
PageNumber integer 可选 示例值:1​
列表的页码。默认值:1。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId string 示例值:20210811152539010225146063030****​
请求 ID。​
​
PageSize integer 示例值:20​
当前分页的行数。​
​
PageNumber integer 示例值:1​
当前页码。​
​
TotalCount integer 示例值:50​
符合条件的后端服务器总数。​
​
Servers object[] 示例值:--​
后端服务器的信息。​
ServerId string 示例值:rs-3cig8e5o0kxs06c6rrsqn****​
后端服务器ID。​
​
InstanceId string 示例值:i-3tkuehz8oa3vj0wz****​
云服务器实例或网卡的ID。​
​
Type string 示例值:ecs​
后端服务器实例类型。​
  • ecs:云服务器实例。​
  • eni:辅助网卡。​
  • ip:IP地址(仅 Ip 类型服务器组有效)。​
​
RemoteEnabled string 示例值:on​
是否开启远端IP功能。当后端服务器实例类型为IP地址,即 Type 取值为 ip 时,此字段有效。​
  • on:开启。​
  • off:不开启。​
​
Weight integer 示例值:100​
后端服务器的权重。​
​
Ip string 示例值:192.XX.XX.2​
后端服务器的私网IP地址。​
​
Port integer 示例值:88​
后端服务器接收请求的端口号。​
​
Description string 示例值:This is a backend server​
后端服务器的描述。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeServerGroupBackendServers&ServerGroupId=rsp-bp1o94dp5i6ea****&Version=2020-04-01 HTTP/1.1​
Host: alb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2021081716563****2252431000306F1F2",​
"Action": "DescribeServerGroupBackendServers",​
"Version": "2020-04-01",​
"Service": "alb",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "20210817165634****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"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
Data unmarshal failed.​
请求解析失败。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, '%s'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: %s。​
400​
Invalid%s.Malformed​
MismatchThe specified %s is malformed.​
指定的 %s 参数格式不合法。​
400​
InvalidPaging.Malformed​
The specified PageNumber or PageSize is malformed.​
指定的分页参数格式不合法。​
400​
LimitExceed.BackendServer​
You've reached the limit on the number of backend servers that you can operate at a time.​
已达到单次可操作的后端服务器的数量上限。​
404​
InvalidServerGroup.NotFound​
The specified ServerGroup does not exist.​
指定的服务器组不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。请稍后重试或联系工程师进一步咨询。​
​
​
最近更新时间:2026.05.19 15:30:36
这个页面对您有帮助吗?
有用
有用
无用
无用