文档

AttachLoadBalancers - 添加一个或多个负载均衡实例

伸缩组支持关联负载均衡实例,通过负载均衡实例将访问流量分发到伸缩组内的多个实例中,可以有效增强伸缩组的服务能力,您可以调用API AttachLoadBalancers添加一个或多个负载均衡实例。

接口说明

向伸缩组添加负载均衡实例时需要满足以下条件:

  • 负载均衡实例与伸缩组必须属于同一账号和同一个地域。

  • 负载均衡实例必须处于运行中状态。

  • 负载均衡实例至少配置有一个监听且必须开启健康检查。

  • 如果负载均衡实例与伸缩组的网络类型均为 VPC,必须处于同一 VPC。

  • 当伸缩组的网络类型为 VPC,负载均衡实例的网络类型为经典网络时,如果负载均衡实例后端服务器中包含 VPC 实例,该实例必须与伸缩组处于同一 VPC。

  • 不超过伸缩组关联负载均衡实例的限额,具体限额,请参见使用限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:AttachLoadBalancersWrite
  • ScalingGroup
    acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

名称类型必填描述示例值
ScalingGroupIdstring

伸缩组的 ID。

asg-bp1avr6ensitts3w****
ForceAttachboolean

是否把当前伸缩组内的实例全部添加为负载均衡实例的后端服务器,取值范围:

  • true:添加。如果该参数值为true,则将负载均衡实例添加到伸缩组时,系统会将当前伸缩组中已有的实例全部添加为负载均衡实例的后端服务器。

    说明 如果负载均衡实例已添加至伸缩组,而您需要将伸缩组中全部实例添加为该负载均衡实例的后端服务器,则您可以再次将该负载均衡实例添加到伸缩组,并选择 ForceAttach 为 true 状态。
  • false:不添加。如果该参数值为 false,则将负载均衡实例添加到伸缩组时,系统不会将当前伸缩组中已有的实例添加为负载均衡实例的后端服务器。

默认值:false。

false
ClientTokenstring

保证请求幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-42665544****
Asyncboolean

添加负载均衡实例时,是否采用异步调用的方式。异步调用能保证操作的事务性,即所有操作都执行成功或者某个操作失败时所有操作的执行结果都不生效,建议您采用异步调用。 取值范围:

  • true:异步调用。请求将返回伸缩活动的 ID。
  • false:同步调用。

默认值:false。

false
LoadBalancersarray

需要添加的负载均衡 CLB(原 SLB)实例的 ID 列表。

string

需要添加的负载均衡 CLB(原 SLB)实例的 ID 列表。

说明 支持最多一次添加 5 个负载均衡实例到伸缩组。
lb-2zeur05gfs****
LoadBalancerConfigsobject []

负载均衡 CLB(原 SLB)配置列表。

LoadBalancerIdstring

负载均衡 CLB(原 SLB)实例的 ID。

147b46d767c-cn-qingdao-cm5****
Weightinteger

弹性伸缩将 ECS 实例或 ECI 实例添加到 SLB 服务器组后,ECS 实例或 ECI 实例作为后端服务器的权重。权重越高,ECS 实例或 ECI 实例将被分配到越多的访问请求。如果权重为 0,则 ECS 实例或 ECI 实例不会收到访问请求。

取值范围:0~100。

10

返回参数

名称类型描述示例值
object
ScalingActivityIdstring

伸缩活动的 ID。

仅当Asynctrue时返回该值。您可使用 API DescribeScalingActivities 遍历查询返回的伸缩活动 ID,查看伸缩活动的执行状态。

asa-bp140qd7mak8k63f****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

示例

正常返回示例

JSON格式

{
  "ScalingActivityId": "asa-bp140qd7mak8k63f****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-30OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:LoadBalancerConfigs