云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器云服务器ECSAPI参考实例StopInstances - 关闭实例
复制全文
下载 pdfStopInstances - 关闭实例
文档反馈
问问助手调用 StopInstances 接口停止一台或多台实例。
使用说明
只有处于 运行中 状态的实例，才支持停止操作。
注意事项
- 实例停止会中断您的业务，请谨慎操作。
- 实例停止后，不会中止计费，且仍会为您保留资源。如需中止计费，您需要 删除实例及其相关资源。
- 抢占式实例停止后，若库存不足，实例将无法再次启动。
- 包年包月实例停止后，不会影响其到期时间。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：StopInstances
要执行的操作，取值：StopInstances。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
ClientToken string 可选 示例值：333456899ff****
保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
取值：仅支持ASCII字符，且不能超过64个字符。
ForceStop boolean 可选 示例值：false
是否强制关机，取值：
- true：强制关机。相当于典型的断电操作，所有未写入存储设备的缓存数据会丢失。
- false（默认）：正常关机。
说明
以下类型的实例，ForceStop无论取值为true还是false，实例均会执行强制关机。
- 弹性裸金属实例。
- 高性能计算GPU型ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2实例。
ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2正在邀测中，如需试用，请联系客户经理申请。
InstanceIds.N string[] 必选 示例值：InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t******
实例ID，最多支持100个。
- 参数 - N：表示实例的序号。
- 多个Instance ID之间用&分隔。
StoppedMode string 可选 示例值：KeepCharging
停机模式，取值：
- KeepCharging：普通停机模式。停机后实例及其相关资源仍被保留且持续计费，费用和停机前一致。
- StopCharging：节省停机模式。停机后实例的计算资源（vCPU、GPU和内存）将被回收且停止计费，所挂载的云盘、镜像、公网IP仍被保留且持续计费。
- 有关节省停机的启用条件，请参见按量计费节省停机模式说明。
返回参数
说明
仅当请求参数输入不合法时提示下文中的接口错误码。若请求参数输入无误，将不会提示接口错误码，且接口的返回状态码将为200，但这并不代表对所有实例的操作均已成功，单个实例的操作结果请参见如下返回参数中的信息。
OperationDetails object[] 示例值：--
操作详情。
Error object 示例值：--
操作的实例错误信息。
Code string 示例值：InvalidInstance.NotFound
批量操作时具体单个请求失败的错误码。取值：
- InvalidInstance.NotFound：指定的实例不存在。
- MissingParameter.InstanceId：实例ID不能为空。
- InvalidInstanceStatus ：当前实例的状态不支持此操作。
- InvalidStoppedMode.Conflict：StoppedMode与实例状态冲突。
- InvalidStoppedMode.ChargeTypeMismatch ：当前实例的计费类型不支持节省停机模式。
- InvalidStoppedMode.InstanceTypeMismatch ：当前实例的机型不支持节省停机模式。
- OperationDenied.ResourceLocked：指定的操作被拒绝，因为您的资源已被其他操作锁定。
- OperationDenied.ResourceCreatedByOtherService：指定的操作被拒绝，因为您的资源被其他服务创建。您可以通过资源的系统标签查询对应服务。
- OperationDenied.InstanceIsCreatingImage：指定的操作被拒绝，因为您的实例正在创建自定义镜像。
- FlowLimitExceeded：您已超过资源请求限速。
- Insufficient.InstanceCapacity：当前资源不足，请稍后重试或选择其它实例规格。
- InternalError：内部错误，请重试。如果多次尝试失败，请提交工单。
- InvalidStoppedModeForScheduledInstance.Unsupported：指定的弹性预约实例不支持节省停机模式。
- InvalidStoppedModeForAffinityGroupInstance.Unsupported：指定的亲和组实例不支持节省停机模式。
说明
Code与Message按顺序一一对应。
Message string 示例值：The specified instance does not exist.
批量操作时具体单个请求失败的错误信息。取值：
- The specified instance does not exist.
- The required parameter InstanceId is not supplied.
- The status of the specified instance does not support this request.
- The specified StoppedMode conflicts with instance status.
- The specified StopCharging does not match the instance's ChargeType.
- The specified StopCharging does not match the instance's InstanceType.
- The specified operation is denied as your resource is locked for another operation.
- The specified operation is denied as your resource is created by other service. You can check system tags to find the service.
- The specified operation is denied as your instance is creating image.
- You've reach the limit on request rate of resources.
- There is not enough capacity to fulfill your request.
- An internal error has occurred.
- The specified scheduled instance does not support stop charging.
- The specified affinity group instance does not support stop charging.
说明
Code与Message按顺序一一对应。
InstanceId string 示例值：i-ybo349sxoncm9t******
操作的实例ID。
请求示例
返回示例
错误码
最近更新时间：2026.05.13 10:11:33
这个页面对您有帮助吗？
有用
有用
无用
无用