停止实例
描述
停止一个指定的实例。
只有状态为 Running 的实例才可以进行此操作。
接口调用成功后实例进入 Stopping 状态。系统后台会在实例实际 Stop 成功后进入 Stopped 状态。
实例支持强制停止，强制停止等同于断电处理，可能丢失实例操作系统中未写入磁盘的数据。
被安全控制在实例的 OperationLocks 中标记了 "LockReason" : "security" 的锁定状态时，不能停止实例。
请求参数
名称 |
类型 |
是否必须 |
描述 |
Action
String
是
系统规定参数，取值：StopInstance
InstanceId
String
是
指定的实例 ID
ForceStop
String
否
重启机器时的是否强制关机策略。取值：
默认值为 false。
若为 false 则走正常关机流程；若为 true 则强制关机。
返回参数
全是公共返回参数，详见公共返回参数
错误码
错误代码 |
描述 |
Http 状态码 |
语义 |
InvalidInstanceId.NotFound
The InstanceId provided does not exist in our records.
404
指定的 InstanceId 不存在
MissingParameter
The input parameter "InstanceId" that is mandatory for processing this request is not supplied.
400
缺少 InstanceId 值
InvalidParameter
The specified parameter "ForceStop" is not valid.
400
指定的 ForceStop 不合法，（不在枚举范围内）
IncorrectInstanceStatus
The current status of the resource does not support this operation.
403
该资源目前的状态不支持此操作
InstanceLockedForSecurity
The specified operation is denied as your instance is locked for security reasons.
403
该资源目前被安全锁定被拒绝操作
示例
请求示例
https://ecs.aliyuncs.com/?Action=StopInstance
&InstanceId=i-instance1
&<公共请求参数>
返回示例
XML格式
1C488B66-B819-4D14-8711-C4EAAA13AC01
JSON格式
{
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}
所属专题: