本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

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

强制集群失效转移。

集群的失效转移会将集群中的 Amazon DocumentDB 副本之一（只读实例）提升为主实例（集群写入器）。

当主实例失效时，Amazon DocumentDB 会自动将失效转移到 Amazon DocumentDB 副本（如果存在）。当您要模拟主实例的故障以进行测试时，可以强制进行故障转移。

## 请求参数
<a name="API_FailoverDBCluster_RequestParameters"></a>

 有关所有操作的通用参数的信息，请参阅[通用参数](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS Python 软件开发工具包](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)