修改伸缩组的负载均衡器

最近更新时间:2021-09-27 08:06:31

我的收藏

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(ModifyLoadBalancers)用于修改伸缩组的负载均衡器。

  • 本接口用于为伸缩组指定新的负载均衡器配置,采用“完全覆盖”风格,无论之前配置如何,统一按照接口参数配置为新的负载均衡器。
  • 如果要为伸缩组清空负载均衡器,则在调用本接口时仅指定伸缩组ID,不指定具体负载均衡器。
  • 本接口会立即修改伸缩组的负载均衡器,并生成一个伸缩活动,异步修改存量实例的负载均衡器。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyLoadBalancers。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
AutoScalingGroupId String 伸缩组ID
LoadBalancerIds.N Array of String 传统负载均衡器ID列表,目前长度上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
ForwardLoadBalancers.N Array of ForwardLoadBalancer 应用型负载均衡器列表,目前长度上限为50,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
LoadBalancersCheckPolicy String 负载均衡器校验策略,取值包括 ALL 和 DIFF,默认取值为 ALL。

  • ALL,所有负载均衡器都合法则通过校验,否则校验报错。

  • DIFF,仅校验负载均衡器参数中实际变化的部分,如果合法则通过校验,否则校验报错。
  • 3. 输出参数

    参数名称 类型 描述
    ActivityId String 伸缩活动ID
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 将伸缩组的负载均衡器修改为传统负载均衡器lb-crhgatrf

    输入示例

    https://as.tencentcloudapi.com/?Action=ModifyLoadBalancers
    &AutoScalingGroupId=asg-12wjuh0s
    &LoadBalancerIds.0=lb-crhgatrf
    &<公共请求参数>

    输出示例

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

    示例2 将伸缩组的负载均衡器修改为应用型负载均衡器lb-23aejgcv,监听器为lbl-ncw704sn

    输入示例

    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
    &<公共请求参数>

    输出示例

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

    示例3 清空伸缩组的负载均衡器

    输入示例

    https://as.tencentcloudapi.com/?Action=ModifyLoadBalancers
    &AutoScalingGroupId=asg-12wjuh0s
    &<公共请求参数>

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.NoActivityToGenerate 未生成伸缩活动。
    InternalError.RequestError 内部请求错误。
    InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
    InvalidParameter.InScenario 在特定场景下的不合法参数。
    InvalidParameterValue.ClassicLb 在应当指定传统型负载均衡器的参数中,错误地指定了一个非传统型的负载均衡器。
    InvalidParameterValue.ForwardLb 在应当指定应用型负载均衡器的参数中,错误地指定了一个非应用型的负载均衡器。
    InvalidParameterValue.InvalidAutoScalingGroupId 伸缩组ID无效。
    InvalidParameterValue.InvalidClbRegion 为CLB指定的地域不合法。
    InvalidParameterValue.LbProjectInconsistent 负载均衡器项目不一致。
    InvalidParameterValue.Range 取值超出指定范围。
    MissingParameter.InScenario 在特定场景下缺少参数。
    ResourceNotFound.AutoScalingGroupNotFound 伸缩组不存在。
    ResourceNotFound.ListenerNotFound 指定的Listener不存在。
    ResourceNotFound.LoadBalancerNotFound 找不到指定负载均衡器。
    ResourceNotFound.LocationNotFound 指定的Location不存在。
    ResourceUnavailable.AutoScalingGroupInActivity 伸缩组正在活动中。
    ResourceUnavailable.LbBackendRegionInconsistent CLB实例的后端地域与AS服务所在地域不一致。
    ResourceUnavailable.LbVpcInconsistent 负载均衡器VPC与伸缩组不一致。
    ResourceUnavailable.LoadBalancerInOperation LB 在指定的伸缩组内处于活动中。
    目录