SetInstancesProtection - 开始或停止保护伸缩组内实例--弹性伸缩-火山引擎

文档中心

立即注册

导航

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

最近更新时间：2025.03.03 14:34:53首次发布时间：2022.05.13 10:42:45

将伸缩组中不希望被自动删除/移出的实例设置为保护状态，操作说明和注意事项请参见设置实例保护。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	SetInstancesProtection	要执行的操作，取值：SetInstancesProtection。
Version	String	是	2020-01-01	API的版本，取值：2020-01-01。
ScalingGroupId	String	是	scg-ybmssdnnhn5pkgyd****	伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。
InstanceIds.N	Array of String	是	i-ybmike5l70l8j1ha****	实例ID列表。您可以调用DescribeScalingInstances查询指定伸缩组中的实例ID。参数 - N：表示伸缩组的序号，取值1 ～ 20。多个实例ID之间用&分隔。
ProtectedFromScaleIn	Boolean	否	true	实例保护状态： true：开启保护实例。 false（默认）：停止保护实例。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
InstanceProtectionResults	Array of Object	--	各实例设置保护实例的结果。

请求示例

GET /?Action=SetInstancesProtection&InstanceIds.1=i-ybmike5l70l8j1ha****&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T112722Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202405071927290150451670784B245B",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceProtectionResults": [
      {
        "Code": "InvalidInstance.NotFound",
        "InstanceId": "i-ybmike5l70l8j1ha",
        "Message": "指定实例[i-ybmike5l70l8j1ha****]不存在。",
        "Result": "Success"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidInstance.InvalidStatus	The specified Instance [%s] is not in the correct status.	指定实例的状态不支持该操作。
400	InvalidScalingGroup.InvalidStatus	The specified ScalingGroup is not in the correct status.	指定的伸缩组当前状态不支持该操作。
400	MissingParameter.ScalingGroupId	The required parameter ScalingGroupId is not supplied.	伸缩组ID不能为空。
400	MissingParameter.InstanceIds	The required parameter InstanceIds is not supplied.	实例ID不能为空。
400	InvalidInstanceIds.Malformed	The specified amount of InstanceIds is malformed.	指定的实例ID数量超出限制。
404	InvalidInstanceId.NotFound	The specified InstanceId [%s] does not exist.	指定的实例不存在。
404	InvalidScalingGroupId.NotFound	The specified ScalingGroup [%s] does not exist.	指定的伸缩组不存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。