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

负载均衡

复制全文
下载 pdf
后端服务器组
DescribeServerGroupAttributes - 查询服务器组详细信息
复制全文
下载 pdf
DescribeServerGroupAttributes - 查询服务器组详细信息
调用 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****​
后端服务器组所属的CLB实例ID。​
​
ServerGroupId String 示例值:rsp-bp1o94dp5i6ea****​
后端服务器组ID。​
​
ServerGroupName String 示例值:myservergroup​
后端服务器组名称。​
​
Description String 示例值:test​
后端服务器组的描述。​
​
Listeners String[] 示例值:["lsn-2fek3rgsxhrsw5oxruwec****"]​
后端服务器组关联的监听器信息。​
​
Servers Object[] 示例值:-​
后端服务器组中服务器的信息。​
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地址。​
​
Port Integer 示例值:88​
后端服务器接收请求的端口号。​
说明​
参数AnyPortEnabled为“on”时,该参数返回空。​
​
Description String 示例值:This is a server.​
后端服务器的描述。​
​
​
Type String 示例值:instance​
后端服务器组的类型。​
  • instance:表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。​
  • ip:表示该后端服务器组只能添加IP地址作为后端服务器。​
​
AddressIpVersion String 示例值:ipv4​
后端服务器组的IP地址类型。​
  • ipv4:IPv4类型。​
  • ipv6:IPv6类型。​
支持IPv6后端的功能正在邀测中,如需试用,请联系客户经理。​
​
Tags Object[] 示例值:-​
标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
AnyPortEnabled String 示例值:on​
后端服务器组是否开启全端口转发。​
  • on:开启。​
  • off:关闭。​
说明​
该参数正在邀测中,如需试用,请联系客户经理。​
​
​
​
请求示例​
​
GET /?Action=DescribeServerGroupAttributes&Version=2020-04-01&ServerGroupId=rsp-bp1o94dp5i6ea****​
Host: clb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeServerGroupAttributes",​
"Version": "2020-04-01",​
"Service": "clb",​
"Region": "cn-beijing"​
},​
"Result": {​
"AddressIpVersion": "ipv4",​
"AnyPortEnabled": "on",​
"Description": "test",​
"Listeners": [​
"lsn-2fek3rgsxhrsw5oxruwec****"​
],​
"LoadBalancerId": "clb-bp1o94dp5i6ea****",​
"RequestId": "20210811152539010225146063030****",​
"ServerGroupId": "rsp-bp1o94dp5i6ea****",​
"ServerGroupName": "myservergroup",​
"Servers": [​
{​
"Ip": "192.XX.XX.2",​
"Port": 88,​
"Type": "ecs",​
"Weight": 100,​
"ServerId": "rs-3cig8e5o0kxs06c6rrsqn****",​
"InstanceId": "i-3tkuehz8oa3vj0wz****",​
"Description": "This is a server."​
}​
],​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Type": "instance"​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'ServerGroupId'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如 ServerGroupId。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如 。​
404​
InvalidServerGroup.NotFound​
The specified ServerGroup does not exist.​
指定的后端服务器组不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2026.02.13 10:32:59
这个页面对您有帮助吗?
有用
有用
无用
无用