Tenant Cloud Compute Auto Scaling Scaling Group APIs ModifyLoadBalancers

ModifyLoadBalancers

Last Updated At: 2026-08-03 00:05:15

1. Interface Description

Interface request domain name: as.api3.convergecloud.com.

This API (ModifyLoadBalancers) is used to modify the load balancers in a scaling group.

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

Default interface request rate limit: 20 times per second.

Interface update time: 2019-10-31 16:51:25.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ModifyLoadBalancers
Version Yes No String Public parameter, The value of this interface: 2018-04-19
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
AutoScalingGroupId Yes No String ID of the scaling group.
Example: asg-12wjuh0s
LoadBalancerIds No No Array of String IDs of classic load balancers. Up to 20 IDs are supported. You can only specify one of LoadBalancerIds and ForwardLoadBalancers, or leave both of them empty.
Example: ["lb-crhgatrf\n"]
ForwardLoadBalancers No No Array of ForwardLoadBalancer List of application load balancers. Up to 20 IDs are supported. You can only specify one of LoadBalancerIds and ForwardLoadBalancers, or leave both of them empty.
Example:View
LoadBalancersCheckPolicy No No String Load balancer verification policy. Valid values: ALL and DIFF. Default value: ALL.

  •  ALL: the verification is successful only if all load balancers are valid. Otherwise, the verification fails.

  •  DIFF: only the changes in the load balancer parameters are verified. If the changes are valid, the verification is successful. Otherwise, the verification fails.
    Example: ALL
    		•

    3. Output Parameters

    Parameter name Type Description
    ActivityId String ID of the scaling activity.
    Example: asa-67izy66g
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.LbProjectInconsistent The load balancer is in a different project.
    ResourceUnavailable.AutoScalingGroupInActivity The auto scaling group is active.
    ResourceNotFound.AutoScalingGroupIdNotFound The scaling group does not exist.
    InvalidParameterValue.LbVpcInconsistent The load balancer and the scaling group are in different VPCs.
    InvalidParameterValue.ForwardLb The application load balancer is incorrectly specified.
    ResourceNotFound.LoadBalancerNotFound The specified load balancer was not found.