Elastic Compute Service (ECS) インスタンスを再起動します。この操作を呼び出す際に、パラメーターを設定してバッチ操作モードやインスタンスを強制的に再起動するかどうかを指定できます。
操作説明
このインターフェースは非同期です。インスタンスの再起動はすぐには完了しません。呼び出しが成功すると、インスタンスはまず起動中 (Starting) 状態になります。DescribeInstanceStatus を呼び出してインスタンスのステータスを確認できます。返されたステータスが Running になると、再起動は成功です。
注意事項
セキュリティロックされているインスタンスは、このインターフェースを呼び出して再起動することはできません。詳細については、「リソースのセキュリティロックが API 呼び出しに与える影響」をご参照ください。
ECS インスタンスのステータスは実行中 (
Running) である必要があります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:RebootInstances |
update |
*Instance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DryRun |
boolean |
任意 |
リクエストを実際に実行せずに、ドライランのみを実行するかどうかを指定します。有効な値:
説明
デフォルト値:false。 |
false |
| RegionId |
string |
必須 |
リージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| ForceReboot |
boolean |
任意 |
インスタンスを強制的に再起動するかどうかを指定します。有効な値:
デフォルト値:false。 |
false |
| BatchOptimization |
string |
任意 |
バッチ操作モード。有効な値:
デフォルト値:AllTogether。 |
AllTogether |
| InstanceId |
array |
必須 |
ECS インスタンスの ID。N の有効値の範囲は 1~100 です。 |
i-bp67acfmxazb4p**** |
|
string |
任意 |
ECS インスタンス N の ID。 |
i-bp67acfmxazb4p**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| InstanceResponses |
object |
||
| InstanceResponse |
array<object> |
インスタンス固有のレスポンスに関する詳細。操作の呼び出し前後の各インスタンスのステータスと操作の結果が含まれます。 |
|
|
object |
|||
| Code |
string |
インスタンスに対して返されるエラーコード。戻り値 200 は、操作が成功したことを示します。詳細については、このトピックの「エラーコード」セクションをご参照ください。 |
200 |
| Message |
string |
インスタンスに対する操作で返されるエラーメッセージ。戻り値 Success は、操作が成功したことを示します。詳細については、このトピックの「エラーコード」セクションをご参照ください。 |
success |
| InstanceId |
string |
インスタンスの ID。 |
i-bp1g6zv0ce8oghu7**** |
| CurrentStatus |
string |
インスタンスの現在の状態。 |
Stopping |
| PreviousStatus |
string |
操作が呼び出される前のインスタンスの状態。 |
Running |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"InstanceResponses": {
"InstanceResponse": [
{
"Code": "200",
"Message": "success",
"InstanceId": "i-bp1g6zv0ce8oghu7****",
"CurrentStatus": "Stopping",
"PreviousStatus": "Running"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. | |
| 400 | DRYRUN.SUCCESS | This request is a dryrun request with successful result. | |
| 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. | |
| 403 | Abs.InvalidInstanceIds.MalFormed | The specified instanceIds is not valid. | |
| 403 | InstanceLockedForSecurity | %s | |
| 403 | InstanceExpiredOrInArrears | %s | |
| 403 | IncorrectInstanceStatus | %s | |
| 403 | InvalidInstance.NotFoundSystemDisk | %s | |
| 403 | InsufficientBalance | Your account does not have enough balance. | |
| 403 | InstanceNotReady | The specified instance is not ready for use. | |
| 404 | InvalidInstanceId.NotFound | %s | |
| 404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。