tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateTargetGroup

Last updated: 2024-11-25 10:16:30

1. API Description

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

This API is used to create a target group. This feature is in beta testing. If you need to use it, 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: 2024-09-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TargetGroupName No String Target group name, limited to 60 characters.
VpcId No String VPCID attribute of target group. If this parameter is left blank, the default VPC will be used.
Port No Integer Default port of the target group, which can be used when servers are added later. Either 'Port' or 'TargetGroupInstances.N.port' must be filled in.
TargetGroupInstances.N No Array of TargetGroupInstance Real server bound to a target group
Protocol No String GWLB target group protocol.
- TENCENT_GENEVE: GENEVE standard protocol

- AWS_GENEVE: GENEVE compatibility protocol (a ticket is required for allowlisting)
HealthCheck No TargetGroupHealthCheck Health check settings.
ScheduleAlgorithm No String Load balancing algorithm.
- IP_HASH_3_ELASTIC: elastic hashing
AllDeadToAlive No Boolean Whether "All Dead, All Alive" is supported. It is supported by default.

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: gwlb.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

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 InvalidParameter.FormatError
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit is exceeded.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy