1. 接口描述
接口请求域名: alb.tencentcloudapi.com 。
目标组相关接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateTargetGroup。 |
| Version | 是 | String | 公共参数,本接口取值:2025-10-30。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TargetType | 是 | String | 目标组类型。取值: - Instance(默认):Cvm服务器类型或者Eni网卡类型。 示例值:Instance |
| VpcId | 是 | String | 私有网络 ID。 示例值:vpc-92hffaxb |
| DryRun | 否 | Boolean | 是否预览此次请求。 - false(默认):发送普通请求,直接创建目标组。 - true:发送预览请求,检查创建目标组的参数、格式、业务限制等是否符合要求。 示例值:false |
| HealthCheckConfig | 否 | HealthCheckConfig | 健康检查配置。 |
| KeepaliveEnabled | 否 | Boolean | 是否开启长连接。 示例值:true |
| Protocol | 否 | String | 后端服务协议类型。取值: - HTTP(默认):支持绑定HTTP、HTTPS的监听器 - HTTPS:支持绑定HTTPS类型的监听器 - GRPC:支持绑定HTTPS类型的监听器 - GRPCS:支持绑定HTTPS类型的监听器 示例值:HTTP |
| SchedulerAlgorithm | 否 | String | 调度算法。取值: - wrr(默认):加权轮训,按照权重选择后端服务器,权重越高的服务器被轮训到的概率越高。 - wlc:加权最小连接数,当不同后端服务器权重值相同时,当前连接数越小的后端服务器被轮询到的概率越高。 示例值:wrr |
| StickySessionConfig | 否 | StickySessionConfig | 会话保持配置。 |
| Tags.N | 否 | Array of TagInfo | 标签。 |
| TargetGroupName | 否 | String | 目标组名称。默认为目标组ID。长度为 1-255 个字符,可包含数字、大小写字母、中文、半角句号(.)、下划线(_)和短划线(-)。 示例值:test-group |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TargetGroupId | String | 目标组 ID,格式为 lbtg- 后接 8 位字母数字。 示例值:lbtg-0zrnc9qa |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建目标组
输入示例
POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTargetGroup
<公共请求参数>
{
"HealthCheckConfig": {
"HealthCheckCodes": [
"http_1xx"
],
"HealthCheckEnabled": true,
"HealthCheckHealthyThreshold": 2,
"HealthCheckHost": "example.com",
"HealthCheckHttpVersion": "HTTP1.1",
"HealthCheckInterval": 10,
"HealthCheckMethod": "GET",
"HealthCheckPath": "/hello/index.html",
"HealthCheckPort": 80,
"HealthCheckProtocol": "HTTP",
"HealthCheckTimeout": 2,
"HealthCheckUnhealthyThreshold": 2
},
"KeepaliveEnabled": true,
"Protocol": "HTTP",
"SchedulerAlgorithm": "wrr",
"StickySessionConfig": {
"Cookie": "SERVERID",
"CookieTimeout": 20,
"StickySessionEnabled": true,
"StickySessionType": "Insert"
},
"Tags": [
{
"TagKey": "key-xxx",
"TagValue": "value-xxx"
}
],
"TargetGroupName": "test-group",
"TargetType": "Instance",
"VpcId": "vpc-92hffaxb"
}
输出示例
{
"Response": {
"TargetGroupId": "lbtg-0zrnc9qa",
"RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
}
}
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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。