You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

StopInstance

最近更新时间：2024.01.12 08:03:58

首次发布时间：2021.07.31 07:48:16

我的收藏

调用 StopInstance 接口停止一台实例。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填
示例值
描述
ActionString是StopInstance要执行的操作，取值：StopInstance。
VersionString是2020-04-01API的版本，取值：2020-04-01。
InstanceIdString是i-3tiefmkskq3vj0******实例ID。

StoppedMode

String

否

KeepCharging

停机模式，取值：

  • KeepCharging：普通停机模式，停机后继续收费，且为您保留相关资源。

  • StopCharging：节省停机模式。

    • 对于已申请“节省停机”邀测功能通过的账号，平台提供按量计费实例节省停机的能力，您可以选择是否开启该功能。

    • 仅部分实例支持节省停机模式，详情请参见节省停机模式说明。

    • 停机后，将释放vCPU、内存等计算资源；所挂载的云盘、公网IP和带宽(固定带宽模式)将被保留并继续计费。

    • 停机后再次启动实例，将重新创建vCPU、内存等资源，如果实例所在地域库存不足，将启动失败。

    • 私网IP地址及实例停机前已绑定的公网IP地址，在实例重启后仍保持不变。

说明

该参数不传或传入空值时，实例默认为普通停机模式。

ForceStop

Boolean

否

false

是否强制关机，取值：

  • false（默认值）：正常关机。

  • true：强制关机，相当于典型的断电操作，所有未写入存储设备的缓存数据会丢失。

说明

以下类型的实例，ForceStop无论取值为true还是false，实例均会执行强制关机。

  • 弹性裸金属实例

  • 高性能计算GPU型ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2

    ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2正在邀测中，如需试用，请提交工单或联系客户经理申请。

ClientToken

String

否

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

取值：仅支持ASCII字符，且不能超过64个字符。

DryRun

Boolean

否

false

是否只预检此次请求，取值：

  • true：发送检查请求，不会停止实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。

  • false（默认）：发送正常请求，通过检查后直接停止实例。

返回数据

操作接口仅返回公共参数及错误码。

请求示例

GET /?Action=StopInstance&Version=2020-04-01&InstanceId=i-3tiefmkskq3vj0****** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "StopInstance",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.InstanceIdThe required parameter InstanceId is not supplied.实例ID不能为空。
400InvalidStoppedMode.MalformedThe specified StoppedMode is malformed.指定的StoppedMode不合法。
400InvalidInstanceStatusThe status of the specified instance does not support this request.当前实例的状态不支持此操作。
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.幂等参数不一致。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的ClientToken不合法。
400InvalidStoppedModeForScheduledInstance.UnsupportedThe specified scheduled instance does not support stop charging.指定的弹性预约实例不支持节省停机模式。
404InvalidInstance.NotFoundThe specified instance does not exist.指定的实例不存在。
409InvalidStoppedMode.ConflictThe specified StoppedMode conflicts with instance status.StoppedMode与实例状态冲突。
412InvalidStoppedMode.ChargeTypeMismatchThe specified StopCharging mismatch instance's ChargeType.当前实例的计费类型不支持节省停机模式。
412InvalidStoppedMode.InstanceTypeMismatchThe specified StopCharging mismatch instance's InstanceType.当前实例的机型不支持节省停机模式。
412OperationDenied.ResourceLockedThe specified operation is denied as your resource is locked for another operation.指定的操作被拒绝，因为您的资源已被其他操作锁定。
412OperationDenied.ResourceCreatedByOtherServiceThe specified operation is denied as your resource is created by other service. You can check system tags to find the service.指定的操作被拒绝，因为您的资源被其他服务创建。您可以通过资源的系统标签查询对应服务。
412OperationDenied.InstanceIsCreatingImageThe specified operation is denied as your instance is creating image.指定的操作被拒绝，因为您的实例正在创建自定义镜像。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.先前的幂等请求仍在处理中，请稍后重试。

412

DryRunOperation

Your request has been validated by the DryRunOperation.

通过“DryRun”校验，您的请求已通过验证。

500

Insufficient.InstanceCapacity

There is not enough capacity to fulfill your request.

当前资源不足，请稍后重试或选择其它实例规格。

500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。