tencent cloud

AttachLoadBalancers
Last updated: 2025-10-30 21:28:18
AttachLoadBalancers
Last updated: 2025-10-30 21:28:18

1. API Description

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

This API is used to add CLBs to a security 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: AttachLoadBalancers.
Version Yes String Common Params. The value used for this API: 2018-04-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
AutoScalingGroupId Yes String Scaling group ID. obtain the scaling group ID by logging in to the console (https://console.tencentcloud.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://www.tencentcloud.com/document/api/377/20438?from_cn_redirect=1), and retrieve AutoScalingGroupId from the returned information.
LoadBalancerIds.N No Array of String Specifies a list of classic clb ids. each scaling group can bind a maximum of 20 classic clbs. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time. can be obtained through the DescribeLoadBalancers api.
ForwardLoadBalancers.N No Array of ForwardLoadBalancer Specifies the list of load balancers. each scaling group can bind a maximum of 100 application clbs. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time. can be obtained through the DescribeLoadBalancers api.

3. Output Parameters

Parameter Name Type Description
ActivityId String Scaling activity ID
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 Adding the classic CLB lb-crhgatrf to the security group

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AttachLoadBalancers
<Common request parameters>

{
    "AutoScalingGroupId": "asg-12wjuh0s",
    "LoadBalancerIds": [
        "lb-crhgatrf"
    ]
}

Output Example

{
    "Response": {
        "ActivityId": "asa-67izy66g",
        "RequestId": "bd3c91e8-3051-4c02-ac58-54d47b9c9d63"
    }
}

Example2 Adding the application CLB lb-23aejgcv (listener: lbl-ncw704sn, forwarding rule ID: loc-l3hmaev9) to the scaling group

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AttachLoadBalancers
<Common request parameters>

{
    "AutoScalingGroupId": "asg-12wjuh0s",
    "ForwardLoadBalancers": [
        {
            "TargetAttributes": [
                {
                    "Port": "8080",
                    "Weight": "10"
                }
            ],
            "Region": "ap-guangzhou",
            "LocationId": "loc-l3hmaev9",
            "ListenerId": "lbl-ncw704sn",
            "LoadBalancerId": "lb-23aejgcv"
        }
    ]
}

Output Example

{
    "Response": {
        "ActivityId": "asa-9asddelc",
        "RequestId": "8d78668d-61eb-456d-855b-f34f91371089"
    }
}

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.NoActivityToGenerate No scaling activity is generated.
InternalError.CallLbError CLB API call failed.
InternalError.RequestError An internal request error occurred.
InvalidParameter.ActionNotFound Invalid Action request.
InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
InvalidParameter.InScenario The parameter is invalid in a specific scenario.
InvalidParameter.MustOneParameter A parameter is missing. One of the two parameters must be specified.
InvalidParameterValue.ClassicLb A classic CLB should be specified.
InvalidParameterValue.DuplicatedForwardLb Duplicate CLB instances
InvalidParameterValue.ForwardLb A CLB should be specified.
InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
InvalidParameterValue.InvalidClbRegion The regions specified for CLB is invalid.
InvalidParameterValue.LimitExceeded The value exceeds the limit.
InvalidParameterValue.ListenerTargetTypeNotSupported Target group listeners are not supported.
InvalidParameterValue.Range The value is outside the specified range.
InvalidParameterValue.TargetPortDuplicated The backend port of the CLB layer-4 listener already exists.
LimitExceeded.AfterAttachLbLimitExceeded Binding with the specified CLBs will make the total number of bound CLBs exceeds the upper limit.
MissingParameter.InScenario A parameter is missing in a specific scenario.
ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
ResourceNotFound.ListenerNotFound The specified listener does not exist.
ResourceNotFound.LoadBalancerNotFound The specified load balancer was not found.
ResourceNotFound.LocationNotFound The specified location does not exist.
ResourceUnavailable.AutoScalingGroupInActivity The auto scaling group is active.
ResourceUnavailable.LbBackendRegionInconsistent The backend region of the CLB is not the same as the one for AS service.
ResourceUnavailable.LbProjectInconsistent The CLBs are not in the same project.
ResourceUnavailable.LbVpcInconsistent The CLB and scaling group should reside in the same VPC.
ResourceUnavailable.LoadBalancerInOperation CLB is active in the scaling group.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback