文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>负载均衡>API 文档>目标组相关接口>创建目标组

创建目标组

最近更新时间：2025-09-17 01:23:12

我的收藏

本页目录：

1. 接口描述

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

创建目标组。该功能正在内测中，如需使用，请通过工单申请。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateTargetGroup。
Version 是 String 公共参数，本接口取值：2018-03-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
TargetGroupName 否 String 目标组名称，限定50个字符
示例值：test-name
VpcId 否 String 目标组的vpcId属性，不填则使用默认vpc。
示例值：vpc-i1**
Port 否 Integer 目标组的默认端口， 后续添加服务器时可使用该默认端口。全监听目标组不支持此参数，非全监听目标组Port和TargetGroupInstances.N中的port二者必填其一。

示例值：80
TargetGroupInstances.N 否 Array of TargetGroupInstance 目标组绑定的后端服务器，单次最多支持50个。
Type 否 String 目标组类型，当前支持v1(旧版目标组), v2(新版目标组), 默认为v1(旧版目标组)。
示例值：v1
Protocol 否 String 目标组后端转发协议。v2新版目标组该项必填。目前支持TCP、UDP、HTTP、HTTPS、GRPC。
示例值：TCP
HealthCheck 否 TargetGroupHealthCheck 健康检查。
ScheduleAlgorithm 否 String 调度算法，仅V2新版目标组，且后端转发协议为(HTTP|HTTPS|GRPC)时该参数有效。可选值：
<ur>
  • WRR:按权重轮询。
  • LEAST_CONN:最小连接数。
  • IP_HASH:按IP哈希。
  • 默认为 WRR。
    • <ur>
    示例值：WRR
    Tags.N 否 Array of TagInfo 标签。
    Weight 否 Integer 后端服务默认权重, 其中：
    • 取值范围[0, 100]
    • 设置该值后，添加后端服务到目标组时， 若后端服务不单独设置权重， 则使用这里的默认权重。
    • v1 目标组类型不支持设置 Weight 参数。

    示例值：100
    FullListenSwitch 否 Boolean 全监听目标组标识，true表示是全监听目标组，false表示不是全监听目标组。仅V2新版类型目标组支持该参数。
    示例值：true
    KeepaliveEnable 否 Boolean 是否开启长连接，此参数仅适用于HTTP/HTTPS目标组，0:关闭；1:开启， 默认关闭。
    示例值：true
    SessionExpireTime 否 Integer 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。仅V2新版且后端转发协议为HTTP/HTTPS/GRPC目标组支持该参数。
    示例值：30
    IpVersion 否 String IP版本类型。
    示例值：IPv4

    3. 输出参数

    参数名称 类型 描述
    TargetGroupId String 创建目标组后生成的id
    示例值：lbtg-81**
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建目标组

    创建目标组

    输入示例

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

{
    "VpcId": "vpc-i1cnjuhx",
    "Port": 80,
    "TargetGroupName": "czhtest"
}

    输出示例

    {
    "Response": {
        "TargetGroupId": "lbtg-81******",
        "RequestId": "9a4096dd-45a1-4e03-be8e-482a2fb48b59"
    }
}

    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 参数错误。
    InvalidParameter.FormatError 参数格式错误。
    InvalidParameterValue 参数取值错误。
    LimitExceeded 超过配额限制。
    UnauthorizedOperation 未授权操作。
    中国站
    目录