本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
FailoverDBCluster
强制集群失效转移。
集群的失效转移会将集群中的 Amazon DocumentDB 副本之一(只读实例)提升为主实例(集群写入器)。
当主实例失效时,Amazon DocumentDB 会自动将失效转移到 Amazon DocumentDB 副本(如果存在)。当您要模拟主实例的故障以进行测试时,可以强制进行故障转移。
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
- DBClusterIdentifier
-
用于强制进行失效转移的集群标识符。此参数不区分大小写。
约束:
-
必须与现有
DBCluster
的标识符匹配。
类型:字符串
必需:否
-
- TargetDBInstanceIdentifier
-
提升为主实例的实例的名称。
您必须指定 Amazon DocumentDB 集群中只读副本的实例标识符。例如:
mydbcluster-replica1
。类型:字符串
必需:否
响应元素
服务返回以下元素。
- DBCluster
-
有关集群的详细信息。
类型:DBCluster 对象
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- DBClusterNotFoundFault
-
DBClusterIdentifier
并不引用现有集群。HTTP 状态代码:404
- InvalidDBClusterStateFault
-
集群未处于有效状态。
HTTP 状态代码:400
- InvalidDBInstanceState
-
指定的实例未处于可用 状态。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: