关闭伸缩组内 CVM 实例

最近更新时间: 2026-10-12 00:12:35

1. 接口描述

接口请求域名： as.api3.fincloud.tencent.com。

本接口（StopAutoScalingInstances）用于关闭伸缩组内 CVM 实例。

  • 关机方式采用SOFT_FIRST方式，表示在正常关闭失败后进行强制关闭
  • 关闭IN_SERVICE状态的实例，会减少期望实例数，期望实例数不可低于设置的最小值
  • 使用STOP_CHARGING选项关机，待关机的实例需要满足[关机不收费条件]
  • 本接口支持批量操作，每次请求关机实例的上限为100

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

接口更新时间：2026-02-05 15:59:26。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：StopAutoScalingInstances
Version 是 否 String 公共参数，本接口取值：2018-04-19
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds 是 是 Array of String 待关闭的CVM实例ID列表。可以通过以下方式获取可用的实例ID：
  • 通过登录[控制台]查询实例ID。
  • 通过调用接口 [DescribeInstances] ，取返回信息中的 InstanceId 获取实例ID。

    • 示例值： ["ins-cri8d02t","ins-osckfnm7"]
    StoppedMode 否 是 String 关闭的实例是否收费，取值为：  
    KEEP_CHARGING：关机继续收费  
    STOP_CHARGING：关机停止收费
    默认为 KEEP_CHARGING
    示例值： STOP_CHARGING
    AutoScalingGroupId 是 是 String 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
  • 通过登录 [控制台] 查询伸缩组ID。
  • 通过调用接口 [DescribeAutoScalingGroups] ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。

    • 示例值： asg-boz1qhnk

    3. 输出参数

    参数名称 类型 描述
    ActivityId String 伸缩活动ID
    示例值： asa-m1ebiskl
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    CallCvmError CVM接口调用失败。
    ResourceUnavailable.AutoScalingGroupInActivity 伸缩组正在活动中。
    ResourceNotFound.InstancesNotInAutoScalingGroup 目标实例不在伸缩组内。
    ResourceInsufficient.AutoScalingGroupBelowMinSize 少于伸缩组最小实例数。
    ResourceUnavailable.InstanceNotSupportStopCharging
    InvalidParameterValue.InvalidInstanceId
    InvalidParameterValue.InvalidAutoScalingGroupId
    InternalError.RequestError 请求错误
    FailedOperation.NoActivityToGenerate
    ResourceInsufficient.InServiceInstanceBelowMinSize
    ResourceNotFound.AutoScalingGroupNotFound
    ResourceUnavailable.InstanceInOperation
    ResourceUnavailable.LoadBalancerInOperation
    InternalError.CalleeError
    InvalidParameter.ActionNotFound

    5. 示例

    示例1 按关机不收费模式关闭伸缩组内实例

    输入示例

    POST / HTTP/1.1
Content-Type: application/json
X-TC-Action: StopAutoScalingInstances
<Common Parameters>

{
    "AutoScalingGroupId": "asg-boz1qhnk",
    "StoppedMode": "STOP_CHARGING",
    "InstanceIds": [
        "ins-osckfnm7",
        "ins-cri8d02t"
    ]
}

    输出示例

    {
    "Response": {
        "ActivityId": "asa-m1ebiskl",
        "RequestId": "f3e2873c-af7c-43ee-8aa7-53565d4181c2"
    }
}