API 文档

查询目标组信息

最近更新时间:2021-03-18 08:04:12

我的收藏

1. 接口描述

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

查询目标组信息

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTargetGroups。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
TargetGroupIds.N Array of String 目标组ID,与Filters互斥。
Limit Integer 显示条数限制,默认为20。
Offset Integer 显示的偏移起始量。
Filters.N Array of Filter 过滤条件数组,与TargetGroupIds互斥,支持TargetGroupVpcId和TargetGroupName。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 显示的结果数量。
TargetGroupSet Array of TargetGroupInfo 显示的目标组信息集合。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据ID查询目标组信息

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeTargetGroups
&TargetGroupIds.0=lbtg-5xunivs0
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "TargetGroupSet": [
      {
        "TargetGroupId": "lbtg-5xunivs0",
        "VpcId": "vpc-i1cnjuhx",
        "TargetGroupName": "tg111_for_l4",
        "Port": 111,
        "CreatedTime": "2019-07-14 16:18:43",
        "UpdatedTime": "2019-07-14 16:18:43",
        "AssociatedRule": [
          {
            "LocationId": "loc-jjqr0ric",
            "Domain": "aaaa.com",
            "Url": "/",
            "ListenerId": "lbl-m2q6sp9m",
            "Port": 80,
            "Protocol": "http",
            "LoadBalancerId": "lb-phbx2420",
            "LoadBalancerName": "lb-12f60e5",
            "ListenerName": "aaa"
          },
          {
            "LocationId": null,
            "Domain": null,
            "Url": null,
            "ListenerId": "lbl-ow27ut6y",
            "Port": 777,
            "Protocol": "tcp",
            "LoadBalancerId": "lb-phbx2420",
            "LoadBalancerName": "lb-12f60e5",
            "ListenerName": "asdfsdf"
          }
        ]
      }
    ],
    "RequestId": "53f129a5-0ab5-4514-a629-f4c33af11892"
  }
}

示例2 根据条件查询目标组信息

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeTargetGroups
&Filters.0.Name=TargetGroupVpcId
&Filters.0.Values.0=vpc-i1cnjuhx
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 3,
    "TargetGroupSet": [
      {
        "TargetGroupId": "lbtg-5xunivs0",
        "VpcId": "vpc-i1cnjuhx",
        "TargetGroupName": "tg111_for_l4",
        "Port": 111,
        "CreatedTime": "2019-07-14 16:18:43",
        "UpdatedTime": "2019-07-14 16:18:43",
        "AssociatedRule": [
          {
            "LocationId": "loc-jjqr0ric",
            "Domain": "aaaa.com",
            "Url": "/",
            "ListenerId": "lbl-m2q6sp9m",
            "Port": 80,
            "Protocol": "http",
            "LoadBalancerId": "lb-phbx2420",
            "LoadBalancerName": "lb-12f60e5",
            "ListenerName": "aaa"
          },
          {
            "LocationId": null,
            "Domain": null,
            "Url": null,
            "ListenerId": "lbl-ow27ut6y",
            "Port": 777,
            "Protocol": "tcp",
            "LoadBalancerId": "lb-phbx2420",
            "LoadBalancerName": "lb-12f60e5",
            "ListenerName": "asdfsdf"
          }
        ]
      },
      {
        "TargetGroupId": "lbtg-dxnp10nc",
        "VpcId": "vpc-i1cnjuhx",
        "TargetGroupName": "tg111_for_l41563508267",
        "Port": 111,
        "CreatedTime": "2019-07-19 11:51:08",
        "UpdatedTime": "2019-07-19 11:51:07",
        "AssociatedRule": []
      },
      {
        "TargetGroupId": "lbtg-bjfi6nt6",
        "VpcId": "vpc-i1cnjuhx",
        "TargetGroupName": "tg111_for_l41563508507",
        "Port": 111,
        "CreatedTime": "2019-07-19 11:55:08",
        "UpdatedTime": "2019-07-19 11:55:08",
        "AssociatedRule": []
      }
    ],
    "RequestId": "412c7de5-47f6-4153-bf1b-77ef37e15244"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
UnauthorizedOperation 未授权操作。
目录