文档

StopInstance - 停止一台实例

更新时间:

调用StopInstance停止一台运行中(Running)的ECS实例。成功调用接口后,实例从停止中(Stopping)变成已停止(Stopped)状态。

接口说明

  • 被安全锁定的 ECS 实例的OperationLocks参数包含"LockReason": "security"时,不能停止实例。更多信息,请参见安全锁定时的 API 行为
  • 开启 VPC 内实例节省停机模式后,您可以通过设置StoppedMode=KeepCharging开启普通停机模式,ECS 实例停止后会继续计费,并为您保留 ECS 实例规格库存和公网 IP 地址。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:StopInstanceWrite
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

指定的实例 ID。

i-bp67acfmxazb4ph****
ConfirmStopboolean

该参数即将被弃用,为提高兼容性暂作保留。您在调用该接口时请忽略该参数。

true
ForceStopboolean

停止实例时的是否强制关机策略。取值范围:

  • true:强制关机。
  • false:正常关机流程。

默认值为 false。

false
StoppedModestring

停止按量付费 ECS 实例时,设置的停止模式。取值:

  • StopCharging:节省停机模式。有关StopCharging生效的条件,请参见按量付费实例节省停机模式的启用条件章节。
  • KeepCharging:普通停机模式。实例停止后仍继续收费。

默认值:如果您在 ECS 控制台上开启 VPC 内实例节省停机模式(更多信息,请参见打开默认启用节省停机模式),并符合开启条件,则默认值为StopCharging。否则,默认值为KeepCharging

KeepCharging
DryRunboolean

是否只预检此次请求。取值范围:

  • true:发送检查请求,不会停止实例。检查项包括是否填写了必选参数、请求格式、业务限制和 ECS 库存。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false:发送正常请求,通过检查后直接停止实例。

默认值为 false。

true
Hibernateboolean
说明 该参数正在邀测中,暂不支持使用。
hide

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

1C488B66-B819-4D14-8711-C4EAAA13AC01

示例

正常返回示例

JSON格式

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}

错误码

HTTP status code错误码错误信息描述
403IncorrectInstanceStatusThe current status of the resource does not support this operation.该资源目前的状态不支持此操作。
403InstanceLockedForSecurityThe specified operation is denied as your instance is locked for security reasons.实例被安全锁定。
403DiskErrorIncorrectDiskStatus指定的磁盘状态不合法。
403InstanceType.ParameterMismatchThe input parameter ConfirmStop must be true when an instance have localstorage.当实例使用本地存储时,输入参数 ConfirmStop 必须为 true。
403InstanceExpiredOrInArrearsThe specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode).实例已过期或者欠费,请您续费或者结清后再进行操作。
403InvalidInstanceId.NotSupportClassic network Instance does not support this operation.经典网络类型的实例不支持此操作。
403InvalidInstanceId.NotSupportPre pay instance does not support this operation.包年包月实例不支持该操作。
403InvalidInstanceId.NotSupportLocal disk instance does not support this operation.本地盘实例不支持该操作。
403InvalidInstanceId.NotSupportSpot instance does not support this operation.抢占式实例不支持该操作。
403IncorrectInstanceStatus%s当前实例的状态不支持此操作。
403InvalidParameter.KMSKeyId.CMKUnauthorizedThe CMK needs to be added ECS tag-
403InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.加密云盘设置了 KMSKeyId 后,CMK必须处于启用状态。您可以调用密钥管理服务的 DescribeKey 接口查询指定CMK的相关信息。
403InvalidParameter.KMSKeyId.KMSUnauthorizedECS service have no right to access your KMS.ECS 服务无权访问您的 KMS。
403HibernationConfigured.InstanceOperationForbiddenThe operation is not permitted due to limit of the hibernation configured instance.不符合开启休眠选项的实例的相关限制,操作不被允许。
403HibernationConfigured.NotEnabledThe instance hibernation configured option is not enabled.-
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例ID未找到。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误,请重试。

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

变更历史

变更时间变更内容概要操作
2023-07-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2021-05-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:404
    删除错误码:500
  • 本页导读 (1)