网关负载均衡创建目标组

1. 接口描述

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

创建目标组。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateTargetGroup。
Version	是	String	公共参数，本接口取值：2024-09-06。
Region	是	String	公共参数，详见产品支持的地域列表。
TargetGroupName	否	String	目标组名称，限定60个字符。示例值：test-name
VpcId	否	String	网关负载均衡后端目标组所属的网络 ID，如vpc-12345678，可以通过 DescribeVpcs 接口获取。不填此参数则默认为DefaultVPC。示例值：vpc-i1**
Port	否	Integer	目标组的默认端口，后续添加服务器时可使用该默认端口。Port和TargetGroupInstances.N中的port二者必填其一。仅支持6081。示例值：6081
TargetGroupInstances.N	否	Array of TargetGroupInstance	目标组绑定的后端服务器
Protocol	否	String	网关负载均衡目标组协议。- TENCENT_GENEVE ：GENEVE 标准协议- AWS_GENEVE：GENEVE 兼容协议示例值：TENCENT_GENEVE
HealthCheck	否	TargetGroupHealthCheck	健康检查设置。
ScheduleAlgorithm	否	String	均衡算法。 IP_HASH_2_CONSISTENT：二元组一致性哈希 IP_HASH_3_CONSISTENT：三元组一致性哈希 IP_HASH_5_CONSISTENT：五元组一致性哈希示例值：IP_HASH_5_CONSISTENT
AllDeadToAlive	否	Boolean	是否支持全死全活。默认支持。示例值：true
Tags.N	否	Array of TagInfo	标签。
ForwardingMode	否	String	流量分发方式 STATELESS：无状态 STATEFUL：有状态示例值：STATEFUL
TcpIdleConnectTimeout	否	Integer	TCP协议连接空闲超时时间，可配置60s-6000s，默认350s。示例值：100
OthersIdleConnectTimeout	否	Integer	其他协议连接空闲超时时间，可配置5s-180s，默认120s 示例值：100
RescheduleUnbindRs	否	Boolean	重新调度功能内的解绑后端服务开关，开关打开后解绑后端服务会触发重新调度。示例值：true
RescheduleUnbindRsStartTime	否	Integer	解绑RS后开启重调度的时间，可配置0s-3600s，默认0s 示例值：200
RescheduleUnhealthy	否	Boolean	重新调度功能内的后端服务健康探测异常开关，开关打开后后端服务健康检查异常会触发重新调度。示例值：true
RescheduleUnhealthyStartTime	否	Integer	后端服务健康探测异常后开启重调度的时间，可配置0s-3600s，默认0s 示例值：100

3. 输出参数

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

4. 示例

示例1 创建目标组

输入示例

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

{
    "VpcId": "vpc-ojtgv3oh"
}

输出示例

{
    "Response": {
        "RequestId": "eab511f4-8f43-42ff-896b-0ee4cdf83493",
        "TargetGroupId": "lbtg-fxh5qtdy"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.FormatError	InvalidParameter.FormatError
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
UnauthorizedOperation	未授权操作。

创建目标组

本页目录：