全部产品
Search
文档中心

云服务器 ECS:StopInstances - 批量停止实例

更新时间:Jun 29, 2026

本接口用于停止一台或多台 ECS 实例,支持选择不同的停机方式、停机模式以及批量操作模式停止实例。

接口说明

该接口为异步接口,实例的停止不是立即完成的,成功调用后,实例会先进入停止中(Stoping)状态,你可以调用 DescribeInstanceStatus 查看实例状态,当返回的状态为Stopped 时代表停止成功。

使用须知

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:StopInstances

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称

类型

必填

描述

示例值

DryRun

boolean

是否发送预检请求。取值范围:

  • true:发送检查请求,不会停止实例。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过,则返回对应错误。如果检查通过,则返回DRYRUN.SUCCESS

说明

如果参数BatchOptimization被设置为SuccessFirst,对应的DryRun=true的预检结果只会返回DRYRUN.SUCCESS

  • false:发送正常请求,通过检查后直接停止实例。

默认值:false。

false

RegionId

string

实例所在的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou

ForceStop

boolean

是否强制关机。取值范围:

  • true:强制关机。
    警告 强制停止等同于断电处理,可能丢失实例操作系统中未写入磁盘的数据,请谨慎选择。
  • false:正常关机。

默认值:false。

false

StoppedMode

string

停止模式。取值:

  • StopCharging:节省停机模式。开启节省停机模式后:

    • 计算资源(vCPU、内存、GPU)、镜像 License 费用、固定公网 IP 的固定带宽模式暂停计费。

    • 系统盘、数据盘、弹性公网 IP 的固定带宽模式持续计费。

    • 由于计算资源被回收,启动时可能因库存不足导致启动失败,请您稍后再试或更换实例规格。

    • 如果实例停止前绑定了弹性公网 IP 地址,重启后 IP 地址不变;否则,固定公网 IP 地址可能会变,但私网 IP 地址不会变。

    更多信息,请参见节省停机模式

    重要 如实例自身不支持节省停机模式,API 侧不会进行报错拦截,优先保证实例停机。不支持节省停机的实例类型:本地盘实例、包年包月实例等。

  • KeepCharging:普通停机模式。停止实例后保留实例的资源并继续收费,并为您保留 ECS 实例规格库存和公网 IP 地址。如果您停止实例是为了更换操作系统、重新初始化云盘、更改实例规格、修改私网 IP 等操作,建议您选择该模式,以避免启动失败。

默认值:如果您开启 VPC 内实例节省停机模式并符合开启条件,则默认值为StopCharging;否则,默认值为KeepCharging

KeepCharging

BatchOptimization

string

设置批量操作模式。取值范围:

  • AllTogether:所有操作必须全部成功才能确认整个批量操作的成功。如果任何一个操作失败,整个批量操作都会被视为失败,所有已执行的操作都会被回滚,恢复到操作前的状态。

  • SuccessFirst:允许批量操作中的每个操作独立执行。如果某个操作失败,其他操作仍然可以继续执行并确认成功。这种模式下,成功的操作会被提交,失败的操作会被标记为失败,但不会影响其他操作的执行结果。

默认值:AllTogether。

AllTogether

InstanceId

array

实例 ID 数组。数组长度:1~100。

i-bp67acfmxazb4p****

string

实例 ID。

i-bp67acfmxazb4p****

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

1C488B66-B819-4D14-8711-C4EAAA13AC01

InstanceResponses

object

InstanceResponse

array<object>

由 InstanceResponse 组成的数组格式,返回每个实例操作的前后状态及操作结果。

object

Code

string

实例操作结果错误码。返回值为 200 表示操作成功。更多信息,请参见下文错误码列表。

200

Message

string

实例操作返回错误信息。返回值为success表示操作成功。更多信息,请参见下文错误码列表。

success

InstanceId

string

实例 ID。

i-bp67acfmxazb4p****

CurrentStatus

string

实例当前状态。

Stopping

PreviousStatus

string

实例操作前状态。

Running

示例

正常返回示例

JSON格式

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01",
  "InstanceResponses": {
    "InstanceResponse": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp67acfmxazb4p****",
        "CurrentStatus": "Stopping",
        "PreviousStatus": "Running"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.KMSKeyId.CMKNotEnabled The CMK needs to be added ECS tag
400 InvalidParameter.KMSKeyId.KMSUnauthorized ECS service account have no right to access your KMS. ECS 服务无权访问您的 KMS
400 DRYRUN.SUCCESS This request is a dryrun request with successful result. 您设置了预检此次请求,并且检查通过。
400 InvalidParameter.Encrypted.KmsNotEnable Failed to perform this operation because KMS is not activated. 您需要开通KMS密钥托管服务。
500 InternalError The request processing has failed due to some unknown error.
403 InvalidInstanceId.NotFound InstanceId should not be null.
403 InvalidParameter.TooManyInstanceIds Instance ids cannot be more than 100. InstanceIds列表长度超过100。
403 Abs.InvalidInstanceIds.MalFormed The specified instanceIds is not valid. 指定的InstanceId参数不合法
403 InstanceLockedForSecurity %s
403 InstanceExpiredOrInArrears %s
403 IncorrectInstanceStatus %s 当前实例的状态不支持此操作。
403 InvalidInstanceId.NotSupport %s
403 InsufficientBalance Your account does not have enough balance.
403 InstanceNotReady The specified instance is not ready for use.
403 InvalidOperation.KMSKeyIdNotFound The specified KMSKeyId not found, %s. 无法找到关联的KMS加密密钥,请确认该KMS加密密钥有效性。
403 InvalidOperation.KMSServiceNotOpen KMS service is currently not open. KMS服务尚未启用.
403 OperationDenied.SystemInstanceNotSupport The system instance does not support the %s operation because %s.
404 InvalidInstanceId.NotFound %s
404 InvalidInstanceIds.NotFound The specified InstanceIds does not exist. 指定的 InstanceId 不存在。请检查 InstanceId 参数值是否正确。您可以调用 DescribeInstances 查询指定实例的状态。
503 LimitedOperation.ServiceUnavailable The service is currently unavailable. Please try again later. 当前服务不可用。请稍后重试。
409 InvalidOperation.Conflict Request was denied due to conflict with a previous request, please try again later. 请求操作的资源与之前的请求冲突

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情