文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 实例管理/ 创建只读节点
更新时间：2024-05-31 GMT+08:00
查看PDF
分享

创建只读节点

功能介绍

创建只读节点。

该接口计划于2025-03-31下线，建议及时切换到新接口创建只读节点。

调试

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

URI

POST /mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

Content-Type

是

String

内容类型。 取值：application/json。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

priorities

是

Array of integers

指定创建的只读节点故障倒换优先级。倒换优先级列表个数即为只读节点格式。 故障倒换优先级的取值范围为1~16，数字越小，优先级越大，即故障倒换时，主节点会优先倒换到优先级高的备节点上，优先级相同的备节点选为主节点的概率相同。

is_auto_pay

否

String

创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。

  • true，为自动支付，默认该方式。
  • false，为手动支付。

枚举值：

  • true
  • false

响应参数

状态码： 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}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge

{
  "priorities" : [ 1, 2 ]
}

响应示例

状态码： 201

Success.

{
  "instance_id" : "f381d0b539e644df8f5b0d3a62129515in07",
  "node_names" : [ 
       "gauss-ccf5_node03", 
       "gauss-ccf5_node04"
   ],
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

状态码

状态码

描述

201

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 实例管理

相关文档