Help & DocumentationCloud Load BalancerAPI DocumentationCLB APIsCreateTargetGroup

CreateTargetGroup

Last updated: 2020-03-16 17:04:17

PDF

1. API Description

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

This API is used to create a target group. (The target group feature is currently in beta test. To try it out, submit a ticket for application.)

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateTargetGroup.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. 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 vpcid attribute of a target group. If this parameter is left empty, the default VPC will be used.
Port No Integer Default port of a target group, which can be used for subsequently added servers.
TargetGroupInstances.N No Array of TargetGroupInstance Real server bound to a target group

3. Output Parameters

Parameter Name Type Description
TargetGroupId String ID generated after target group creation
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a target group

Input Example

https://clb.tencentcloudapi.com/?Action=CreateTargetGroup
&TargetGroupName=czhtest
&VpcId=vpc-i1cnjuhx
&Port=80
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.
InvalidParameterValue Wrong parameter value.
LimitExceeded Reached quota.
UnauthorizedOperation Unauthorized operation.