この API は、ECS インスタンスを停止する場合に呼び出すことができます。

説明

  • 実行中Running)状態にあるインスタンスのみを停止できます。
  • この API を呼び出すと、インスタンスは停止Stopping)状態に入ります。 インスタンスが停止後、インスタンスは停止Stopped)状態になります。
  • インスタンスを強制停止できます。 ただし、インスタンスのデータがディスクに書き込まれていない場合、データ損失の原因になる場合があります。
  • Security Control が有効になっており、OperationLocksタグが"LockReason" : "security"として付いている ECS インスタンスを停止することはできません。
  • Local Disk Storage(Local \ _ storage)が構成され、I1 インスタンスタイプファミリであるインスタンスの場合、ConfirmStopを指定して、その値をTrueに設定する必要があります。 それ以外の場合は、エラーが返されます。
  • I1 インスタンスタイプファミリの場合、ローカルディスクのデータは、インスタンスが停止した後にクリアされます。 データの可用性を保証するために、アプリケーション層にデータ冗長性を実装することを推奨します。
  • 他のインスタンスタイプファミリのインスタンスの場合、ConfirmStopパラメーターは無視されます。
  • StopCharging が選択されている場合、StoppedMode=KeepChargingを構成して KeepCharging にすることができます。 そうすればインスタンスの停止後も請求され、 インスタンスタイプとパブリック IP アドレスなどは、このインスタンス用に予約されます。

デバッグ

API Explorer でデバッグを実行できます。 API Explorer で各種操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成ができます。

リクエストパラメーター

名前 データ型 必須/省略可能 説明
InstanceId String 必須 i-instanceid1

インスタンスの ID。

Action String 省略可能 StopInstance

実行する操作。 値を StopInstance に設定します。

StoppedMode String 省略可能 KeepCharging

ECS インスタンスが停止後も請求されているかどうかを示します。 有効値:KeepCharging

StopCharging が選択されている場合、StoppedMode=KeepChargingを構成して KeepCharging にすることができます。 そうすればインスタンスの停止後も請求され、 インスタンスタイプとパブリック IP アドレスなどは、このインスタンス用に予約されます。

ForceStop Boolean 省略可能 false

インスタンスを強制的に停止するかどうかを示します。 有効値:

  • true 。
  • false 。
ConfirmStop Boolean 省略可能 true

停止操作を確認するかどうかを示します。 このパラメーターは必須であり、I1 インスタンスタイプファミリーのインスタンスにのみ適用されます。 デフォルト値:false。

レスポンスパラメーター

名前 データ型 説明
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエスト ID。

リクエスト例


https://ecs.aliyuncs.com/?Action=StopInstance
&InstanceId=i-instanceid1
&ConfirmStop=true
&ForceStop=false
&StoppedMode=keepcharging
&<Common request parameters>

通常のレスポンスの例

XML 形式

<StopInstanceResponse>
  <RequestId>1C488B66-B819-4D14-8711-C4EAAA13AC01</RequestId>
</StopInstanceResponse>

JSON 形式

{
	"RequestId":"1C488B66-B819-4D14-8711-C4EAAA13AC01"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
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. インスタンスにローカルディスクストレージが構成されている場合に返されるエラーメッセージ。 ConfirmStop パラメーターを true に設定する必要があります。
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 InvalidInstanceId.NotSupport Pre pay instance does not support this operation. サブスクリプションインスタンスで操作がサポートされていない場合に返されるエラーメッセージ。
403 InvalidInstanceId.NotSupport Local disk instance does not support this operation. 操作がローカルディスクインスタンスでサポートされていない場合に返されるエラーメッセージ。
403 InvalidInstanceId.NotSupport Spot instance does not support this operation. プリエンプティブインスタンスで操作がサポートされていない場合に返されるエラーメッセージ。
403 IncorrectInstanceStatus %s 現在の状態のインスタンスでは該当の操作が実行できない場合に表示されるエラーメッセージ。

エラーコードの表示