文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 数据库代理（MySQL）/ 设置读写分离路由模式
更新时间：2024-08-09 GMT+08:00
查看PDF
分享

设置读写分离路由模式

功能介绍

设置读写分离路由模式。

调试

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

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一Region下的项目ID。

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

    instance_id

    是

    实例ID。

    proxy_id

    是

    数据库代理ID。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

master_weight

是

Integer

数据库主实例读权重。

  • 当route_mode选择0（权重负载）时，该字段取值范围为0~1000。
  • 当route_mode取值非0（权重负载）时，该字段不生效。

readonly_instances

是

Array of objects

数据库节点的读权重设置。请参见表3。

  • 只能为只读实例选择权重。
  • 该列表可以为空列表。

route_mode

是

Integer

数据库代理路由模式。取值范围：

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

如需使用负载均衡模式，请联系客服申请
表3 readonly_instances字段数据结构说明

参数

是否必选

参数类型

描述

instance_id

是

String

数据库实例ID。

weight

是

Integer

数据库代理读权重。

请求示例

设置读写分离路由模式。

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/ba0fd7c13cca4655820e0f858d5d467bin01/proxy/4e2a0c70f70f4807940db73a30b5b522po01/route-mode
{ 
   "master_weight" : 0, 
   "readonly_instances" : [ { 
     "instance_id" : "2edc88e921bb4129bb4d9b76be66811dno07", 
     "weight" : 1 
   } ], 
   "route_mode" : 2 
 }

响应消息

  • 正常响应要素说明
    表4 要素说明

    名称

    参数类型

    说明

    result

    String

    修改数据库代理路由模式结果。取值：

    • failed，失败
    • success，成功

状态码

错误码

请参见错误码。

相关文档