このAPIを呼び出して、実行中状態にある1つ以上のECSインスタンスを再起動できます。 この操作が呼び出されると、ECSインスタンスは [停止中] 状態になり、[実行中] 状態になります。

説明

  • 再起動するECSインスタンスは、Running (Running) ステータスである必要があります。
  • バッチ操作がサポートされています。 BatchOptimizationパラメーターを使用して、バッチ操作モードを指定できます。
  • インスタンスを強制的に再起動できます。 強制再起動 (ForceStop) は、従来のサーバーを電源オフして再起動するのと同じです。 インスタンス内のデータがElastic Block Storageデバイスに書き込まれていない場合、この操作によりデータが失われる可能性があります。
  • If応答含まれ {"OperationLocks": {"LockReason" : "セキュリティ"}} 際クエリ情報のインスタンス、インスタンスはロックセキュリティ上の理由からとすべての操作に禁止されていインスタンス。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 RebootInstances

実行する操作です。 値をRebootInstancesに設定します。
<td class="en-UStry align-left colsep-1 rowsep-1"> InstanceId.N </td> RepeatList 必須 i-bp67acfmxazb4p****

再起動するインスタンスNのID。 N: 1 ~ 100の有効値。
RegionId String 必須 cn-hangzhou

インスタンスのリージョンID。 DescribeRegions を呼び出すと、最新のリージョンリストを照会できます。

DryRun Boolean 任意 false

実際にリクエストを行わずに、リクエストの有効性を確認するかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: リクエストの有効性はチェックされますが、リクエストは行われません。 チェック項目には、リクエスト形式、インスタンスのステータス、必要なパラメーターが指定されているかどうかが含まれます。 確認が失敗した場合、対応するエラーメッセージが返されます。 チェックが成功した場合、DRYRUN.SUCCESSが返されます。
    注 BatchOptimizationをSuccessFirstおよびDryRunをtrueに設定した場合、チェックが成功したかどうかに関係なく、DRYRUN.SUCCESSのみが返されます。
  • false: リクエストの有効性がチェックされ、チェックが成功するとリクエストが行われます。

規定値: false
ForceReboot Boolean 任意 false

インスタンスを強制的に再起動するかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: インスタンスを強制的に再起動します。 この動作は、通常の電源オフ動作に相当する。 インスタンス内のストレージに書き込まれていないキャッシュデータは失われます。
  • false: 通常、インスタンスを再起動します。

規定値: false
バッチ最適化 String 任意 AllTogether

バッチ操作モード。 設定可能な値は以下のとおりです。

  • AllTogether: このモードでは、すべてのインスタンスが再起動されると、成功メッセージが返されます。 インスタンスが検証に失敗すると、すべてのインスタンスの再起動に失敗し、エラーメッセージが返されます。
  • SuccessFirst: このモードでは、各インスタンスが個別に再起動されます。 レスポンスには、各インスタンスの操作結果が含まれます。

デフォルト値: AllTogether。

レスポンスパラメーター

パラメーター データ型 例 説明
インスタンス応答 InstanceResponseの配列

操作が呼び出される前後の各インスタンスのステータスと操作の結果を含む、インスタンス応答の詳細。
InstanceResponse
Code String 200

操作結果のエラーコード。 戻り値200は成功を示す。 詳細については、このトピックの「エラーコード」セクションを参照してください。
CurrentStatus String Stopping

インスタンスの現在のステータス。
InstanceId String i-bp1g6zv0ce8oghu7 ****

インスタンスの ID。
Message String success

インスタンス操作のエラーメッセージ。 戻り値Successは操作の成功を示します。 詳細については、このトピックの「エラーコード」セクションを参照してください。
PreviousStatus String 実行中

操作が呼び出される前のインスタンスのステータス。
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエストの ID です。

例

リクエストの例

https://ecs.aliyuncs.com/?Action=RebootInstances
&InstanceId.1=i-bp1g6zv0ce8oghu7 ****
&InstanceId.2=i-bp1g6zv0ce8oghu7 ****
&InstanceId.3=i-TestID
&RegionId=cn-hangzhou
&ForceReboot=false
$BatchOptimization=SuccessFirst
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<RebootInstancesResponse>
      <RequestId>FF53E96D-3F1A-42F0-8373-1C2B39D72D44</RequestId>
      <InstanceResponses>
            <InstanceResponse>
                  <Message>success</Message>
                  <InstanceId>i-bp1g6zv0ce8oghu7 ****</InstanceId>
                  <PreviousStatus> 実行中 </PreviousStatus>
                  <CurrentStatus> 停止 </CurrentStatus>
                  <Code>200</Code>
            </InstanceResponse>
            <InstanceResponse>
                  <Message>success</Message>
                  <InstanceId>i-bp1g6zv0ce8oghu7 ****</InstanceId>
                  <PreviousStatus> 実行中 </PreviousStatus>
                  <CurrentStatus> 停止 </CurrentStatus>
                  <Code>200</Code>
            </InstanceResponse>
            <InstanceResponse>
                  <Message> 指定されたInstanceIdは存在しません。 </Message>
                  <InstanceId>i-TestID</InstanceId>
                  <PreviousStatus></PreviousStatus>
                  <CurrentStatus></CurrentStatus>
                  <Code>InvalidInstanceId.NotFound</Code>
            </InstanceResponse>
      </InstanceResponses>
</RebootInstancesResponse>

JSON 形式 

{
    "RequestId": "FF53E96D-3F1A-42F0-8373-1C2B39D72D44" 、
    "InstanceResponses": {
        "InstanceResponse": [
            {
                "Message": "success",
                "InstanceId": "i-bp1g6zv0ce8oghu7 ****" 、
                "PreviousStatus": "Running" 、
                "CurrentStatus": "Stopping" 、
                "Code": "200"
            },
            {
                "Message": "success",
                "InstanceId": "i-bp1g6zv0ce8oghu7 ****" 、
                "PreviousStatus": "Running" 、
                "CurrentStatus": "Stopping" 、
                "Code": "200"
            },
            {
                "Message": "指定されたInstanceIdは存在しません。" 、
                "InstanceId": "i-TestID" 、
                "PreviousStatus": "" 、
                "CurrentStatus": "" 、
                "コード": "InvalidInstanceId.NotFound"
            }
        ]
    }
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
404 InvalidInstanceId.NotFound %s 指定されたインスタンスIDが存在しない場合に返されるエラーメッセージ。
403 IncorrectInstanceStatus %s 現在のインスタンスのステータスで該当の操作がサポートされていない場合に返されるエラーメッセージ。
500 InternalError 不明なエラーにより、リクエスト処理が失敗しました。 内部エラーが発生した場合に返されるエラーメッセージです。 しばらくしてから再試行します。 問題が解決しない場合、チケットを起票し、サポートセンターへお問い合わせください。
404 InvalidInstanceId.NotFound 指定されたInstanceIdは存在しません。 指定されたインスタンスIDが存在しない場合に返されるエラーメッセージ。
403 InsufficientBalance Your account does not have enough balance. アカウントの残高が不十分な場合に返されるエラーメッセージ。 アカウントに資金を追加して、もう一度お試しください。
403 InstanceNotReady 指定されたインスタンスは使用できる状態ではありません。 リソースの現在のステータスで該当の操作がサポートされていない場合に返されるエラーメッセージ。 しばらくしてから再試行します。

エラーコードリストについては、「API エラーセンター」をご参照ください。