弹性伸缩关闭伸缩组内 CVM 实例-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：StopAutoScalingInstances。
Version	是	String	公共参数，本接口取值：2018-04-19。
Region	是	String	公共参数，详见产品支持的地域列表。
AutoScalingGroupId	是	String	伸缩组ID 示例值：asg-boz1qhnk
InstanceIds.N	是	Array of String	待关闭的CVM实例ID列表示例值：["ins-cri8d02t","ins-osckfnm7"]
StoppedMode	否	String	关闭的实例是否收费，取值为： KEEP_CHARGING：关机继续收费 STOP_CHARGING：关机停止收费默认为 KEEP_CHARGING 示例值：STOP_CHARGING

3. 输出参数

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

4. 示例

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

输入示例

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

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
CallCvmError	CVM接口调用失败。
FailedOperation.NoActivityToGenerate	未生成伸缩活动。
InternalError.CalleeError	调用其他服务异常。
InternalError.RequestError	内部请求错误。
InvalidParameter.ActionNotFound	无效的Action请求。
InvalidParameterValue.InvalidAutoScalingGroupId	伸缩组ID无效。
InvalidParameterValue.InvalidInstanceId	实例ID无效。
ResourceInsufficient.AutoScalingGroupBelowMinSize	少于伸缩组最小实例数。
ResourceInsufficient.InServiceInstanceBelowMinSize	伸缩组内实例数低于最小实例数。
ResourceNotFound.AutoScalingGroupNotFound	伸缩组不存在。
ResourceNotFound.InstancesNotInAutoScalingGroup	目标实例不在伸缩组内。
ResourceUnavailable.AutoScalingGroupInActivity	伸缩组正在活动中。
ResourceUnavailable.InstanceInOperation	指定的实例正在活动中。
ResourceUnavailable.InstanceNotSupportStopCharging	实例不支持关机不收费。
ResourceUnavailable.LoadBalancerInOperation	LB 在指定的伸缩组内处于活动中。

关闭伸缩组内 CVM 实例

本页目录：