FailoverGlobalCluster - Amazon DocumentDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

FailoverGlobalCluster

全局集群发生失效转移时,将指定的辅助数据库集群提升为全局群集的主数据库集群。

使用此操作来应对计划外事件,例如主区域发生区域性灾难。失效转移可导致在失效转移事件发生之前,未复制到选定辅助区域的写入事务数据丢失。但是,将所选辅助数据库集群上的数据库实例提升为主写入器数据库实例的恢复过程可确保数据处于事务一致状态。

请求参数

有关所有操作的通用参数的信息,请参阅通用参数

GlobalClusterIdentifier

用于应用此操作的 Amazon DocumentDB 全局集群标识符。标识符是用户在创建集群时分配的唯一密钥。换句话说,这是全局集群的名称。

约束:

  • 必须匹配现有全局集群的标识符。

  • 最小长度为 1。最大长度为 255。

模式:[A-Za-z][0-9A-Za-z-:._]*

类型:字符串

长度限制:长度下限为 1。最大长度为 255。

模式:[A-Za-z][0-9A-Za-z-:._]*

必需:是

TargetDbClusterIdentifier

要提升为全局集群主集群的 Amazon DocumentDB 辅助集群的标识符。使用 Amazon 资源名称 (ARN) 作为标识符,这样 Amazon DocumentDB 就可以在其 Amazon 区域内找到集群。

约束:

  • 必须与现有辅助集群的标识符匹配。

  • 最小长度为 1。最大长度为 255。

模式:[A-Za-z][0-9A-Za-z-:._]*

类型:字符串

长度限制:长度下限为 1。最大长度为 255。

模式:[A-Za-z][0-9A-Za-z-:._]*

必需:是

AllowDataLoss

指定是否允许此全局群集操作丢失数据。允许丢失数据会触发全局失效转移操作。

如果未指定 AllowDataLoss,全局集群操作默认采用切换。

约束:

  • 不能与 Switchover 参数一起指定。

类型:布尔值

必需:否

Switchover

指定是否切换该全局数据库集群。

约束:

  • 不能与 AllowDataLoss 参数一起指定。

类型:布尔值

必需:否

响应元素

服务返回以下元素。

GlobalCluster

一种表示 Amazon DocumentDB 全球集群的数据类型。

类型:GlobalCluster 对象

错误

有关所有操作的常见错误的信息,请参阅常见错误

DBClusterNotFoundFault

DBClusterIdentifier 并不引用现有集群。

HTTP 状态代码:404

GlobalClusterNotFoundFault

GlobalClusterIdentifier 并不引用现有全局集群。

HTTP 状态代码:404

InvalidDBClusterStateFault

集群未处于有效状态。

HTTP 状态代码:400

InvalidGlobalClusterStateFault

当集群处于这种状态时,无法执行请求的操作。

HTTP 状态代码:400

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: