ECS インスタンスを停止します。

説明

  • 実行中の状態でのみ、インスタンスを停止できます。
  • API リクエストが成功した後、インスタンスは停止中になり、正常に停止するとインスタンスは停止済みになります。
  • インスタンスを強制的に停止させることができ、強制停止操作は停電と同じです。 インスタンス内の一時ファイルおよびデータが失われる可能性があります。
  • 指定されたインスタンスが ロックされていて、インスタンスの OperationLocksLockReason: securityを示している場合、インスタンスを停止することはできません。
  • ローカルディスクI1 タイプファミリのインスタンスに構成されている場合は、リクエストパラメータ ConfirmStop が必要です。 パラメーター ConfirmStop が True に設定されている場合にのみ、インターフェースを正常に呼び出すことができます。
  • ローカルディスクが設定されている I1 タイプファミリのインスタンスでは、停止後にローカルディスクのデータが消去されます。 アプリケーション層でデータの冗長性を実装して、データの可用性を保証することをお勧めします。
  • この API は、I1 タイプファミリのインスタンスを除くすべてのインスタンスタイプのパラメータ ConfirmStop を自動的に無視します。
  • VPC インスタンスの停止済みインスタンスの非課金化機能を有効にした後、StoppedMode=KeepCharging を設定して機能を無効にし、インスタンスが停止した後に課金され、リソースとインターネット IP アドレスが予約されます。

リクエストパラメータ

名前 必須かどうか 説明
Action String はい このインタフェースの名前。 値:StopInstance。
InstanceId String はい 指定されたインスタンス ID。
ForceStop String いいえ デバイスの再起動時に強制的にシャットダウンするかどうか。値の範囲:
  • true: 強制的にインスタンスをシャットダウンします。
  • false: インスタンスは正常にシャットダウンします。
デフォルト値 : false。
ConfirmStop Boolean いいえ I1 ECS インスタンスを停止するかどうかを指定します。I1 タイプファミリインスタンスに必要なパラメータ。インスタンスが I1 タイプファミリの場合にのみ有効です。 オプションの値:
  • true
  • false
デフォルト値 : false。
StoppedMode String いいえ VPC ECS インスタンスが停止した後に請求されるかどうか。 オプションの値 : KeepCharging。

VPC インスタンスの 停止済みインスタンスの非課金化機能を有効にした後、StoppedMode=KeepCharging を設定して機能を無効にし、ECS インスタンスが停止した後に請求され、リソースとインターネット IP アドレスが予約されます。

レスポンスパラメータ

すべてのパラメータは共通のレスポンスパラメータです。 詳細については、 コモンパラメーターを参照してください。

リクエストの例
  1. https://ecs.aliyuncs.com/?Action=StopInstance&InstanceId=i-instance1&<Common Request Parameters>

レスポンスの例

XML 形式

  1. <StopInstanceResponse> <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId></StopInstanceResponse>
JSON 形式
  1. { RequestId”: 1C488B66-B819-4D14-8711-C4EAAA13AC01”}

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。

エラーコード エラーメッセージ HTTP ステータスコード 意味
DiskError IncorrectDiskStatus 403 指定された ForceStop が無効です。パラメータは列挙された範囲にありません。
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 セキュリティ上の理由からインスタンスがロックされています。
InvalidInstanceId.NotFound The specified InstanceId does not exist. 404 指定された InstanceId は存在しません。