AttachInstances - 为伸缩组手动添加实例 - 弹性伸缩

调用API AttachInstances将实例手动添加到伸缩组中，即您可以将伸缩组以外的ECS实例、ECI实例或托管实例添加到伸缩组中并提供服务，或者将伸缩组中处于节省停机状态的ECS实例重新启动变为服务状态（运行中状态）并在伸缩组中提供服务。

接口说明

调用该接口前，请确保满足以下条件：
- 伸缩组处于 Active 状态。
- 伸缩组内没有执行中的伸缩活动。
加入伸缩组的 ECS 实例或 ECI 实例的限制条件包括：
- 必须与伸缩组在同一个地域。
- 必须处于 Running 状态。
- 不能已加入到其他伸缩组中。
- 付费方式为包年包月、按量付费或抢占式实例。
- 如果伸缩组指定 VswitchID，则不支持 Classic 类型的 ECS 实例或 ECI 实例加入伸缩组，也不支持其他 VPC 的 ECS 实例或 ECI 实例加入伸缩组。
- 如果伸缩组没有指定 VswitchID，则不支持 VPC 类型的 ECS 实例或 ECI 实例加入伸缩组。
加入伸缩组的托管实例的限制条件包括：
- 必须与伸缩组在同一个地域。
- 只能将未加入伸缩组的托管实例加入到 ECS 类型伸缩组中。
- 托管实例不支持配置生命周期挂钩、关联到负载均衡和健康检查功能。
- 托管实例加入 ECS 类型伸缩组后，该伸缩组不会管理托管实例的生命周期。
- 托管实例仅支持手动添加到伸缩组或手动从伸缩组移出，移出后托管实例并不会被释放。
使用该接口需注意以下事项：
- 当伸缩组没有伸缩活动正在执行时，该接口可以绕过冷却时间（Cooldown）直接执行。
- 调用该接口返回成功，只是表示弹性伸缩服务接受了该接口调用的请求，伸缩活动可以执行，但不代表伸缩活动能够执行成功。您需要通过返回的 ScalingActivityId 查看该伸缩活动的执行状态。
- 如果该接口指定的实例数加上当前伸缩组的实例数（Total Capacity）大于最大值（MaxSize），则接口调用失败。
- 通过该接口手动添加的 ECS 实例、ECI 实例或托管实例不与伸缩组生效的伸缩配置进行关联。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求参数

名称	类型	必填	描述	示例值
ScalingGroupId	string	是	伸缩组的 ID。	asg-bp18p2yfxow2dloq****
Entrusted	boolean	否	将已经存在的实例手动添加到伸缩组时，是否将该实例的生命周期托管给伸缩组。取值范围： true：托管。该实例的生命周期由弹性伸缩管理，与伸缩组自动创建的实例一致。实例被移出伸缩组（不包括通过调用 DetachInstances 参数移出的实例）时会自动释放。 false：不托管。该实例在被移出伸缩组时不会被释放。说明包年包月实例、托管实例和伸缩组中节省停机实例不支持设置该参数项。默认值：false。	false
InstanceIds	array	否	待添加 ECS 实例、ECI 实例、托管实例或者伸缩组中处于节省停机状态实例的 ID。
	string	否	待添加 ECS 实例、ECI 实例、托管实例或者伸缩组中处于节省停机状态实例的 ID。举例如下所示：待添加的 ECS 实例 ID 为 i-28wt4**。待添加的 ECI 实例 ID 为 eci-bp17gw49eu09yiwm。待添加的托管实例 ID 为 mi-2cx*。待重新启动的伸缩组中节省停机状态实例 ID 为 i-2cd2f** 说明一次调用请求中仅支持处理一种类型的实例。	i-28wt4****
LoadBalancerWeights	array	否	ECS 实例或 ECI 实例作为负载均衡实例后端服务器时的权重。
	integer	否	为 ECS 实例或 ECI 实例作为负载均衡实例后端服务器时的权重，该参数的取值范围：1~100。说明托管实例和伸缩组中节省停机实例不支持设置该参数项。默认值：50。	50
LifecycleHook	boolean	否	伸缩组添加实例时，是否触发扩容生命周期挂钩。取值范围： true：触发。 false：不触发。说明托管实例和伸缩组中节省停机实例不支持设置该参数项。默认值：false。	false
RegionId	string	否	伸缩组所属的地域 ID。	cn-qingdao
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-42665544****

返回参数

名称	类型	描述	示例值
	object
ScalingActivityId	string	伸缩活动的 ID。	asa-bp1crxor24s28xf1****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息
500	InternalError	The request processing has failed due to some unknown error, exception or failure.

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史