製品アップデート情報
製品に関するお知らせ
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 (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:. |
| Tags.N | No | Array of TagInfo | Tag. |
| Weight | No | Integer | Specifies the default weight of the backend service. among them:.
|
| 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. |
| 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. |
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>
{
"VpcId": "vpc-i1cnjuhx",
"Port": 80,
"TargetGroupName": "czhtest"
}{
"Response": {
"TargetGroupId": "lbtg-81******",
"RequestId": "9a4096dd-45a1-4e03-be8e-482a2fb48b59"
}
}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 | Wrong parameter format. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | Quota exceeded. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック