ModifyLoadBalancers

Last updated: 2021-11-16 11:27:37

1. API Description

Domain name for API request: as.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 parameter. The value used for this API: ModifyLoadBalancers.
Version Yes String Common parameter. The value used for this API: 2018-04-19.
Region Yes String Common parameter. 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 50 CLBs are allowed. You cannot specify loadBalancerIds and ForwardLoadBalancers at the same time.
LoadBalancersCheckPolicy No String CLB verification policy. Valid values: "ALL" and "DIFF". Default value: "ALL"

  • ALL. Verification is successful only when all CLBs are valid. Otherwise, verification fails.

  • DIFF. Only the changes in the CLB parameters are verified. If valid, the verification is successful. Otherwise, verification fails.
  • 3. Output Parameters

    Parameter Name Type Description
    ActivityId String Scaling activity ID
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Changing the load balancer of a scaling group to a classic CLB named lb-crhgatrf

    Input Example

    https://as.tencentcloudapi.com/?Action=ModifyLoadBalancers
    &AutoScalingGroupId=asg-12wjuh0s
    &LoadBalancerIds.0=lb-crhgatrf
    <Common request parameters>
    

    Output Example

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

    Example2 Changing the load balancer of a scaling group to CLB named lb-23aejgcv with the listener lbl-ncw704sn

    Input Example

    https://as.tencentcloudapi.com/?Action=ModifyLoadBalancers
    &AutoScalingGroupId=asg-12wjuh0s
    &ForwardLoadBalancers.0.LoadBalancerId=lb-23aejgcv
    &ForwardLoadBalancers.0.ListenerId=lbl-ncw704sn
    &ForwardLoadBalancers.0.LocationId=loc-l3hmaev9
    &ForwardLoadBalancers.0.Region=ap-guangzhou
    &ForwardLoadBalancers.0.TargetAttributes.0.Port=8080
    &ForwardLoadBalancers.0.TargetAttributes.0.Weight=10
    <Common request parameters>
    

    Output Example

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

    Example3 Unbinding all load balancers from a scaling group

    Input Example

    https://as.tencentcloudapi.com/?Action=ModifyLoadBalancers
    &AutoScalingGroupId=asg-12wjuh0s
    <Common request parameters>
    

    Output Example

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

    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.RequestError An internal request error occurred.
    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.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.Range The value is outside the specified range.
    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.