AttachInstances_弹性伸缩_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 调用该接口前,请确保满足以下条件:

    • 伸缩组处于 Active 状态。
    • 伸缩组内没有执行中的伸缩活动。
  • 加入伸缩组的 ECS 实例或 ECI 实例的限制条件包括: - 必须与伸缩组在同一个地域。 - 必须处于 Running 状态。 - 不能已加入到其他伸缩组中。 - 付费方式为包年包月、按量付费或抢占式实例。 - 如果伸缩组指定 VswitchID,则不支持 Classic 类型的 ECS 实例或 ECI 实例加入伸缩组,也不支持其他 VPC 的 ECS 实例或 ECI 实例加入伸缩组。 - 如果伸缩组没有指定 VswitchID,则不支持 VPC 类型的 ECS 实例或 ECI 实例加入伸缩组。

  • 加入伸缩组的托管实例的限制条件包括:

    • 必须与伸缩组在同一个地域。
    • 只能将未加入伸缩组的托管实例加入到 ECS 类型伸缩组中。
    • 托管实例不支持配置生命周期挂钩、关联到负载均衡和健康检查功能。
    • 托管实例加入 ECS 类型伸缩组后,该伸缩组不会管理托管实例的生命周期。
    • 托管实例仅支持手动添加到伸缩组或手动从伸缩组移出,移出后托管实例并不会被释放。
  • 使用该接口需注意以下事项:

    • 当伸缩组没有伸缩活动正在执行时,该接口可以绕过冷却时间(Cooldown)直接执行。
    • 调用该接口返回成功,只是表示弹性伸缩服务接受了该接口调用的请求,伸缩活动可以执行,但不代表伸缩活动能够执行成功。您需要通过返回的 ScalingActivityId 查看该伸缩活动的执行状态。
    • 如果该接口指定的实例数加上当前伸缩组的实例数(Total Capacity)大于最大值(MaxSize),则接口调用失败。
    • 通过该接口手动添加的 ECS 实例、ECI 实例或托管实例不与伸缩组生效的伸缩配置进行关联。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ess:AttachInstances
Update
ScalingGroup
acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

字段名称字段详情
ScalingGroupIdstring

伸缩组的 ID。

示例值:asg-bp18p2yfxow2dloq****参考取值来源:
    CreateScalingGroup
    DescribeScalingGroups
Entrustedboolean

将已经存在的实例手动添加到伸缩组时,是否将该实例的生命周期托管给伸缩组。取值范围:展开详情

示例值:false
InstanceIdarray<string>

InstanceId.N 为待添加 ECS 实例、ECI 实例、托管实例或者伸缩组中处于节省停机状态实例的 ID。N 的取值范围:1~20。展开详情

示例值:i-28wt4****子级条数 <= 100
LoadBalancerWeightarray<integer<int32>>

ECS 实例或 ECI 实例作为负载均衡后端服务器时的权重。展开详情

示例值:50子级条数 <= 100
LifecycleHookboolean

伸缩组添加实例时,是否触发扩容生命周期挂钩。取值范围:展开详情

示例值:false
RegionIdstring

伸缩组所属的地域 ID。

示例值:cn-qingdao参考取值来源:
    DescribeRegions
ClientTokenstring

保证请求幂等性。展开详情

示例值:123e4567-e89b-12d3-a456-42665544****
IgnoreInvalidInstanceboolean

向伸缩组添加一批实例时,是否忽略其中无效的实例。取值范围:展开详情

示例值:false

返回参数

字段名称字段详情
ScalingActivityIdstring

伸缩活动的 ID。

示例值:asa-bp1crxor24s28xf1****
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
500
InternalError
The request processing has failed due to some unknown error, exception or failure.诊断

变更历史

变更时间变更内容概要操作
2025-01-08
新增请求参数IgnoreInvalidInstance
2022-01-04
新增请求参数LifecycleHook

相关示例