Release Notes and Announcements

CLB Release Notes

Product Announcements

Product Introduction

Overview

Strengths

Use Cases

Principles

Product Comparison

Use Limits

Service Regions and Service Providers

Purchase Guide

Billing Overview

Billing

CLB Resource Package

Purchase Methods

Payment Overdue

Product Attribute Selection

Getting Started

Getting Started with Domain Name-Based CLB

Getting Started with CLB

Getting Started with IPv6 CLB

Deploying Nginx on CentOS

Deploying Java Web on CentOS

Operation Guide

CLB Instance

CLB Listener

Real Server

Health Check

Certificate Management

Log Management

Monitoring and Alarm

Cloud Access Management

Classic CLB

Practical Tutorial

Deploy certificate to CLB (mutual authentication)

Enabling Gzip Compression & Testing

HTTPS Forwarding Configurations

Obtaining Real Client IPs

Best Practices for Configuring Load Balancing Monitoring Alerts

Implementing HA Across Multiple AZs

Load Balancing Algorithm Selection and Weight Configuration Examples

Configuring WAF protection for CLB listening domain names

Configure IAP to authenticate web access to the CLB domain and path

Configure IAP to authenticate programmatic access to CLB's domain and path

Ops Guide

Solution to Excessive Clients in TIME_WAIT Status

Load Balancer HTTPS Service Performance Test

Stress Testing FAQ

CLB Certificate Operation Permissions

Troubleshooting

UDP Health Check Exception

API Documentation

History

Introduction

API Category

Instance APIs

Listener APIs

Backend Service APIs

Target Group APIs

Redirection APIs

Other APIs

Classic CLB APIs

Load Balancing APIs

Making API Requests

Data Types

Error Codes

CLB API 2017

FAQs

Billing

CLB Configuration

Troubleshooting Health Check Issues

HTTPS

WS/WSS Protocol Support

HTTP/2 Protocol Support

Default Domain Name Blocking Prompt

Service Level Agreement

Glossary

CreateTargetGroup

PDF

Focus Mode

Font Size

Last updated: 2025-11-25 10:10:59

1. API Description

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

This API is used to create a target group. This feature is in beta test, if you want to try it out, please submit a ticket.

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: 2018-03-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
TargetGroupName	No	String	Target group name (up to 50 characters)
VpcId	No	String	Specifies the vpc id attribute of the target group. uses the default vpc if left empty.
Port	No	Integer	Specifies the default Port of the target group. the default Port can be used when servers are added subsequently. this parameter is not supported for full-listen target groups. for non-full-listen target groups, either Port or Port in TargetGroupInstances.N is required.
TargetGroupInstances.N	No	Array of TargetGroupInstance	Specifies the real servers bound to the target group. supports up to 50 at a time.
Type	No	String	Target group type, currently supported v1 (legacy version target group) and v2 (new version target group), defaults to v1 (legacy version target group).
Protocol	No	String	Backend forwarding protocol of the target group. this field is required for the new version (v2) target group. currently supports TCP, UDP, HTTP, HTTPS, GRPC.
HealthCheck	No	TargetGroupHealthCheck	Health check.
ScheduleAlgorithm	No	String	Scheduling algorithm. this parameter is valid only for target groups of the new version V2 when the backend forwarding protocol is HTTP, HTTPS, or GRPC. available values:. WRR: weighted round-robin. LEAST_CONN: LEAST connection. IP_HASH: based on IP HASH. default is WRR. .
Tags.N	No	Array of TagInfo	Tag.
Weight	No	Integer	Specifies the default weight of the backend service. among them:. Value ranges from 0 to 100. after setting this value, when adding a backend service to the target group, if the backend service does not set Weight separately, use the default Weight here. Weight parameter settings not supported for v1 target group type. .
FullListenSwitch	No	Boolean	Full listen target group flag. valid values: true (yes), false (no). only target groups of the new version V2 event type support this parameter.
KeepaliveEnable	No	Boolean	Specifies whether to enable the persistent connection feature. this parameter applies only to HTTP and HTTPS target groups. 0: disable; 1: enable. this feature is off by default.
SessionExpireTime	No	Integer	Session hold time, unit: second. value range: 30-3600. default: 0, disabled. this parameter is supported only for target groups with HTTP/HTTPS/GRPC backend forwarding protocol in the new version V2.
IpVersion	No	String	IP version type.

3. Output Parameters

Parameter Name	Type	Description
TargetGroupId	String	ID generated after target group creation
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

This example shows you how to create a target group.

Input Example

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

{
    "VpcId": "vpc-i1cnjuhx",
    "Port": 80,
    "TargetGroupName": "czhtest"
}

Output Example

{
    "Response": {
        "TargetGroupId": "lbtg-81******",
        "RequestId": "9a4096dd-45a1-4e03-be8e-482a2fb48b59"
    }
}

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

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameter.FormatError	Wrong parameter format.
InvalidParameterValue	Incorrect parameter value.
LimitExceeded	Quota exceeded.
UnauthorizedOperation	Unauthorized operation.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Load Balancer