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.
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. Naming rule: 1-80 English letters, Chinese characters and other internationally compatible language characters, digits, connecting line "-", underscore "_" and other common characters (Unicode supplementary characters such as emoji and rare Chinese characters are forbidden). |
| VpcId | No | String | The vpcId attribute of the target group. Leave it blank to use the default VPC. |
| Port | No | Integer | Default port of target group. Default port can be used when servers are added subsequently. Full listen target group does not support this parameter. For non-full listen target group, either Port or port in TargetGroupInstances.N is required. |
| TargetGroupInstances.N | No | Array of TargetGroupInstance | The target group supports up to 50 real servers bound to it. |
| Type | No | String | Target Group Type, currently supported v1 (legacy version target group), 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 target group v2. Currently supports TCP, UDP, HTTP, HTTPS, GRPC. |
| HealthCheck | No | TargetGroupHealthCheck | Health check. |
| ScheduleAlgorithm | No | String | Scheduling algorithm. This parameter is valid only for new version V2 target groups with backend forwarding protocol (HTTP |
| Tags.N | No | Array of TagInfo | Tag. |
| Weight | No | Integer | Default weight of the backend service, where:
|
| FullListenSwitch | No | Boolean | Full listen target group flag. true: yes, false: no. Only target groups of the new version V2 support this parameter. |
| KeepaliveEnable | No | Boolean | Whether to enable long connections. This parameter is applicable only to HTTP/HTTPS target groups. 0: off; 1: on. Off by default. |
| SessionExpireTime | No | Integer | Session persistence time, unit: second. Available values: 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. |
| SnatEnable | No | Boolean | Whether SNAT (source IP replacement) is enabled, True (enabled), False (disabled). Disabled by default. Note: When SnatEnable is enabled, the client source IP will be replaced. At this point, the |
| Parameter Name | Type | Description |
|---|---|---|
| TargetGroupId | String | Generated id 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. |
This example shows you how to create a target group.
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTargetGroup
<Common request parameters>
{
"TargetGroupName": "targetgroup-****",
"VpcId": "vpc-lkdo****"
}
{
"Response": {
"RequestId": "f4ab1513-d0b8-4cf2-9836-a600a7f77d2f",
"TargetGroupId": "lbtg-e2ft****"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Incorrect parameter format. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded | The quota limit is exceeded. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック