# 创建只读节点 - CreateGaussMySqlReadonlyNode
#### 功能介绍
创建只读节点。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                       | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | 别名                                                                                                                                                                                                                                                       | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbformysql:instance:addReadOnlyNodes | Write | instance \* | - g:EnterpriseProjectId   - g:ResourceTag/\<tag-key\>    | - gaussdb:instance:modify  - gaussdb:instance:addNodes   | -      |
     
  
 
#### URI
POST /v3/{project_id}/instances/{instance_id}/nodes/enlarge
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。                        |
| instance_id | 是    | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 通过调用[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)接口获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                            |
| X-Language   | 否    | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。   - zh-cn：中文。    **默认取值**： en-us。 |
   
表3请求Body参数 
| 参数                 | 是否必选 | 参数类型              | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| priorities         | 是    | Array of integers | **参数解释**： 指定创建的只读节点故障倒换优先级。 数字越小，优先级越大，即故障倒换时，主节点会优先倒换到优先级高的只读节点上，优先级相同的只读节点选为主节点的概率相同。最多支持9个只读节点设置故障倒换优先级，超过9个的只读节点优先级默认为-1，表示不会参与倒换。可通过修改节点的故障倒换优先级来进行调整。 **约束限制**： 不涉及。 **取值范围**： 1-16。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                       |
| is_auto_pay        | 否    | String            | **参数解释**： 是否自动从客户的账户中支付。 **约束限制**： 创建包年/包月实例时可指定，此字段不影响自动续订的支付方式。 **取值范围**： - true：自动支付。   - false：手动支付。    **默认取值**： true。 |
| charge_mode        | 否    | String            | **参数解释**： 计费模式。 **约束限制**： 仅当实例为包年/包月实例时生效。 **取值范围**： - prePaid：预付费，即包年/包月。   - postPaid：后付费，即按需付费。    **默认取值**： prePaid。    |
| availability_zones | 否    | Array of strings  | **参数解释**： 可用区。可指定可用区创建只读节点，不传该参数时默认为自动选择可用区。 **约束限制**： 该参数目前处于公测阶段，如需使用，请提交工单联系客服人员申请权限。 调用[查询数据库规格](https://support.huaweicloud.com/api-taurusdb/ShowGaussMySqlFlavors.html)获取，其中az_status中的key为availability_zone。 注：指定可用区创建只读节点，可能由于资源不足创建失败。 **取值范围**： 调用[查询数据库规格](https://support.huaweicloud.com/api-taurusdb/ShowGaussMySqlFlavors.html)获取，其中az_status中的key为availability_zone。 **默认取值**： 不涉及。                                                             |
   
#### 响应参数
**状态码：201**
表4响应Body参数 
| 参数          | 参数类型             | 描述                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| instance_id | String           | **参数解释**： 实例ID，此参数是实例的唯一标识。 **取值范围**： 不涉及。                                                              |
| node_names  | Array of strings | **参数解释**： 节点名称列表。                                                                                                                                                                                       |
| job_id      | String           | **参数解释**： 创建只读节点的任务ID。 仅创建按需只读节点时会返回该参数。 **取值范围**： 不涉及。 |
| order_id    | String           | **参数解释**： 订单号，创建包年包月只读节点时返回该参数。 **取值范围**： 不涉及。                                                          |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误消息。 |
   
**状态码：500**
表6响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误消息。 |
   
#### 请求示例
为实例创建只读节点。
```
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/8cb89e25e0444f1fa9b2145dff29cabdin07/nodes/enlarge
{
  "priorities" : [ 1, 2 ]
}
```
#### 响应示例
**状态码：201**
```
{
  "instance_id" : "8cb89e25e0444f1fa9b2145dff29cabdin07",
  "node_names" : [ "gauss-ccf5_node03", "gauss-ccf5_node04" ],
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  为实例创建只读节点。
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.BasicCredentials;
  import com.huaweicloud.sdk.core.exception.ConnectionException;
  import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
  import com.huaweicloud.sdk.core.exception.ServiceResponseException;
  import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
  import com.huaweicloud.sdk.gaussdb.v3.*;
  import com.huaweicloud.sdk.gaussdb.v3.model.*;
  import java.util.List;
  import java.util.ArrayList;
  public class CreateGaussMySqlReadonlyNodeSolution {
      public static void main(String[] args) {
          // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
          // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
          String ak = System.getenv("CLOUD_SDK_AK");
          String sk = System.getenv("CLOUD_SDK_SK");
          String projectId = "{project_id}";
          ICredential auth = new BasicCredentials()
                  .withProjectId(projectId)
                  .withAk(ak)
                  .withSk(sk);
          GaussDBClient client = GaussDBClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                  .build();
          CreateGaussMySqlReadonlyNodeRequest request = new CreateGaussMySqlReadonlyNodeRequest();
          request.withInstanceId("{instance_id}");
          MysqlCreateReadonlyNodeRequest body = new MysqlCreateReadonlyNodeRequest();
          List<Integer> listbodyPriorities = new ArrayList<>();
          listbodyPriorities.add(1);
          listbodyPriorities.add(2);
          body.withPriorities(listbodyPriorities);
          request.withBody(body);
          try {
              CreateGaussMySqlReadonlyNodeResponse response = client.createGaussMySqlReadonlyNode(request);
              System.out.println(response.toString());
          } catch (ConnectionException e) {
              e.printStackTrace();
          } catch (RequestTimeoutException e) {
              e.printStackTrace();
          } catch (ServiceResponseException e) {
              e.printStackTrace();
              System.out.println(e.getHttpStatusCode());
              System.out.println(e.getRequestId());
              System.out.println(e.getErrorCode());
              System.out.println(e.getErrorMsg());
          }
      }
  }
  ```
- [Python]
  为实例创建只读节点。
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import BasicCredentials
  from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdkgaussdb.v3 import *
  if __name__ == "__main__":
      # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak = os.environ["CLOUD_SDK_AK"]
      sk = os.environ["CLOUD_SDK_SK"]
      projectId = "{project_id}"
      credentials = BasicCredentials(ak, sk, projectId)
      client = GaussDBClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = CreateGaussMySqlReadonlyNodeRequest()
          request.instance_id = "{instance_id}"
          listPrioritiesbody = [
              1,
              2
          ]
          request.body = MysqlCreateReadonlyNodeRequest(
              priorities=listPrioritiesbody
          )
          response = client.create_gauss_my_sql_readonly_node(request)
          print(response)
      except exceptions.ClientRequestException as e:
          print(e.status_code)
          print(e.request_id)
          print(e.error_code)
          print(e.error_msg)
  ```
- [Go]
  为实例创建只读节点。
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
      gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
  )
  func main() {
      // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak := os.Getenv("CLOUD_SDK_AK")
      sk := os.Getenv("CLOUD_SDK_SK")
      projectId := "{project_id}"
      auth, err := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := gaussdb.GaussDBClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := gaussdb.NewGaussDBClient(hcClient)
      request := &model.CreateGaussMySqlReadonlyNodeRequest{}
  request.InstanceId = "{instance_id}"
  var listPrioritiesbody = []int32{
          int32(1),
      int32(2),
      }
  request.Body = &model.MysqlCreateReadonlyNodeRequest{
  Priorities: listPrioritiesbody,
  }
  response, err := client.CreateGaussMySqlReadonlyNode(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=CreateGaussMySqlReadonlyNode)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述            |
|:---|:---|
| 201 | Success.      |
| 400 | Client error. |
| 500 | Server error. |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。
