停止運行一台執行個體。

描述

  • 只有狀態為 運行中Running)的執行個體才可以進行此操作。
  • 成功調用介面後執行個體進入 停止中Stopping) 狀態。執行個體成功停止關機後進入 已停止Stopped)狀態。
  • 支援強制停止,等同於斷電處理,可能丟失執行個體作業系統中未寫入磁碟的資料。
  • 安全控制 的執行個體的 OperationLocks 中標記了 "LockReason" : "security" 的鎖定狀態時,不能停止執行個體。
  • 對於配置 本地碟儲存(Local_storage) 的 I1 規格類型系列 執行個體,ConfirmStop 入參為必選,取值為 True 後介面調用才會成功,否則會返回錯誤碼。
  • I1 規格類型系列執行個體,成功調用介面後,本地碟儲存上的資料將會被清空,需要通過應用程式層的資料冗餘保證資料可用性。
  • 系統自動忽略其他規格類型系列執行個體的 ConfirmStop 入參。
  • 開通 預設VPC內執行個體停機不收費 功能後,您可以通過設定 StoppedMode=KeepCharging 保持停機收費,ECS 執行個體停止後會繼續計費,並為您保留 ECS 執行個體規格庫存和公網 IP 位址。

請求參數

名稱 類型 是否必需 描述
Action String 系統規定參數。取值:StopInstance
InstanceId String 指定的執行個體 ID。
ForceStop String 停止執行個體時的是否強制關機策略。取值範圍:
  • true:強制關機
  • false:順利關機流程
預設值:false
ConfirmStop String 是否確認關機。僅對 I1 型執行個體規格類型系列生效,且為 I1 型的執行個體規格類型系列的必須入參。取值範圍:
  • true
  • false
預設值:false
StoppedMode String 停止 ECS 執行個體後,執行個體依然計費。取值:KeepCharging

開通 預設VPC內執行個體停機不收費 功能後,您可以通過設定 StoppedMode=KeepCharging 保持停機收費,ECS 執行個體停止後會繼續計費,並為您保留 ECS 執行個體規格庫存和公網 IP 位址。

返回參數

全是公共返回參數。參閱公共參數

樣本

請求樣本
https://ecs.aliyuncs.com/?Action=StopInstance
&InstanceId=i-instance1
&<公共請求參數>
返回樣本

XML 格式

<StopInstanceResponse>
    <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>
</StopInstanceResponse>
JSON 格式
{
    "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
DiskError IncorrectDiskStatus 403 不正常的磁碟狀態。
InstanceLockedForSecurity The specified operation is denied as your instance is locked for security reasons. 403 該資源目前被安全鎖定被拒絕操作。
IncorrectInstanceStatus The current status of the resource does not support this operation. 403 該資源目前的狀態不支援此操作。
InstanceType.ParameterMismatch The input parameter ConfirmStop must be true when an instance have localstorage. 403 ConfirmStop 入參值不正確。
InvalidInstanceId.NotFound The specified InstanceId does not exist. 404 指定的 InstanceId 不存在。