查询网络型负载均衡实例的服务器组列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nlb:ListServerGroups | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ServerGroupIds | array | 否 | 服务器组 ID。一次最多支持查询 20 个服务器组 ID。 | |
| string | 否 | 服务器组 ID。一次最多支持查询 20 个服务器组 ID。 | sgp-atstuj3rtoptyui**** | |
| ServerGroupNames | array | 否 | 服务器组名称，一次最多支持查询 20 个服务器组名称。 | |
| string | 否 | 服务器组名称，一次最多支持查询 20 个服务器组名称。 | NLB_ServerGroup | |
| ResourceGroupId | string | 否 | 服务器组所属的资源组 ID。 | rg-atstuj3rtop**** |
| ServerGroupType | string | 否 | 服务器组类型。取值：
| Instance |
| VpcId | string | 否 | 服务器组所在 VPC 的 ID。 | vpc-bp15zckdt37pq72zv**** |
| Tag | object [] | 否 | 标签。 | |
| Key | string | 否 | 标签键。最多支持 10 个标签键。 最多支持 64 个字符，不能以 | Test |
| Value | string | 否 | 标签值。最多支持 10 个标签值。 最多支持 128 个字符，不能以 | Test |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer | 否 | 分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。 | 20 |
| RegionId | string | 否 | 网络型负载均衡实例所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "54B28E3D-DF70-471B-AA93-08E683A1B45",
"ServerGroups": [
{
"RegionId": "cn-hangzhou",
"ServerGroupId": "sgp-atstuj3rtoptyui****",
"ServerGroupName": "NLB_ServerGroup",
"ServerGroupType": "Instance",
"AddressIPVersion": "ipv4",
"VpcId": "vpc-bp15zckdt37pq72zv****",
"Scheduler": "Wrr",
"Protocol": "TCP",
"HealthCheck": {
"HealthCheckEnabled": false,
"HealthCheckType": "TCP",
"HealthCheckConnectPort": 200,
"HealthyThreshold": 2,
"UnhealthyThreshold": 3,
"HealthCheckConnectTimeout": 200,
"HealthCheckInterval": 10,
"HealthCheckDomain": "$SERVER_IP",
"HealthCheckUrl": "/test/index.html",
"HealthCheckHttpCode": [
"http_2xx"
],
"HttpCheckMethod": "GET"
},
"ConnectionDrainEnabled": false,
"ConnectionDrainTimeout": 200,
"PreserveClientIpEnabled": true,
"AnyPortEnabled": false,
"ResourceGroupId": "rg-atstuj3rtop****",
"ServerGroupStatus": "Available",
"AliUid": 0,
"Tags": [
{
"Key": "Test",
"Value": "Test"
}
],
"RelatedLoadBalancerIds": [
"nlb-83ckzc8d4xlp8o****"
],
"ServerCount": 2
}
],
"TotalCount": 1,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 20
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | SystemBusy | System is busy, please try again later. | 系统繁忙，请稍后重试 |
| 403 | Forbidden.%s | Authentication is failed for %s. | 当前资源或者操作%s鉴权失败 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限，所以鉴权失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-09-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-09-18 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|