文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ 数据库代理/ 设置读写分离路由模式
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置读写分离路由模式

功能介绍

设置读写分离路由模式。

接口约束

该接口目前公测阶段，如需使用，请提交工单联系客服人员申请权限。

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/route-mode

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

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

proxy_id

是

String

数据库代理ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

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

参数

是否必选

参数类型

描述

route_mode

是

Integer

数据库代理路由模式。

取值范围:

  • 0：表示权重负载模式。
  • 1：表示负载均衡模式（数据库主节点不接受读请求）。
  • 2：表示负载均衡模式（数据库主节点接受读请求）。

master_weight

否

Integer

主节点权重。

  • 如果路由模式为0，取值为0~1000。
  • 如果路由模式为1，取值为0。
  • 如果路由模式为2，取值为1。

readonly_nodes

否

Array of ModifyProxyRouteModeWeightReadonlyNode objects

只读节点权重配置信息。

new_node_auto_add_status

否

String

是否开启新增节点自动加入该Proxy。如果需要设置是否开启新增节点自动加入该Proxy，请联系客服人员添加白名单，加入白名单后，方可输入该字段。

取值范围：

  • ON：开启。
  • OFF：关闭。

new_node_weight

否

Integer

新增节点的读权重：

  • 如果路由模式为0，新增节点自动加入为ON，取值为0~1000。
  • 如果路由模式不为0或新增节点自动加入为OFF，则可不输入读权重。
表4 ModifyProxyRouteModeWeightReadonlyNode

参数

是否必选

参数类型

描述

id

是

String

只读节点ID。

weight

是

Integer

只读节点权重。

  • 如果路由模式为0，取值为0~1000。
  • 如果路由模式为1或2，取值为0或1。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 设置读写分离路由模式为0。 
    PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode
{
  "route_mode" : 0,
  "master_weight" : 100,
  "readonly_nodes" : {
    "id" : "d23535333138462880bfa1838fdfced2no07",
    "weight" : 200
  }
}
  • 设置读写分离路由模式为1。 
    PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode
{
  "route_mode" : 1,
  "master_weight" : 0,
  "readonly_nodes" : {
    "id" : "d23535333138462880bfa1838fdfced2no07",
    "weight" : 1
  }
}
  • 设置读写分离路由模式为2。 
    PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode
{
  "route_mode" : 2,
  "master_weight" : 1,
  "readonly_nodes" : {
    "id" : "d23535333138462880bfa1838fdfced2no07",
    "weight" : 0
  }
}

响应示例

状态码： 200

Success.

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87c11411890"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理