本介面用於停止一台或多台 ECS 執行個體,支援選擇不同的停機方式、停機模式以及批次操作模式停止執行個體。
介面說明
該介面為非同步介面,執行個體的停止不是立即完成的,成功呼叫後,執行個體會先進入停止中(Stoping)狀態,您可以呼叫 DescribeInstanceStatus 查看執行個體狀態,當返回的狀態為Stopped 時代表停止成功。
使用須知
停止執行個體後執行個體不可用,請確認停止執行個體不會對您的業務造成影響。您可以呼叫 StartInstance 或 StartInstances 介面啟動執行個體。
被安全性鎖定的執行個體不能透過呼叫該介面停止。更多資訊,請參閱資源安全性鎖定對呼叫 API 的影響。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:StopInstances |
update |
*Instance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DryRun |
boolean |
否 |
是否發送預檢請求。取值範圍:
說明
如果參數
預設值:false。 |
false |
| RegionId |
string |
是 |
執行個體所在的地域。您可以呼叫 DescribeRegions 查看最新的阿里雲地域清單。 |
cn-hangzhou |
| ForceStop |
boolean |
否 |
是否強制關機。取值範圍:
預設值:false。 |
false |
| StoppedMode |
string |
否 |
停止模式。取值:
預設值:如果您開啟 VPC 內執行個體節省停機模式並符合開啟條件,則預設值為 |
KeepCharging |
| BatchOptimization |
string |
否 |
設定批次操作模式。取值範圍:
預設值:AllTogether。 |
AllTogether |
| InstanceId |
array |
是 |
執行個體 ID 陣列。陣列長度:1~100。 |
i-bp67acfmxazb4p**** |
|
string |
否 |
執行個體 ID。 |
i-bp67acfmxazb4p**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| InstanceResponses |
object |
||
| InstanceResponse |
array<object> |
由 InstanceResponse 組成的陣列格式,返回每個執行個體操作的前後狀態及操作結果。 |
|
|
object |
|||
| Code |
string |
執行個體操作結果錯誤碼。返回值為 200 表示操作成功。更多資訊,請參閱下文錯誤碼清單。 |
200 |
| CurrentStatus |
string |
執行個體當前狀態。 |
Stopping |
| InstanceId |
string |
執行個體 ID。 |
i-bp67acfmxazb4p**** |
| Message |
string |
執行個體操作返回錯誤資訊。返回值為 |
success |
| PreviousStatus |
string |
執行個體操作前狀態。 |
Running |
| RequestId |
string |
請求 ID。 |
1C488B66-B819-4D14-8711-C4EAAA13AC01 |
樣本
正常返回樣本
JSON格式
{
"InstanceResponses": {
"InstanceResponse": [
{
"Code": "200",
"CurrentStatus": "Stopping",
"InstanceId": "i-bp67acfmxazb4p****",
"Message": "success",
"PreviousStatus": "Running"
}
]
},
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}
錯誤碼
|
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. | ECS 服務無權存取您的 KMS。 |
| 400 | DRYRUN.SUCCESS | This request is a dryrun request with successful result. | 您設定了預檢此次請求,並且檢查通過。 |
| 400 | InvalidParameter.Encrypted.KmsNotEnable | The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again. | |
| 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. | InstanceIds 清單長度超過 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 does not exist. Please verify that the key ID is correct and that the key resides in the current region. | |
| 403 | InvalidOperation.KMSServiceNotOpen | KMS service is currently not open. | KMS 服務尚未啟用。 |
| 403 | OperationDenied.SystemInstanceNotSupport | The system instance does not support the %s operation because %s. | |
| 403 | OperationDenied.KMSKeyUnauthorized | The operation is denied due to missing KMS key authorization. Please check the KMS key permissions and ensure the key is properly authorized for this operation. | |
| 404 | InvalidInstanceId.NotFound | %s | |
| 404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | 指定的 InstanceId 不存在。請檢查 InstanceId 參數值是否正確。您可以呼叫 DescribeInstances 查詢指定執行個體的狀態。 |
| 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. | 由於工作衝突,不允許此操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。