AssociateTargetGroups

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

AssociateTargetGroups

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 bind target groups to Cloud Load Balancer listeners (Layer-4 protocol) or forwarding rules (L7 protocol).
This API is asynchronous. After it returns a successful result, you need to call the DescribeTaskStatus API with the returned RequestID as input parameter to check whether this task is successful.
This API is used to describe restrictions.
-Binding a legacy version target group to a Layer-4 listener requires the listener to have backend target groups enabled.
-Layer-7 bind target group. LocationId is a required item in the data structure TargetGroupAssociation.
-The VPC of the Cloud Load Balancer must match the VPC of the target group.

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: AssociateTargetGroups.
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.
Associations.N	Yes	Array of TargetGroupAssociation	Specifies the binding relationship array. the target group type should be the same. Specifies the maximum number of requests supported in a single request is 20.

3. Output Parameters

Parameter Name	Type	Description
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 Binding layer-7 forwarding rules to target groups

Input Example

https://clb.intl.tencentcloudapi.com/?Action=AssociateTargetGroups
&Associations.0.LoadBalancerId=lb-phbx2420
&Associations.0.ListenerId=lbl-m2q6sp9m
&Associations.0.LocationId=loc-jjqr0ric
&Associations.0.TargetGroupId=lbtg-5xunivs0
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "dd2f3116-421c-4eda-8401-b9ddefcc65d5"
    }
}

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.
FailedOperation.ResourceInOperating	The specified resource is currently being operated. Please try again later.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameterValue	Incorrect parameter value.
LimitExceeded	Quota exceeded.
UnauthorizedOperation	Unauthorized operation.

Was this page helpful?

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

Yes

Feedback

tencent cloud