# 单机转主备实例 - StartInstanceSingleToHaAction
#### 功能介绍
单机实例转主备实例。
- 调用接口前，您需要了解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://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=StartInstanceSingleToHaAction)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                       | 访问级别  | 资源类型（\*为必须） | 条件键                                                                         | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:singleToHa | write | instance   | g:EnterpriseProjectId g:ResourceTag/\<tag-key\> | -    | -      |
   
#### 接口约束
- 有些实例规格不支持升级为主备实例，具体请以实际环境为准。
- 暂不支持SQL Server DeC用户包周期单机转为主备实例。
 
#### URI
- URI格式 POST /v3/{project_id}/instances/{instance_id}/action
  
- 参数说明
  表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)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
表2参数说明 
| 名称            | 是否必选 | 参数类型                      | 说明                                                                                                                                                         |
|:---|:---|:---|:---|
| single_to_ha | 是    | Object | **参数解释：** 详情请参见[表3]。 **约束限制**： 不涉及。 |
   
 表3single_to_ha字段数据结构说明 
| 名称             | 是否必选 | 参数类型     | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| az_code_new_node | 是    | String  | **参数解释：** 实例节点可用区码（AZ）。 **约束限制**： 不涉及。 **取值范围**： 该参数值可调用[查询数据库规格](https://support.huaweicloud.com/api-rds/rds_06_0002.html)接口，通过响应样例中"az_status"字段的key获取。 示例： ``` "az_status": { "az1": "normal", "az2": "normal" } ``` **默认取值**： 不涉及。                                                             |
| dsspool_id        | 否       | String      | **参数解释：** Dec用户专属存储ID，每个az配置的专属存储不同，实例节点所在专属存储ID，仅支持DEC用户创建时使用。 可调用[查询数据库磁盘类型](https://support.huaweicloud.com/api-rds/rds_04_0002.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_04_0002.html#rds_04_0002__table1513533533518)中的"dsspool_id"获取。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 |
| is_auto_pay      | 否     | Boolean | **参数解释：** 仅包周期实例进行单机转主备时可指定，表示是否自动从客户的账户中支付。 **约束限制**： 不涉及。 **取值范围**： - true，为自动支付。  - false，为手动支付，默认该方式。   **默认取值**： false                                                                        |
| ad_domain_info     | 否      | Object    | **参数解释：** 域信息，详细字段结构请参见[表4]。 **约束限制**： 仅RDS for SQL Server支持该字段，加域实例单机转主备时必填，非加域实例不需要填写。                                                                                                                                                                                                                                                                                                                      |
   
 表4ad_domain_info字段数据结构说明 
| 参数                          | 是否必选 | 参数类型  | 描述                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| domain_admin_account_name | 是   | String | **参数解释：** 域管理员账号名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。       |
| domain_admin_pwd         | 是     | String | **参数解释：** 域管理员密码。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 |
   
#### 请求示例
- 变更MySQL、PostgreSQL按需单机实例为主备实例。
  ```
  POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
  {
  "single_to_ha": {
  "az_code_new_node": "az2xahz"
  }
  }
  ```
  

- 变更MySQL、PostgreSQL包周期单机实例为主备实例。
  ```
  {
           "single_to_ha": {
                     "az_code_new_node": "az1xahz",
                     "is_auto_pay": true
           }
  }
  ```
  

- 变更SQL Server按需单机实例为主备实例。
  ```
  {
      "single_to_ha": {
          "az_code_new_node": "az2xahz"
   }
  }
  ```
  

- 变更SQL Server包周期单机实例为主备实例。
  ```
  {
      "single_to_ha": {
          "az_code_new_node": "az2xahz",
          "is_auto_pay": true
      }
  }
  ```
  

- 变更DeC用户单机实例为主备实例。
  ```
  {
  "single_to_ha": {
  "az_code_new_node": "az2xahz",
  "password": "Test@1234567",
                  "dsspool_id":"23728728428374823748327482r"
  }
  }
  ```
  
 
#### 响应消息
- **按需实例**
  - 正常响应要素说明
    表5要素说明 
    | 名称       | 参数类型  | 说明                                                                                                                    |
    |:---|:---|:---|
    | job_id | String | **参数解释：** 任务ID。 **取值范围**： 不涉及。 |
       
    
  
  
  
  - 正常响应样例
    ```
    {
    "job_id": "2b414788a6004883a02390e2eb0ea227"
    }
    ```
    
  
  - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
    
    
   
 
- **包周期实例**
  - 正常响应要素说明
    表6要素说明 
    | 名称        | 参数类型 | 说明                                                                                                                    |
    |:---|:---|:---|
    | order_id | String  | **参数解释：** 订单ID。 **取值范围**： 不涉及。 |
       
    
  
  
  
  - 正常响应样例
    ```
    {
    "order_id": "CS2009151216NO2U2"
    }
    ```
    
  
  - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
    
   
#### 状态码
- 正常 202
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。