文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 实例管理/ 备机顶替只读节点(SQL Server)
更新时间:2025-10-28 GMT+08:00
分享

备机顶替只读节点(SQL Server)

功能介绍

备机顶替只读节点。

调试

您可以在API Explorer中调试该接口。

接口约束

  • 只读实例发生故障,通过节点顶替,暂时将只读实例的数据vip漂到对应主实例的备机节点上提供服务。待修复只读实例后,通过“节点顶替回切”进行手动回切。
  • 仅是将只读实例的数据vip漂到对应主实例的备机上,并且因为备机和只读节点的规格、参数设置、复制时延等的差异,备机顶替期间用户使用时会存在性能差异、数据跳变等情况,以及备机顶替期间,主备倒换、规格变更、端口修改等操作会受到限制。在节点顶替/顶替回切中,因为涉及到vip的切换,会有一段时间的业务中断。仅支持RDS for SQL Server实例。
  • 如需使用备机替换只读节点功能,请提交工单申请。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/replace-node

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    参数解释:

    只读实例ID。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

instance_id

String

参数解释:

只读实例ID。

约束限制:

不涉及。

取值范围:

可从表4获取只读实例ID。

默认取值:

不涉及。

node_id

String

参数解释:

只读实例的节点ID。

约束限制:

不涉及。

取值范围:

可从表9获取只读实例的节点ID。

默认取值:

不涉及。

replace_action

String

参数解释:

替换动作。

约束限制:

不涉及。

取值范围:

  • REPLACE:节点顶替。
  • REPLACE_ROLLBACK:节点顶替回切。

默认取值:

不涉及。

请求示例

  • 备机顶替只读节点。
    POST https://{Endpoint}/v3/5a7a69c429aa41b8a565c9a4995afea0/instances/02a202cf9fdd4561b80036337c9732f8in04/replace-node
    
    { 
       "instance_id" : "02a202cf9fdd4561b80036337c9732f8in04", 
       "node_id" : "bfafde30219f4ac5a820c7748e4dc106no04", 
       "replace_action" : "REPLACE" 
     }
  • 节点顶替回切。
    { 
       "instance_id" : "02a202cf9fdd4561b80036337c9732f8in04", 
       "node_id" : "bfafde30219f4ac5a820c7748e4dc106no04", 
       "replace_action" : "REPLACE_ROLLBACK" 
     }

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    job_id

    String

    参数解释:

    任务流ID。

    取值范围:

    不涉及。

  • 正常响应样例
    {
      "job_id": "5a7a69c429aa41b8a565c9a4995afea0"
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档