启用一致性复制组中复制对的故障切换功能。当一致性复制组中某些复制对的主盘出现故障时，可以调用该接口恢复从盘的读写权限。
接口说明
-
一致性复制组功能支持的地域请参见云盘异步复制概述。
-
一致性复制组必须处于单次同步中（
manual_syncing）、同步中（syncing）、正常（normal）、停止中（stopping）、停止失败（stop_failed）、已停止（stopped）、故障切换中（failovering）、故障切换失败（failover_failed）或者故障切换完成（failovered）状态。 -
故障切换完成后，一致性复制组处于故障切换完成（
failovered）状态。 -
要进行故障切换，请确保生产站点到灾备站点之间已完成首次数据同步。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ebs:FailoverDiskReplicaGroup | update | *DiskReplicaGroup acs:ebs:{#regionId}:{#accountId}:diskreplicagroup/{#ReplicaGroupId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 一致性复制组中容灾站点所属的地域 ID。 | cn-shanghai |
| ReplicaGroupId | string | 是 | 一致性复制组 ID。 | group-myreplica**** |
| ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "C123F94F-4E38-19AE-942A-A8D6F44F****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | OperationDenied | The operation is not allowed. | 当前操作不允许执行。 |
| 403 | OperationDenied.InvalidStatus | The operation is not allowed in current status. | 当前状态下该操作不允许执行。 |
| 403 | OperationDenied.NoPairInGroup | The operation is not allowed because no pair in the group. | 当前操作不允许执行，因为指定的一致性组中没有复制对。 |
| 403 | OperationDenied.PairGroupStatusConflict | The operation is not allowed due to pair and group status are not consistent. | 当前操作不允许执行，因为复制对和一致性组的状态不一致。 |
| 403 | OperationDenied.PairGroupAZoneConflict | The operation is not allowed due to pair and group having different RegionId or ZoneId. | 当前操作不允许执行，因为复制对和一致性组所属的RegionId和ZoneId不一致。 |
| 403 | OperationDenied.PairInAnotherGroup | The operation is not allowed because pair is already in another group. | 当前操作不允许执行，因为复制对已被加入另一个一致性组中。 |
| 403 | OperationDenied.OperateNotAllowedForPrimary | Operation is not allowed on the primary site. | 当前操作在主端不被允许。 |
| 403 | OperationDenied.OperateNotAllowedForStandby | Operation is not allowed on the secondary site. | 当前操作在从端不被允许。 |
| 403 | Forbidden | User is not authorized to operate. | 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。 |
| 403 | Forbidden.Action | User is not authorized to operate this action. | 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。 |
| 404 | NoSuchResource | The specified resource does not exist. | 指定的资源不存在。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误。 |
| 504 | RequestTimeout | The request is timeout, please try again later. | 该请求超时，请稍后再重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-30 | OpenAPI 错误码发生变更 | 查看变更详情 |