创建目标组

最近更新时间:2024-10-17 01:20:23

我的收藏

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 目标组的vpcid属性,不填则使用默认vpc
示例值:vpc-i1**
Port Integer 目标组的默认端口, 后续添加服务器时可使用该默认端口。Port和TargetGroupInstances.N中的port二者必填其一。
示例值:80
TargetGroupInstances.N Array of TargetGroupInstance 目标组绑定的后端服务器
Protocol String 网关负载均衡目标组协议。
- TENCENT_GENEVE :GENEVE 标准协议
- AWS_GENEVE:GENEVE 兼容协议(需要提交工单申请开白)
示例值:GENEVE
HealthCheck TargetGroupHealthCheck 健康检查设置。
ScheduleAlgorithm String 均衡算法。
- IP_HASH_3_ELASTIC:弹性哈希
示例值:IP_HASH_3_ELASTIC
AllDeadToAlive Boolean 是否支持全死全活。默认支持。
示例值:true

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