最近更新时间：2023.11.16 15:51:41
首次发布时间：2021.08.31 10:37:27
调用 DescribeServerGroups 接口查询后端服务器组列表。
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeServerGroups | 要执行的操作，取值为DescribeServerGroups。 |
| Version | String | 是 | 2020-04-01 | API版本信息，当前版本为：2020-04-01。 |
| LoadBalancerId | String | 否 | clb-bp1o94dp5i6ea**** | 后端服务器所属的负载均衡实例ID。您可以调用DescribeLoadBalancers接口获取负载均衡实例ID。 |
| ServerGroupName | String | 否 | myservergroup | 后端服务器组名称。 |
ServerGroupIds.N | String | 否 | ServerGroupIds.1=rsp-2fel9y8pxr56o5oxruuuu****&ServerGroupIds.2=rsp-1g0ogy36a8t8g8ibuxwy5**** | 后端服务器组的ID。您可以调用DescribeServerGroups接口获取后端服务器组ID。
|
| PageSize | Integer | 否 | 20 | 分页查询时每页的行数，取值范围为1 ～100，默认为10。 |
| PageNumber | Integer | 否 | 1 | 列表的页码，默认值为1。 |
Type | String | 否 | instance | 后端服务器组的类型。取值如下：
|
| 字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 20210811152539010225146063030**** | 请求ID。 |
| PageSize | Integer | 20 | 当前分页的行数。 |
| PageNumber | Integer | 1 | 当前页码。 |
| TotalCount | Integer | 50 | 符合条件的后端服务器组总数。 |
| ServerGroups | Array of Struct | - | 符合条件的后端服务器组的详细信息。具体请参见下表“ ServerGroups ”。 |
| 字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ServerGroupId | String | rsp-2fel9y8pxr56o5oxruuuu**** | 后端服务器组的ID。 |
| ServerGroupName | String | myservergroup | 后端服务器组的名称。 |
Type | String | instance | 后端服务器组的类型。
|
| Description | String | test | 后端服务器组的描述。 |
| CreateTime | String | 2021-08-11T16:37:37Z | 后端服务器组的创建时间。 |
| UpdateTime | String | 2021-08-11T16:37:37Z | 后端服务器组的最近操作时间。 |
AddressIpVersion | String | ipv4 | 后端服务器组的IP地址类型。
|
GET /?Action=DescribeServerGroups&Version=2020-04-01&ServerGroupIds.1=rsp-2fel9y8pxr56o5oxruuuu**** HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: clb
{ "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" } ] } }
此处仅展示当前API的错误码，更多错误码请参见公共错误码。
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidName.Malformed | The specified Name is malformed. | 指定的 Name 参数格式不合法。 |
| 400 | InvalidType.Malformed | The specified Type is malformed. | 指定的 Type 参数格式不合法。 |
| 400 | InvalidPaging.Malformed | The specified PageNumber or PageSize is malformed. | 指定的分页参数格式不合法。 |
| 400 | LimitExceeded.ServerGroupId | You've reached the limit on the number of ServerGroupId that you can operate. | 已达到单次可操作后端服务器组的资源数量上限。 |