Elastic Compute サービス (ECS) インスタンスを停止します。異なる停止戦略、停止モード、およびバッチ操作モードを指定して ECS インスタンスを停止できます。
操作説明
これは非同期操作です。呼び出しが成功しても、ECS インスタンスはすぐには停止しません。ECS インスタンスはまず Stopping 状態に遷移します。 DescribeInstanceStatus を呼び出してインスタンスステータスをクエリできます。返されたステータスが Stopped の場合、ECS インスタンスは停止しています。
事前準備
セキュリティ上の理由でロック済みの ECS インスタンスは、この操作を呼び出しても停止できません。詳細については、「リソースセキュリティロックが API 呼び出しに与える影響」をご参照ください。
VPC 接続インスタンスの節約モードを有効にした後、
StoppedMode=KeepChargingをセットして標準停止モードを有効にできます。ECS インスタンスは停止後も課金が継続され、ECS インスタンスタイプの在庫とインターネット IP アドレスが保持されます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:StopInstance |
update |
*Instance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID |
i-bp67acfmxazb4ph**** |
| ConfirmStop |
boolean |
任意 |
このパラメーターはまもなく廃止される予定であり、互換性のためにのみ保持されています。この操作を呼び出す際はこのパラメーターを無視してください。 |
true |
| ForceStop |
boolean |
任意 |
インスタンスを強制的に停止するかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| StoppedMode |
string |
任意 |
従量課金 ECS インスタンスの停止モード。有効な値:
デフォルト値: ECS コンソールで VPC 接続インスタンスの節約モードを有効にしている場合 (詳細については、「デフォルトで節約モードを有効にする」をご参照ください)、かつ条件が満たされている場合、デフォルト値は |
KeepCharging |
| DryRun |
boolean |
任意 |
ドライランのみを実行するかどうかを指定します。有効な値:
デフォルト値: false。 |
true |
| Hibernate |
boolean |
任意 |
説明
このパラメーターは招待プレビュー中であり、使用できません。 |
hide |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID |
1C488B66-B819-4D14-8711-C4EAAA13AC01 |
例
成功レスポンス
JSONJSON
{
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter.Encrypted.KmsNotEnable | Failed to perform this operation because KMS is not activated. | |
| 400 | DiskError | IncorrectDiskStatus. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | 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 | InstanceType.ParameterMismatch | The input parameter ConfirmStop must be true when an instance have localstorage. | |
| 403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | |
| 403 | InvalidInstanceId.NotSupport | Classic network Instance does not support this operation. | |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag | |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | |
| 403 | HibernationConfigured.InstanceOperationForbidden | The operation is not permitted due to limit of the hibernation configured instance. | |
| 403 | HibernationConfigured.NotEnabled | The instance hibernation configured option is not enabled. | |
| 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 | The specified InstanceId does not exist. | |
| 503 | LimitedOperation.ServiceUnavailable | The service is currently unavailable. Please try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。