tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyLoadBalancers

Last updated: 2024-12-03 17:50:35

    1. API Description

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

    This API is used to modify the cloud load balancers of a scaling group.

    • This API can specify a new cloud load balancer configuration for the scaling group. The new configuration overwrites the original load balancer configuration.
    • To clear the cloud load balancer of the scaling group, specify only the scaling group ID but not the specific cloud load balancer.
    • This API modifies the cloud load balancer of the scaling group and generate a scaling activity to asynchronously modify the cloud load balancers of existing instances.

    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: ModifyLoadBalancers.
    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 Auto scaling group ID
    LoadBalancerIds.N No Array of String List of classic CLB IDs. Currently, the maximum length is 20. You cannot specify LoadBalancerIds and ForwardLoadBalancers at the same time.
    ForwardLoadBalancers.N No Array of ForwardLoadBalancer List of application CLBs. Up to 100 CLBs are allowed. LoadBalancerIds and ForwardLoadBalancers cannot be specified at the same time.
    LoadBalancersCheckPolicy No String CLB verification policy. Valid values: ALL and DIFF. Default value: ALL.
  • ALL: The CLB passes the verification only when all CLB parameters are valid. Otherwise, a verification error occurs.
  • DIFF: The CLB passes the verification only when the CLB parameters with changes are valid. Otherwise, a verification error occurs.
    		•

    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 Clearing Load Balancers of Scaling Groups

    Input Example

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

{
    "AutoScalingGroupId": "asg-12wjuh0s"
}

    Output Example

    {
    "Response": {
        "ActivityId": "asa-rp63a5q8",
        "RequestId": "7de5a82f-b781-4302-b723-e7a879c20767"
    }
}

    Example2 Modifying Load Balancers of Scaling Groups to Classic Load Balancers lb-crhgatrf

    Input Example

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

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

    Output Example

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

    Example3 Modifying Load Balancers of Scaling Groups to Application-based Load Balancer lb-23aejgcv with Listener lbl-ncw704sn

    Input Example

    POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoadBalancers
<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.
    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.LbProjectInconsistent The load balancer is in a different project.
    InvalidParameterValue.LimitExceeded The value exceeds the limit.
    InvalidParameterValue.Range The value is outside the specified range.
    InvalidParameterValue.TargetPortDuplicated The backend port of the CLB layer-4 listener already exists.
    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.LbVpcInconsistent The CLB and scaling group should reside in the same VPC.
    ResourceUnavailable.LoadBalancerInOperation CLB is active in the scaling group.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy