RebootDBInstance - Amazon DocumentDB

RebootDBInstance

通常はメンテナンスのためにインスタンスを再起動する必要があります。例えば、特定の変更を行う場合や、インスタンスに関連付けられたクラスターパラメーターグループを変更した場合は、変更を有効にするためにインスタンスを再起動する必要があります。

インスタンスを再起動すると、データベースエンジンサービスが再起動されます。インスタンスを再起動すると一時的に機能停止になります。その間、DB インスタンスのステータスは [rebooting] に設定されます。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

DBInstanceIdentifier

インスタンス識別子。このパラメータは小文字で保存されます。

制約:

  • 既存の DBInstance の識別子と一致する必要があります。

型: 文字列

必須: はい

ForceFailover

true の場合、再起動はマルチ AZ フェイルオーバーによって行われます。

制約: インスタンスがマルチ AZ 用に設定されていない場合、true を指定することはできません。

型: ブール値

必須:いいえ

レスポンス要素

以下の要素がサービスによって返されます。

DBInstance

インスタンスに関する詳細情報。

型: DBInstance オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

DBInstanceNotFound

DBInstanceIdentifier が既存の DB インスタンスを参照していません。

HTTP ステータスコード: 404

InvalidDBInstanceState

指定されたインスタンスは 利用可能な 状態ではありません。

HTTP ステータスコード:400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。