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

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

強制叢集的容錯移轉。

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

如果主要執行個體失敗，Amazon DocumentDB 會自動容錯移轉至 Amazon DocumentDB 複本，如果有的話。當您想要模擬主要執行個體故障以進行測試時，可以強制容錯移轉。

## 請求參數
<a name="API_FailoverDBCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
強制容錯移轉的叢集識別符。此參數不區分大小寫。  
限制條件：  
+ 必須符合現有 `DBCluster` 的識別碼。
類型：字串  
必要：否

 ** TargetDBInstanceIdentifier **   
要提升為主要執行個體的執行個體名稱。  
您必須為叢集中的 Amazon DocumentDB 複本指定執行個體識別符。例如 `mydbcluster-replica1`。  
類型：字串  
必要：否

## 回應元素
<a name="API_FailoverDBCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_FailoverDBCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_FailoverDBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster)