查询目标组列表

最近更新时间:2026-07-07 10:57:53

我的收藏

1. 接口描述

接口请求域名: alb.tencentcloudapi.com 。

查询目标组列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTargetGroups。
Version String 公共参数,本接口取值:2025-10-30。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤器。通过指定的过滤条件来查询后端服务,支持:
- Name的值为VpcId。通过VPC实例来筛选目标组。Values的值为VPC唯一ID列表。
- Name的值为TargetType。通过后端服务类型来筛选目标组。Values的值可以取为Instance
- Name的值为TargetGroupName。通过目标组名称来筛选目标组。Values的值为目标组名称列表。
- Name的值为Protocol。通过目标组后端服务协议来筛选目标组。Values的值为目标组后端服务协议列表。
- 通过标签方式筛选。
MaxResults Integer 返回列表的数量,默认为20,最大值为100
示例值:20
NextToken String 下一次查询的Token值。第一次查询和没有下一次查询时,无需填写。
如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
示例值:3974ae26e***
TargetGroupIds.N Array of String 目标组 ID 列表,ID 格式为 lbtg- 后接 8 位字母数字。
示例值:["lbtg-0zrnc9qa"]

3. 输出参数

参数名称 类型 描述
NextToken String 下一次查询的Token值,如果当前是最后一页,返回为空。
注意:此字段可能返回 null,表示取不到有效值。
示例值:3974ae26e***
TargetGroups Array of TargetGroupOutput 目标组信息。
TotalCount Integer 目标组总数。
示例值:3
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询目标组列表

输入示例

POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetGroups
<公共请求参数>

{
    "Filters": [
        {
            "Name": "Protocol",
            "Values": [
                "HTTP",
                "HTTPS"
            ]
        }
    ],
    "MaxResults": 100
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "TargetGroups": [
            {
                "TargetGroupId": "lbtg-0zrnc9qa",
                "TargetGroupName": "group1",
                "TargetType": "Instance",
                "Protocol": "HTTP",
                "VpcId": "vpc-92hffaxb",
                "SchedulerAlgorithm": "wrr",
                "CreateTime": "2026-06-03T11:18:25+08:00",
                "KeepaliveEnabled": false,
                "Tags": [],
                "RelatedLoadBalancersCount": 2,
                "TargetGroupStatus": "Active",
                "HealthCheckConfig": {
                    "HealthCheckEnabled": true,
                    "HealthCheckPort": 0,
                    "HealthCheckProtocol": "HTTP",
                    "HealthCheckCodes": [
                        "http_1xx",
                        "http_2xx",
                        "http_3xx",
                        "http_4xx"
                    ],
                    "HealthCheckInterval": 5,
                    "HealthCheckHttpVersion": "HTTP1.1",
                    "HealthCheckMethod": "HEAD",
                    "HealthCheckPath": "/",
                    "HealthCheckTimeout": 2,
                    "HealthCheckHealthyThreshold": 3,
                    "HealthCheckUnhealthyThreshold": 3,
                    "HealthCheckHost": "aaa.com"
                },
                "StickySessionConfig": {
                    "StickySessionEnabled": false
                }
            },
            {
                "TargetGroupId": "lbtg-0zrnc9qa",
                "TargetGroupName": "group2",
                "TargetType": "Instance",
                "Protocol": "HTTP",
                "VpcId": "vpc-92hffaxb",
                "SchedulerAlgorithm": "wrr",
                "CreateTime": "2026-06-03T11:17:34+08:00",
                "KeepaliveEnabled": false,
                "Tags": [],
                "RelatedLoadBalancersCount": 0,
                "TargetGroupStatus": "Active",
                "HealthCheckConfig": {
                    "HealthCheckEnabled": true,
                    "HealthCheckPort": 0,
                    "HealthCheckProtocol": "HTTP",
                    "HealthCheckCodes": [
                        "http_1xx",
                        "http_2xx",
                        "http_3xx",
                        "http_4xx"
                    ],
                    "HealthCheckInterval": 5,
                    "HealthCheckHttpVersion": "HTTP1.1",
                    "HealthCheckMethod": "HEAD",
                    "HealthCheckPath": "/",
                    "HealthCheckTimeout": 2,
                    "HealthCheckHealthyThreshold": 3,
                    "HealthCheckUnhealthyThreshold": 3,
                    "HealthCheckHost": "aaa.com"
                },
                "StickySessionConfig": {
                    "StickySessionEnabled": false
                }
            }
        ],
        "RequestId": "fb47afdf-9728-4362-ad51-7049878fca3a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码