全部产品
Search

搜索本产品

    ：SwitchInstanceHA - 切换实例HA

    文档中心

    ：SwitchInstanceHA - 切换实例HA

    更新时间：Dec 09, 2024

    执行主从切换（即切换节点角色），可应用于容灾演练、多可用区场景下的应用就近连接等需求。

    接口说明

    说明 关于多可用区场景下的应用就近连接的详细说明，请参见场景示例。

    调用本接口时，实例类型为高可用或双副本。

    调用本接口将产生下述影响：

    • 触发节点角色切换后，执行切换的数据节点将出现秒级的只读状态和连接闪断，请确保您的应用具备重连机制。
    • 实例处于切换中状态时，您将无法执行实例级别的操作（例如变更配置、迁移可用区等）。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    kvstore:SwitchInstanceHAupdate
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    实例 ID，可调用 DescribeInstances 获取。

    		r-bp1zxszhcgatnx****
    NodeIdstring否

    数据分片节点 ID，您可以调用 DescribeRoleZoneInfo 获取 CustinsId 参数，多个数据分片节点 ID 之间使用英文逗号（,）分隔，如需指定所有节点请输入all。

    说明 当实例为集群或读写分离架构时，本参数才可用，且必填。
    		56****19,56****20
    SwitchModeinteger否

    执行时间，取值：

    • 0：立即执行，默认值。
    • 1：在可维护时间段执行。
    说明 您可以调用 ModifyInstanceMaintainTime 修改实例的可维护时间段。
    		0
    SwitchTypestring是

    切换模式，取值：

    • AvailablePriority：可用性优先，不考虑主从延迟，立即执行主从切换，可能会丢失少量数据。
    • ReliabilityPriority：可靠性优先，确保主从同步无延迟时才执行主从切换，不会丢失数据。该模式在写入量较大且持续存在同步延迟的场景下，可能会造成主从切换失败。
    说明 您需要根据业务场景对数据、服务等方面的需求进行衡量，然后选取切换模式。
    		AvailablePriority

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		5D622714-AEDD-4609-9167-F5DDD3D1****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-07-20OpenAPI 描述信息更新查看变更详情