全部产品
Search
文档中心

弹性伸缩:AttachServerGroups - 添加一个或多个负载均衡服务器组

更新时间:Nov 11, 2024

对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景,调用API AttachServerGroups为伸缩组添加一个或多个负载均衡服务器组,支持的服务器组类型包括应用型负载均衡ALB和网络型负载均衡NLB,可以在业务变化时自动实现弹性扩展,并根据负载情况动态分配流量、提高应用程序的稳定性。

调试

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

授权信息

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

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

请求参数

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

伸缩组所属地域的 ID。

cn-hangzhou
ScalingGroupIdstring

伸缩组的 ID。

asg-bp1fo0dbtsbmqa9h****
ClientTokenstring

保证请求幂等性。

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

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

是否将当前伸缩组内的 ECS 实例或 ECI 实例添加到新增的服务器组。取值范围:

  • true:添加。

  • false:不添加。

默认值:false。

false
ServerGroupsarray<object>

负载均衡服务器组的相关信息集合。

object

负载均衡服务器组的相关信息集合。

ServerGroupIdstring

负载均衡服务器组 ID。

sgp-5yc3bd9lfyh*****
Typestring

负载均衡服务器组类型。取值范围:

  • ALB:应用型负载均衡 ALB(Application Load Balancer)。
  • NLB:网络型负载均衡 NLB(Network Load Balancer)。
ALB
Weightinteger

弹性伸缩将 ECS 实例或 ECI 实例添加到服务器组后,ECS 实例或 ECI 实例作为后端服务器的权重。取值范围:0~100。

权重越高,ECS 实例或 ECI 实例将被分配到越多的访问请求。如果权重为 0,则 ECS 实例或 ECI 实例不会收到访问请求。

100
Portinteger

弹性伸缩将 ECS 实例或 ECI 实例添加到服务器组后,ECS 实例或 ECI 实例使用的端口号。

取值范围:1~65535。

22

返回参数

名称类型描述示例值
object
ScalingActivityIdstring

添加负载均衡服务器组并将伸缩组内的 ECS 实例或 ECI 实例添加到该服务器组时,伸缩活动的 ID。

说明 仅当 ForceAttach 取值为 true 时,返回该参数。
asa-bp1c9djwrgxjyk31****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-18API 内部配置变更,不影响调用查看变更详情