调用 DescribeServerGroups 接口，查询满足指定条件的后端服务器组。 ## 调用说明 * 传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的后端服务器组，若没有符合条件的后端服务器组，则返回空值。 * 若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有后端服务器组。 ## 调试 ## 请求参数 |**名称** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |DescribeServerGroups |要执行的操作，取值为DescribeServerGroups。 | |Version |String |是 |2020\-04\-01 |API版本信息，当前版本为：2020\-04\-01。 | |LoadBalancerId |String |否 |clb\-bp1o94dp5i6ea\*\*\*\* |负载均衡实例ID。|\ | | | | |您可以调用[DescribeLoadBalancers](https://www.volcengine.com/docs/6406/71772)接口，查询负载均衡实例ID。 | |ServerGroupName |String |否 |myservergroup |后端服务器组名称。 | |ServerGroupIds.N |String |否 |ServerGroupIds.1=rsp\-2fel9y8pxr56o5oxruuuu\*\*\*\*&ServerGroupIds.2=rsp\-1g0ogy36a8t8g8ibuxwy5\*\*\*\* |后端服务器组的ID。|\ | | | | |您可以调用[DescribeServerGroups](https://www.volcengine.com/docs/6406/71782)接口，查询后端服务器组ID。|\ | | | | ||\ | | | | |* 参数 \- N：表示后端服务器组的序号，取值范围为1 ～ 100。|\ | | | | |* 多个后端服务器组ID间使用“&”分隔。 | |Type |String |否 |instance |后端服务器组的类型。取值如下：|\ | | | | ||\ | | | | |* instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。|\ | | | | |* ip：表示该后端服务器组只能添加IP地址作为后端服务器。 | |TagFilters.N.Key |String |否 |TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3 |标签的标签键。|\ | | | | ||\ | | | | |* 参数 \- N：表示标签键的序号，取值范围：1～10。|\ | | | | |* 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的后端服务器组。|\ | | | | |* 不允许重复。 | |TagFilters.N.Values.N |String |否 |TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1 |标签的标签值。|\ | | | | ||\ | | | | |* 第一个N：表示标签键的序号，取值范围：1～10。|\ | | | | |* 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的后端服务器组。|\ | | | | |* 多个标签值之间用&分隔。|\ | | | | ||\ | | | | |:::tip|\ | | | | ||\ | | | | |* 若传入该参数，则必须先传入`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 |Array of Struct |\- |符合条件的后端服务器组的详细信息。具体请参见下表“ **ServerGroups** ”。 | ### ServerGroups |名称 |类型 |示例值 |描述 | |---|---|---|---| |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类型。|\ | | | ||\ | | | |:::tip|\ | | | |支持IPv6后端的功能正在邀测中，暂仅支持完成 [企业认证](https://www.volcengine.com/docs/6261/64937) 的账号申请试用，如需试用，请联系客户经理。|\ | | | ||\ | | | |:::| |AnyPortEnabled |String |on |是否开启全端口转发。|\ | | | ||\ | | | |* on：开启。|\ | | | |* off：关闭。|\ | | | ||\ | | | |:::tip|\ | | | |此参数正在邀测中，暂仅支持完成 [企业认证](https://www.volcengine.com/docs/6261/64937) 的账号申请试用，如需试用，请联系客户经理。|\ | | | ||\ | | | |:::| |Tags |Array of Struct |\- |标签信息。具体请参见下表“**Tags**”。 | **Tags** |名称 |类型 |示例值 |描述 | |---|---|---|---| |Key |String |k1 |标签的标签键。 | |Value |String |v1 |标签的标签值。 | ## 请求示例 ```json GET /?Action=DescribeServerGroups&Version=2020-04-01&ServerGroupIds.1=rsp-2fel9y8pxr56o5oxruuuu**** HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: clb ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "20210811152539010225146063030****", "Action": "DescribeServerGroups", "Version": "2020-04-01", "Service": "clb", "Region": "cn-beijing" }, "Result": { "RequestId": "20210811152539010225146063030****", "PageNumber": 1, "PageSize": 20, "TotalCount": 1, "ServerGroups": [ { "CreateTime": "2021-08-12T17:27:23z", "UpdateTime": "2021-08-12T17:27:23z", "ServerGroupId": "rsp-2fel9y8pxr56o5oxruuuu****", "ServerGroupName": "myservergroup", "Type": "instance", "Description": "test", "AddressIpVersion": "ipv4", "AnyPortEnabled": "off", "Tags": [ { "Key": "k1", "Value": "v1" }, { "Key": "k2", "Value": "" } ] } ] } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6406/71761)文档。 |

HttpCode

|错误码 |错误信息 |描述 |\ |---|---|---|---| | | | | | |

400

400

400

400

400

400

400

400

400