SwitchInstanceHA_云数据库 Tair(兼容 Redis®)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

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

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

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
kvstore:SwitchInstanceHA
Update
全部资源
*

请求参数

字段名称字段详情
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

示例值:r-bp1zxszhcgatnx****参考取值来源:
    ModifyInstanceSSL
    CreateInstance
    RestartInstance
    RestoreInstance
    DescribeInstances
NodeIdstring

数据分片节点 ID,您可以调用 DescribeRoleZoneInfo 获取 CustinsId 参数,多个数据分片节点 ID 之间使用英文逗号(,)分隔,如需指定所有节点请输入all展开详情

示例值:56****19,56****20参考取值来源:
    AddShardingNode
SwitchModeinteger<int32>

执行时间,取值:展开详情

示例值:0
SwitchTypestring

切换模式,取值:展开详情

示例值:AvailablePriority枚举值:AvailablePriorityReliabilityPriority

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:5D622714-AEDD-4609-9167-F5DDD3D1****

返回示例

变更历史

暂无变更历史

相关示例

执行主从切换(即切换节点角色),可应用于容灾演练、多可用区场景下的应用就近连接等需求
2021-12-03