tencent cloud

APIs

文档APIsApplication Load BalancerTarget Group APIsCreateTargetGroup

CreateTargetGroup

下载
聚焦模式
字号
最后更新时间： 2026-09-28 14:17:16

1. API Description

Domain name for API request: alb.intl.tencentcloudapi.com.

Target Group APIs

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateTargetGroup.
Version Yes String Common Params. The value used for this API: 2025-10-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TargetType Yes String

Target Group Type. Value:

  • Instance (default): Cvm server type or Eni type.
VpcId Yes String

VPC ID.
DryRun No Boolean

Whether to preview this request.

  • false (default): Send a normal request to directly create a target group.
  • true: Send a preview request to check whether the parameters, format, and service limits for target group creation meet the requirements.
HealthCheckConfig No HealthCheckConfig

Health check configuration.
KeepaliveEnabled No Boolean

Whether to enable long connections.
Protocol No String

Backend service protocol type. Values:

  • HTTP (default): supports binding HTTP and HTTPS listeners
  • HTTPS: supports binding HTTPS listeners
  • GRPC: supports binding HTTPS listeners
  • GRPCS: supports binding HTTPS listeners
SchedulerAlgorithm No String

Scheduling algorithm. Value:

  • wrr (default): weighted polling. Backend servers are selected by weight. The higher the weight, the more likely the server is to be polled.
  • wlc: weighted least connections. When different backend servers have the same weight, the server with fewer current connections is more likely to be polled.
StickySessionConfig No StickySessionConfig

Session persistence configuration.
Tags.N No Array of TagInfo

Tag.
TargetGroupName No String

Target group name, defaulting to the target group ID. It is 1-255 characters long and can contain digits, upper- and lower-case letters, Chinese characters, half-width periods (.), underscores (_), and dashes (-).

3. Output Parameters

Parameter Name Type Description
TargetGroupId String

Target group ID. The format is lbtg- followed by 8 alphanumeric characters.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a Target Group

Input Example

POST / HTTP/1.1
Host: alb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTargetGroup
<Common request parameters>

{
    "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"
}

Output Example

{
    "Response": {
        "TargetGroupId": "lbtg-0zrnc9qa",
        "RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

上一篇: DeleteTargetGroups下一篇: AddTargetsToTargetGroup

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈

搜索
    请输入关键词搜索文档