tencent cloud

弹性伸缩

产品简介
产品概述
产品优势
应用场景
使用限制
访问管理
购买指南
快速入门
五分钟创建伸缩方案
步骤1:创建启动配置
步骤2:创建伸缩组
步骤3:创建伸缩策略
教程
创建 Web 服务
创建高性能计算集群
创建请求类服务器
配置高可用业务
启动配置
启动配置概述
创建启动配置
查看启动配置列表
更改启动配置
检测异常
伸缩组
伸缩组概述
创建伸缩组
查看伸缩组列表
修改伸缩组
修改伸缩组绑定的实例
将负载均衡与伸缩组结合
删除伸缩组
创建通知
创建伸缩活动通知
指定通知接收人
扩缩容
生命周期挂钩
管理定时任务
管理告警触发策略
实例健康检查
手动扩容
缩容处理
查看伸缩活动
暂停及恢复扩缩容
指定实例免于缩容
伸缩活动取消
伸缩活动失败
冷却时间说明
监控
监控告警指标
运行状态检查
定时任务
定时任务执行时间说明
故障处理
伸缩组失效
伸缩活动失败
实践教程
为伸缩组设置固定出口 IP
部署弹性 Web 应用服务
设置服务开机启动
客户案例
高性能计算:碳云数据挖掘
API 文档
History
Introduction
API Category
Making API Requests
Scaling Group APIs
Scaling Group Instances APIs
Launch Configuration APIs
Scheduled Action APIs
Alarm Trigger Policy APIs
Notification APIs
Lifecycle Hook APIs
Instance Refresh APIs
Other APIs
Data Types
Error Codes
常见问题
联系我们
词汇表

ModifyLoadBalancers

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:28:12

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 Scaling group ID. you can obtain the scaling group ID by logging in to the console or calling the api DescribeAutoScalingGroups and retrieving the AutoScalingGroupId from the returned information.
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. it can be obtained through the DescribeLoadBalancers api.
ForwardLoadBalancers.N No Array of ForwardLoadBalancer Specifies the list of load balancers with a current maximum length of 100. either LoadBalancerIds or ForwardLoadBalancers can be specified at the same time. can be obtained through the DescribeLoadBalancers api.
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.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈