StopInstance - 关闭一台实例--云服务器-火山引擎

文档中心

立即注册

导航

StopInstance - 关闭一台实例

最近更新时间：2024.05.21 10:23:55首次发布时间：2021.07.31 07:48:16

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

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	StopInstance	要执行的操作，取值：StopInstance。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ForceStop	Boolean	否	false	是否强制关机，取值： true：强制关机。相当于典型的断电操作，所有未写入存储设备的缓存数据会丢失。 false（默认）：正常关机。说明以下类型的实例，`ForceStop`无论取值为`true`还是`false`，实例均会执行强制关机。弹性裸金属实例。高性能计算GPU型ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2实例。 ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2正在邀测中，如需试用，请联系客户经理申请。
StoppedMode	String	否	KeepCharging	停机模式。取值： KeepCharging（默认）：普通停机模式，停机后继续收费，且为您保留相关资源。 StopCharging：节省停机模式。对于已申请“节省停机”邀测功能通过的账号，平台提供按量计费实例节省停机的能力，您可以选择是否开启该功能。仅部分实例支持节省停机模式，详情请参见节省停机模式说明。停机后，将释放vCPU、内存等计算资源；所挂载的云盘、公网IP和带宽(固定带宽模式)将被保留并继续计费。停机后再次启动实例，将重新创建vCPU、内存等资源，如果实例所在地域库存不足，将启动失败。私网IP地址及实例停机前已绑定的公网IP地址，在实例重启后仍保持不变。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。
DryRun	Boolean	否	false	是否只预检此次请求。取值： true：发送检查请求，不会停止实例。检查项包括是否填写了必需参数、请求格式、业务限制和ECS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。 false（默认）：发送正常请求，通过检查后直接停止实例。
InstanceId	String	是	i-3tiefmkskq3vj0x0****	实例ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

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": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidStoppedMode.Malformed	The specified StoppedMode is malformed.	指定的StoppedMode不合法。
400	InvalidStoppedModeForScheduledInstance.Unsupported	The specified scheduled instance does not support stop charging.	指定的弹性预约实例不支持节省停机模式。
400	InvalidDedicatedHostStatus.Unsupported	The status of the specified dedicated host does not support this request.	当前专有宿主机的状态不支持此操作。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的ClientToken不合法。
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	IdempotentParameterMismatch	The 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.	幂等参数不一致。
400	MissingParameter.InstanceId	The required parameter InstanceId is not supplied.	参数实例ID不能为空。
400	InvalidInstanceStatus	The status of the specified instance does not support this request.	当前实例的状态不支持此操作。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
409	InvalidStoppedMode.Conflict	The specified StoppedMode conflicts with instance status.	StoppedMode与实例状态冲突。
412	OperationDenied.ResourceLocked	The specified operation is denied as your resource is locked for another operation.	指定的操作被拒绝，因为您的资源已被其他操作锁定。
412	OperationDenied.ResourceCreatedByOtherService	The specified operation is denied as your resource is created by other service. You can check system tags to find the service.	指定的操作被拒绝，因为您的资源被其他服务创建。您可以通过资源的系统标签查询对应服务。
412	OperationDenied.InstanceIsCreatingImage	The specified operation is denied as your instance is creating image.	指定的操作被拒绝，因为该实例正在创建自定义镜像。
412	InvalidStoppedMode.InstanceTypeMismatch	The specified StopCharging mismatch instance's InstanceType.	当前实例的机型不支持节省停机模式。
412	InvalidStoppedMode.ChargeTypeMismatch	The specified StopCharging mismatch instance's ChargeType.	当前实例的计费类型不支持节省停机模式。
412	DryRunOperation	Your request has been validated by the DryRunOperation.	通过“DryRun”校验，您的请求已通过验证。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	先前的幂等请求仍在处理中，请稍后重试。
500	Insufficient.InstanceCapacity	There is not enough capacity to fulfill your request.	当前资源不足，请稍后重试或选择其它实例规格。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。