文档

SetInstancesProtection - 开始或停止保护伸缩组内ECS实例

更新时间:

调用API SetInstancesProtection可以保护或停止保护伸缩组内的一台或者多台ECS实例。开启ECS实例的保护功能后,伸缩组自动缩容时该实例不会被终止或释放,仅可手动在控制台或通过调用API的RemoveInstances接口删除该实例。

接口说明

ECS 实例开启保护状态后:

  • 实例保持此状态,直至您停止保护状态。
  • 即使伸缩组内实例数量的变化和监控任务触发自动缩容的伸缩活动,也不会移除处于保护状态的 ECS 实例。您需要自行移出 ECS 实例后才能释放 ECS 实例。具体操作,请参见移出 ECS 实例
  • ECS 实例被停止或者重启时,不会更新 ECS 实例的健康检查状态。

调试

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

授权信息

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

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

请求参数

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

伸缩组的 ID。

asg-bp18p2yfxow2dloq****
ProtectedFromScaleInboolean

伸缩组自动缩容时是否保护 ECS 实例,使该实例不被终止或移出伸缩组。取值范围:

  • true:保护 ECS 实例。
  • false:不保护 ECS 实例。
true
InstanceIdsarray

ECS 实例的 ID 列表。

string

ECS 实例的 ID。

i-28wt4****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史