ModifyLoadBalancers

Last updated: 2019-12-05 14:04:02

PDF

1. API Description

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

This API (ModifyLoadBalancers) is used to modify the load balancers of an auto scaling group.

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

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: as.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: 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 CLBs. Currently, the maximum length is 20. 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 an Auto Scaling Group to Classic Load Balancer lb-crhgatrf

    Input Example

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

    Output Example

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

    Example2 Changing the Load Balancer of an Auto Scaling Group to Application Load Balancer lb-23aejgcv with 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.TargetAttributes.0.Port=8080
    &ForwardLoadBalancers.0.TargetAttributes.0.Weight=10
    &<Common request parameter>

    Output Example

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

    Example3 Clearing the Load Balancer of an Auto Scaling Group

    Input Example

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

    Output Example

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

    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
    InvalidParameterValue.ForwardLb An application load balancer is incorrectly specified.
    InvalidParameterValue.LbProjectInconsistent The load balancer is in a different project.
    InvalidParameterValue.LbVpcInconsistent The load balancer and the auto scaling group are in different VPCs.
    ResourceNotFound.AutoScalingGroupIdNotFound The auto scaling group does not exist.
    ResourceNotFound.LoadBalancerNotFound The specified load balancer was not found.
    ResourceUnavailable.AutoScalingGroupInActivity The auto scaling group is active.