文档

EnterStandby

调用API EnterStandby将伸缩组内的ECS实例或ECI实例设置为备用状态,方便您自行管理ECS实例或ECI实例的生命周期。

接口说明

  • 如果伸缩组关联了负载均衡实例,会把负载均衡中对应的实例权重设置为0。
  • 当实例处于备用状态时,如果您需要移出伸缩组并释放实例,则可以正常手动将该实例移出伸缩组并释放。
  • 对于伸缩组数量变化或监控任务触发的自动缩容的伸缩活动,不会移出处于备用状态的实例。
  • 当实例处于备用状态时,实例如果处于非健康状态(例如停止中、重启中等),实例的健康检查状态不会被更新,并且不会触发移出不健康实例的伸缩活动,只有实例退出备用状态后才会重新更新健康检查状态。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String EnterStandby

系统规定参数。取值:EnterStandby

ScalingGroupId String asg-bp1fo0dbtsbmqa9h****

伸缩组的ID。

ClientToken String 123e4567-e89b-12d3-a456-42665544****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求之间该参数值唯一。

只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性

InstanceId.N String i-28wt4****

ECS实例或ECI实例的ID。

Async Boolean false

是否采用异步任务方式执行。取值范围:

  • true:异步任务执行方式。
  • false:同步执行方式。

默认值: false。

返回数据

名称

类型

示例值

描述

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

请求ID。

ScalingActivityId String asa-2zeb04oym05qaceq****

调用伸缩活动ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=EnterStandby
&ScalingGroupId=asg-bp1fo0dbtsbmqa9h****
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&InstanceId=["i-28wt4****"]
&Async=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<EnterStandbyResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <ScalingActivityId>asa-2zeb04oym05qaceq****</ScalingActivityId>
</EnterStandbyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

HttpCode

错误码

错误信息

描述

403

Forbidden.Unauthorized

A required authorization for the specified action is not supplied.

RAM用户无权限调用该接口,请联系主账号授权后重试。

404

InvalidInstanceId.NotFound

Instance "XXX" does not exist.

指定的ECS实例或ECI实例不存在。

404

InvalidScalingGroupId.NotFound

The specified scaling group does not exist.

指定的伸缩组不存在。

  • 本页导读 (1)