设置实例保护

最近更新时间:2024-03-12 01:09:23

我的收藏

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(SetInstancesProtection)用于设置实例保护。
实例设置保护之后,当发生不健康替换、报警策略、期望值变更等触发缩容时,将不对此实例缩容操作。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SetInstancesProtection。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
AutoScalingGroupId String 伸缩组ID。
示例值:asg-2umy3jbd
InstanceIds.N Array of String 实例ID。
示例值:["ins-b2d33ywt"]
ProtectedFromScaleIn Boolean 实例是否需要设置保护。
示例值:true

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 为实例设置保护

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetInstancesProtection
<公共请求参数>

{
    "AutoScalingGroupId": "asg-2umy3jbd",
    "ProtectedFromScaleIn": "true",
    "InstanceIds": [
        "ins-b2d33ywt"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "5b7168d9-5709-4d69-bd32-880a2f565e33"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameter.ActionNotFound 无效的Action请求。
InvalidParameterValue.InvalidAutoScalingGroupId 伸缩组ID无效。
InvalidParameterValue.InvalidInstanceId 实例ID无效。
InvalidParameterValue.LimitExceeded 取值超出限制。
ResourceNotFound.AutoScalingGroupNotFound 伸缩组不存在。
ResourceNotFound.InstancesNotInAutoScalingGroup 目标实例不在伸缩组内。