You need to enable JavaScript to run this app.
导航

SetInstancesProtection

最近更新时间2023.07.10 14:28:09

首次发布时间2022.05.13 10:42:45

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

请求参数

名字类型是否必填示例值
描述
ActionStringSetInstancesProtection要执行的操作,取值:SetInstancesProtection。
VersionString2020-01-01API的版本,取值为:2020-01-01。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。

InstanceIds.N

String

InstanceIds.1=i-ybmike5l70l8j1ha****&
InstanceIds.2=i-ybmike5l70l8j1hi****

实例ID。您可以调用DescribeScalingInstances查询指定伸缩组中的实例ID。

  • 参数 - N:表示伸缩组的序号,取值1 ~ 20。
  • 多个实例ID之间用&分隔。

ProtectedFromScaleIn

Boolean

true

实例保护状态:

  • true:开启保护实例。
  • false(默认):停止保护实例。

返回数据

名称类型示例值
描述
InstanceProtectionResultsArray of struct-各实例设置保护实例的结果。具体请参见下表“ProtectionResult结构”。

ProtectionResult 结构

名称类型示例值
描述
InstanceIdStringx实例ID。

Result

String

Success

实例开启或停止保护的结果。取值:

  • Success:成功。
  • Fail:失败。

Code

String

InvalidInstance.NotFound

实例开启或停止保护失败的错误码。

  • InvalidInstance.NotFound
  • ErrUnProtectedPrePaidInstance
  • ErrProtectInstanceStatusInvalid
    仅当Result值为Fail时有返回值。

Message

String

指定实例[%s]不存在

实例开启或停止保护失败的错误信息。取值:

  • Code取值为InvalidInstance.NotFound时:指定实例[%s]不存在。
  • Code取值为ErrUnProtectedPrePaidInstance时:包年包月类型实例[%s]不支持移除保护状态。
  • Code取值为ErrProtectInstanceStatusInvalid时:实例当前状态不支持执行该操作。
    仅当Result值为Fail时有返回值。

请求示例

GET /?Action=SetInstancesProtection&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&InstanceIds.1=i-ybmike5l70l8j1ha****&ProtectedFromScaleIn=true&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204201727490102250990080521****",
        "Action": "SetInstancesProtection",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceProtectionResults": [
            {
                "InstanceId": "i-ybmssxidd2l8j1e5****",
                "Result": "Success",
                "Code": "",
                "Message": ""
            }
        ]
    }
}