全部產品
Search
文件中心

Elastic Compute Service:StopInstances

更新時間:Jun 29, 2026

本介面用於停止一台或多台 ECS 執行個體,支援選擇不同的停機方式、停機模式以及批量操作模式停止執行個體。

介面說明

該介面為非同步介面,執行個體的停止不是立即完成的,成功呼叫後,執行個體會先進入停止中(Stoping)狀態,您可以呼叫 DescribeInstanceStatus 查看執行個體狀態,當返回的狀態為Stopped 時代表停止成功。

使用須知

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:StopInstances

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

請求參數

名稱

類型

必填

描述

樣本值

DryRun

boolean

是否傳送預檢請求。取值範圍:

  • true:傳送檢查請求,不會停止執行個體。檢查項包括是否填寫了必需參數、請求格式、執行個體狀態。如果檢查不通過,則返回對應錯誤。如果檢查通過,則返回DRYRUN.SUCCESS

說明

如果參數BatchOptimization被設定為SuccessFirst,對應的DryRun=true的預檢結果只會返回DRYRUN.SUCCESS

  • false:傳送正常請求,通過檢查後直接停止執行個體。

預設值:false。

false

RegionId

string

執行個體所在的地域。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。

cn-hangzhou

ForceStop

boolean

是否強制關機。取值範圍:

  • true:強制關機。
    警告 強制停止等同於斷電處理,可能遺失執行個體作業系統中未寫入磁碟的資料,請謹慎選擇。
  • false:正常關機。

預設值:false。

false

StoppedMode

string

停止模式。取值:

  • StopCharging:節省停機模式。開啟節省停機模式後:

    • 計算資源(vCPU、記憶體、GPU)、映像 License 費用、固定公網 IP 的固定頻寬模式暫停計費。

    • 系統磁碟、資料磁碟、彈性公網 IP 的固定頻寬模式持續計費。

    • 由於計算資源被回收,啟動時可能因庫存不足導致啟動失敗,請您稍後再試或更換執行個體規格。

    • 如果執行個體停止前繫結了彈性公網 IP 位址,重啟後 IP 位址不變;否則,固定公網 IP 位址可能會變,但私網 IP 位址不會變。

    更多資訊,請參見節省停機模式

    重要 如執行個體自身不支援節省停機模式,API 側不會進行報錯攔截,優先保證執行個體停機。不支援節省停機的執行個體類型:本機磁碟執行個體、包年包月執行個體等。

  • KeepCharging:普通停機模式。停止執行個體後保留執行個體的資源並繼續收費,並為您保留 ECS 執行個體規格庫存和公網 IP 位址。如果您停止執行個體是為了更換作業系統、重新初始化雲端硬碟、更改執行個體規格、修改私網 IP 等操作,建議您選擇該模式,以避免啟動失敗。

預設值:如果您開啟 VPC 內執行個體節省停機模式並符合開啟條件,則預設值為StopCharging;否則,預設值為KeepCharging

KeepCharging

BatchOptimization

string

設定批量操作模式。取值範圍:

  • AllTogether:所有操作必須全部成功才能確認整個批量操作的成功。如果任何一個操作失敗,整個批量操作都會被視為失敗,所有已執行的操作都會被回復,恢復到操作前的狀態。

  • SuccessFirst:允許批量操作中的每個操作獨立執行。如果某個操作失敗,其他操作仍然可以繼續執行並確認成功。這種模式下,成功的操作會被提交,失敗的操作會被標記為失敗,但不會影響其他操作的執行結果。

預設值:AllTogether。

AllTogether

InstanceId

array

執行個體 ID 陣列。陣列長度:1~100。

i-bp67acfmxazb4p****

string

執行個體 ID。

i-bp67acfmxazb4p****

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

1C488B66-B819-4D14-8711-C4EAAA13AC01

InstanceResponses

object

InstanceResponse

array<object>

由 InstanceResponse 組成的陣列格式,返回每個執行個體操作的前後狀態及操作結果。

object

Code

string

執行個體操作結果錯誤碼。傳回值為 200 表示操作成功。更多資訊,請參見下文錯誤碼列表。

200

Message

string

執行個體操作返回錯誤資訊。傳回值為success表示操作成功。更多資訊,請參見下文錯誤碼列表。

success

InstanceId

string

執行個體 ID。

i-bp67acfmxazb4p****

CurrentStatus

string

執行個體目前狀態。

Stopping

PreviousStatus

string

執行個體操作前狀態。

Running

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01",
  "InstanceResponses": {
    "InstanceResponse": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp67acfmxazb4p****",
        "CurrentStatus": "Stopping",
        "PreviousStatus": "Running"
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidParameter.KMSKeyId.CMKNotEnabled The CMK needs to be added ECS tag
400 InvalidParameter.KMSKeyId.KMSUnauthorized ECS service account have no right to access your KMS.
400 DRYRUN.SUCCESS This request is a dryrun request with successful result.
400 InvalidParameter.Encrypted.KmsNotEnable Failed to perform this operation because KMS is not activated.
500 InternalError The request processing has failed due to some unknown error.
403 InvalidInstanceId.NotFound InstanceId should not be null.
403 InvalidParameter.TooManyInstanceIds Instance ids cannot be more than 100.
403 Abs.InvalidInstanceIds.MalFormed The specified instanceIds is not valid.
403 InstanceLockedForSecurity %s
403 InstanceExpiredOrInArrears %s
403 IncorrectInstanceStatus %s
403 InvalidInstanceId.NotSupport %s
403 InsufficientBalance Your account does not have enough balance.
403 InstanceNotReady The specified instance is not ready for use.
403 InvalidOperation.KMSKeyIdNotFound The specified KMSKeyId not found, %s.
403 InvalidOperation.KMSServiceNotOpen KMS service is currently not open.
403 OperationDenied.SystemInstanceNotSupport The system instance does not support the %s operation because %s.
404 InvalidInstanceId.NotFound %s
404 InvalidInstanceIds.NotFound The specified InstanceIds does not exist.
503 LimitedOperation.ServiceUnavailable The service is currently unavailable. Please try again later.
409 InvalidOperation.Conflict Request was denied due to conflict with a previous request, please try again later.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情