指定数量缩容实例

最近更新时间:2025-05-14 01:09:27

我的收藏

1. 接口描述

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

为伸缩组指定数量缩容实例,返回缩容活动的 ActivityId。

  • 伸缩组需要未处于活动中
  • 伸缩组处于停用状态时,该接口也会生效,可参考停用伸缩组文档查看伸缩组停用状态的影响范围
  • 根据伸缩组的TerminationPolicies策略,选择被缩容的实例,可参考缩容处理
  • 接口只会选择IN_SERVICE实例缩容,如果需要缩容其他状态实例,可以使用 DetachInstancesRemoveInstances 接口
  • 接口会减少期望实例数,新的期望实例数需要大于等于最小实例数
  • 缩容如果失败或者部分成功,最后期望实例数只会扣减实际缩容成功的实例数量

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ScaleInInstances。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
AutoScalingGroupId String 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
  • 通过登录 控制台 查询伸缩组ID。
  • 通过调用接口 DescribeAutoScalingGroups ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。

  • 示例值:asg-12yqet78
    ScaleInNumber Integer 希望缩容的实例数量。该参数的静态取值范围是 [1,2000],同时该参数不得大于期望数与最小值的差值。例如伸缩组期望数为 100,最小值为 20,此时可取值范围为 [1,80]。
    示例值:1

    3. 输出参数

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

    4. 示例

    示例1 伸缩组缩容一台实例

    输入示例

    POST / HTTP/1.1
    Host: as.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ScaleInInstances
    <公共请求参数>
    
    {
        "AutoScalingGroupId": "asg-12yqet78",
        "ScaleInNumber": 1
    }

    输出示例

    {
        "Response": {
            "ActivityId": "asa-n6w01f6m",
            "RequestId": "c0bb46ea-2b47-471c-9099-e20bf7a23078"
        }
    }

    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.Range 取值超出指定范围。
    MissingParameter 缺少参数错误。
    ResourceInsufficient.AutoScalingGroupBelowMinSize 少于伸缩组最小实例数。
    ResourceNotFound.AutoScalingGroupNotFound 伸缩组不存在。
    ResourceUnavailable.AutoScalingGroupInActivity 伸缩组正在活动中。