接口请求域名: gwlb.intl.tencentcloudapi.com 。
创建目标组。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateTargetGroup。 |
| Version | 是 | String | 公共参数,本接口取值:2024-09-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TargetGroupName | 否 | String | 目标组名称。命名规则:1-80 个英文字母、汉字等国际通用语言字符,数字,连接线“-”、下划线“_”等常见字符(禁止Unicode补充字符,如emoji表情、生僻汉字等)。 |
| VpcId | 否 | String | 网关负载均衡后端目标组所属的网络 ID,如vpc-12345678,可以通过 DescribeVpcs 接口获取。 不填此参数则默认为DefaultVPC。 |
| Port | 否 | Integer | 目标组的默认端口, 后续添加服务器时可使用该默认端口。Port和TargetGroupInstances.N中的port二者必填其一。仅支持6081。 |
| TargetGroupInstances.N | 否 | Array of TargetGroupInstance | 目标组绑定的后端服务器 |
| Protocol | 否 | String | 网关负载均衡目标组协议。
|
| HealthCheck | 否 | TargetGroupHealthCheck | 健康检查设置。 |
| ScheduleAlgorithm | 否 | String | 均衡算法。
|
| AllDeadToAlive | 否 | Boolean | 是否支持全死全活。默认支持。 |
| Tags.N | 否 | Array of TagInfo | 标签。 |
| ForwardingMode | 否 | String | 流量分发方式
|
| RescheduleUnbindRs | 否 | Boolean | 重新调度功能内的解绑后端服务开关,开关打开后解绑后端服务会触发重新调度。 |
| RescheduleUnbindRsStartTime | 否 | Integer | 解绑RS后开启重调度的时间,可配置0s-3600s,默认0s |
| RescheduleUnhealthy | 否 | Boolean | 重新调度功能内的后端服务健康探测异常开关,开关打开后后端服务健康检查异常会触发重新调度。 |
| RescheduleUnhealthyStartTime | 否 | Integer | 后端服务健康探测异常后开启重调度的时间,可配置0s-3600s,默认0s |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TargetGroupId | String | 创建目标组后生成的id |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
创建目标组
POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTargetGroup
<公共请求参数>
{
"VpcId": "vpc-ojtgv3oh"
}
{
"Response": {
"RequestId": "eab511f4-8f43-42ff-896b-0ee4cdf83493",
"TargetGroupId": "lbtg-fxh5qtdy"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.FormatError | InvalidParameter.FormatError |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| UnauthorizedOperation | 未授权操作。 |
文档反馈