调用 DescribeServerGroups 接口，查询满足指定条件的后端服务器组。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的后端服务器组，若没有符合条件的后端服务器组，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有后端服务器组。

调试

API Explorer

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

去调试

请求参数

Action String 必选示例值：DescribeServerGroups

要执行的操作，取值：DescribeServerGroups。

Version String 必选示例值：2020-04-01

API的版本信息，当前版本为 2020-04-01。

LoadBalancerId String 可选示例值：clb-bp1o94dp5i6ea****

CLB实例ID。

您可以调用DescribeLoadBalancers接口，查询CLB实例ID。

ServerGroupName String 可选示例值：myservergroup

后端服务器组名称。

ServerGroupIds.N String 可选示例值：rsp-2fel9y8pxr56o5oxruuuu***

后端服务器组的ID。

您可以调用DescribeServerGroups接口，查询后端服务器组ID。

参数 - N：表示后端服务器组的序号，取值范围为1 ～ 100。

多个后端服务器组ID间使用“&”分隔。

Type String 可选示例值：instance

后端服务器组的类型。取值如下：

instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。

ip：表示该后端服务器组只能添加IP地址作为后端服务器。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的后端服务器组。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的后端服务器组。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的后端服务器组。

PageNumber Integer 可选示例值：1

列表的页码，默认值为1。

PageSize Integer 可选示例值：20

分页查询时每页的行数，取值范围为1 ～100，默认为10。

返回参数

RequestId String 示例值：20210811152539010225146063030****

请求ID。

TotalCount Integer 示例值：50

符合条件的后端服务器组总数。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：20

当前分页的行数。

ServerGroups Object[] 示例值：-

符合条件的后端服务器组的详细信息。

ServerGroupId String 示例值：rsp-2fel9y8pxr56o5oxruuuu****

后端服务器组的ID。

ServerGroupName String 示例值：myservergroup

后端服务器组的名称。

Type String 示例值：instance

后端服务器组的类型。

instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。

ip：表示该后端服务器组只能添加IP地址作为后端服务器。

Description String 示例值：test

后端服务器组的描述。

CreateTime String 示例值：2021-08-11T16:37:37Z

后端服务器组的创建时间。

UpdateTime String 示例值：2021-08-11T16:37:37Z

后端服务器组的最近操作时间。

AddressIpVersion String 示例值：ipv4

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

ipv4：后端服务器组为IPv4类型。

ipv6：后端服务器组为IPv6类型。

说明

支持IPv6后端的功能正在邀测中，如需试用，请联系客户经理。

AnyPortEnabled String 示例值：on

是否开启全端口转发。

on：开启。

off：关闭。

说明

此参数正在邀测中，如需试用，请联系客户经理。

Tags Object[] 示例值：-

标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

请求示例

返回示例

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidName.Malformed	The specified Name is malformed.	指定的 Name 参数格式不合法。
400	InvalidPageNumber.Malformed	The specified PageNumber is malformed.	指定的 PageNumber 参数格式不合法。
400	InvalidPageSize.Malformed	The specified PageSize is malformed.	指定的 PageSize 参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。
400	InvalidType.Malformed	The specified Type is malformed.	指定的 Type 参数格式不合法。
400	LimitExceeded.ServerGroupId	You've reached the limit on the number of ServerGroupId that you can operate.	已达到单次可操作后端服务器组的资源数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValues	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签键值数量的上限。
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如。
500	InternalError	An internal error has occurred.	发生内部错误。

负载均衡