更新时间:2025-07-29 GMT+08:00

设置读写分离路由模式

功能介绍

设置读写分离路由模式。

接口约束

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

proxy_id

String

参数解释

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

约束限制

不涉及。

取值范围

实例关联的数据库代理ID。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表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。

约束限制

不涉及。

取值范围

  • ON:开启。

  • OFF:关闭。

默认取值

OFF。

new_node_weight

Integer

参数解释

新增节点的读权重。

约束限制

取值范围与路由模式和新增节点是否自动加入有关。

取值范围

  • 如果路由模式为0,新增节点自动加入为ON,取值为0~1000。

  • 如果路由模式不为0或新增节点自动加入为OFF,则可不输入读权重。

默认取值

不涉及。

表4 ModifyProxyRouteModeWeightReadonlyNode

参数

是否必选

参数类型

描述

id

String

参数解释

只读节点ID。

约束限制

不涉及。

取值范围

实例的只读节点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"
}

状态码

请参见状态码

错误码

请参见错误码