本接口用于停止一臺或多臺 ECS 實例，支持通過設置參數來選擇不同的關機方式、停機模式以及批量操作模式。
接口說明
該接口為異步接口，實例的停止不是立即完成的，成功調用后，實例會先進入停止中（Stoping）狀態，你可以調用 DescribeInstanceStatus 查看實例狀態，當返回的狀態為Stoped時代表啟動成功。
使用須知
- 被安全鎖定的實例不能通過調用該接口停止。更多信息，請參見資源安全鎖定對調用 API 的影響。
- 按量付費實例開啟 VPC 內實例節省停機模式后，您可以通過設置
StoppedMode=KeepCharging開啟普通停機模式，ECS 實例停止后會繼續計費，并為您保留 ECS 實例規格庫存和公網 IP 地址。
調試
您可以在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 | 否 | 是否只預檢此次請求。取值范圍：
說明
如果參數 BatchOptimization被設置為SuccessFirst，對應的DryRun=true的預檢結果只會返回DRYRUN.SUCCESS。
默認值：false。 | false |
| RegionId | string | 是 | 實例所在的地域。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ForceStop | boolean | 否 | 是否強制關機。取值范圍：
默認值：false。 | false |
| StoppedMode | string | 否 | 停止按量付費 ECS 實例時，設置的停止模式。取值：
默認值：如果您在 ECS 控制臺上開啟 VPC 內實例節省停機模式（更多信息，請參見打開默認啟用節省停機模式），并符合開啟條件，則默認值為 | KeepCharging |
| BatchOptimization | string | 否 | 設置批量操作模式。取值范圍：
默認值：AllTogether。 | AllTogether |
| InstanceId | array | 是 | 實例 ID 數組。數組長度：1~100。 | |
| string | 是 | 實例 ID。 | i-bp67acfmxazb4p**** |
返回參數
示例
正常返回示例
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.CMKNotEnabled | The CMK needs to be enabled. | 加密云盤設置了 KMSKeyId 后，CMK必須處于啟用狀態。您可以調用密鑰管理服務的 DescribeKey 接口查詢指定CMK的相關信息。 |
| 400 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service account have no right to access your KMS. | ECS 服務無權訪問您的 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. | 您需要開通KMS密鑰托管服務。 |
| 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. | 指定的InstanceId參數不合法 |
| 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. | 無法找到關聯的KMS加密密鑰，請確認該KMS加密密鑰有效性。 |
| 403 | InvalidOperation.KMSServiceNotOpen | KMS service is currently not open. | KMS服務尚未啟用. |
| 404 | InvalidInstanceId.NotFound | %s | 指定的實例不存在，請確認參數 InstanceId 是否正確。 |
| 404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | 指定的 InstanceId 不存在。請檢查 InstanceId 參數值是否正確。您可以調用 DescribeInstances 查詢指定實例的狀態。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
| 409 | InvalidOperation.Conflict | Request was denied due to conflict with a previous request, please try again later. | 請求操作的資源與之前的請求沖突 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史