
# 备机顶替只读节点（SQL Server） - NotifyReplaceNode
#### 功能介绍
备机顶替只读节点。
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=NotifyReplaceNode)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                 | 访问级别  | 资源类型（\*为必须） | 条件键                                                                              | 别名                  | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:update | write | instance    | - g:EnterpriseProjectId - g:ResourceTag/\<tag-key\> | rds:instance:modify | -      |
   
#### 接口约束
- 只读实例发生故障，通过节点顶替，暂时将只读实例的数据vip漂到对应主实例的备机节点上提供服务。待修复只读实例后，通过"节点顶替回切"进行手动回切。
- 仅是将只读实例的数据vip漂到对应主实例的备机上，并且因为备机和只读节点的规格、参数设置、复制时延等的差异，备机顶替期间用户使用时会存在性能差异、数据跳变等情况，以及备机顶替期间，主备倒换、规格变更、端口修改等操作会受到限制。在节点顶替/顶替回切中，因为涉及到vip的切换，会有一段时间的业务中断。仅支持RDS for SQL Server实例。
- 如需使用备机替换只读节点功能，请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请。
 
#### URI
- URI格式 POST /v3/{project_id}/instances/{instance_id}/replace-node
  

- 参数说明
  表1参数说明 
  | 名称          | 是否必选 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | project_id  | 是    | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
  | instance_id | 是    | **参数解释：** 只读实例ID。 **约束限制：** 不涉及。 **取值范围：** 该参数值可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表9](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table1179987152611)中的"id"获取。 **默认取值：** 不涉及。            |
     
  
 
#### 请求消息
表2参数说明 
| 名称             | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| instance_id    | 是    | String | **参数解释：** 只读实例ID。 **约束限制：** 不涉及。 **取值范围：** 可从[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)获取只读实例ID。 **默认取值：** 不涉及。                                                                                                                                                                                         |
| node_id        | 是    | String | **参数解释：** 只读实例的节点ID。 **约束限制：** 不涉及。 **取值范围：** 可从[表9](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table1179987152611)获取只读实例的节点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"
  }
  ```
  
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。
