FailoverDBCluster - Amazon DocumentDB

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

FailoverDBCluster

クラスターのフェイルオーバーを強制実行します。

クラスターのフェイルオーバーにより、クラスター内のAmazon DocumentDB レプリカ (読み取り専用インスタンス) の1つをプライマリインスタンス(クラスターライター)に昇格されます。

プライマリインスタンスに障害が発生した場合、Amazon DocumentDB レプリカが存在すると、自動的にフェイルオーバーします。テストのため、プライマリインスタンスの失敗をシミュレートする場合は、フェイルオーバーを強制できます。

リクエストパラメータ

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

DBClusterIdentifier

フェイルオーバーを強制するクラスター識別子。このパラメータは大文字と小文字が区別されません。

制約:

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

タイプ: 文字列

必須: いいえ

TargetDBInstanceIdentifier

プライマリインスタンスに昇格するインスタンスの名前。

クラスター内のAmazon DocumentDB レプリカのインスタンス識別子を指定する必要があります。例えば、mydbcluster-replica1

型: 文字列

必須: いいえ

レスポンス要素

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

DBCluster

クラスターに関する詳細情報。

型: DBCluster オブジェクト

エラー

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

DBClusterNotFoundFault

DBClusterIdentifier は既存のクラスターを参照していません。

HTTP ステータスコード: 404

InvalidDBClusterStateFault

クラスターは有効な状態ではありません。

HTTP ステータスコード:400

InvalidDBInstanceState

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

HTTP ステータスコード:400

その他の参照資料

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