FailoverDBCluster - Amazon DocumentDB

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

FailoverDBCluster

強制叢集的容錯移轉。

叢集的容錯移轉會將叢集中的其中一個 Amazon DocumentDB 複本 (唯讀執行個體) 提升為主要執行個體 (叢集寫入器)。

如果主執行個體發生故障,Amazon DocumentDB 會自動容錯移轉到 Amazon DocumentDB 複本 (如果有的話)。當您想要模擬主要執行個體故障以進行測試時,可以強制容錯移轉。

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

DBClusterIdentifier

用於強制容錯移轉的叢集識別碼。此參數不區分大小寫。

約束:

  • 必須符合現有 DBCluster 的識別碼。

類型:字串

必要:否

TargetDBInstanceIdentifier

要提升為主要執行個體的執行個體名稱。

您必須為叢集中的 Amazon DocumentDB 複本指定執行個體識別碼。例如 mydbcluster-replica1

類型:字串

必要:否

回應元素

服務會傳回下列元素。

DBCluster

叢集的詳細資訊。

類型:DBCluster 物件

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

DBClusterNotFoundFault

DBClusterIdentifier不參照現有的叢集。

HTTP 狀態碼:404

InvalidDBClusterStateFault

叢集不是有效的狀態。

HTTP 狀態碼:400

InvalidDBInstanceState

指定的執行個體不處於可用狀態。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: