文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 数据库代理> 设置读写分离路由模式

更新时间：2024-02-07 GMT+08:00

在线调试

CLI示例

查看PDF

设置读写分离路由模式

功能介绍

设置读写分离路由模式。

接口约束

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

调用方法

请参见如何调用API。

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 ModifyProxyRouteWeightReadonlyNode objects	只读节点权重配置信息。
new_node_auto_add_status	否	String	是否开启新增节点自动加入该Proxy。如果需要设置是否开启新增节点自动加入该Proxy，请联系客服人员添加白名单，加入白名单后，方可输入该字段。取值范围： ON：开启。 OFF：关闭。
new_node_weight	否	Integer	新增节点的读权重：如果路由模式为0，新增节点自动加入为ON，取值为0~1000。如果路由模式不为0或新增节点自动加入为OFF，则可不输入读权重。

表4 ModifyProxyRouteWeightReadonlyNode
参数	是否必选	参数类型	描述
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	错误消息。

请求示例

修改路由模式为权重负载模式。

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode

{
  "route_mode" : 0,
  "master_weight" : 100,
  "readonly_nodes" : {
    "id" : "d23535333138462880bfa1838fdfced2no07",
    "weight" : 200
  }
}

修改路由模式为负载均衡模式（数据库主节点不接受读请求）。

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode

{
  "route_mode" : 1,
  "master_weight" : 0,
  "readonly_nodes" : {
    "id" : "d23535333138462880bfa1838fdfced2no07",
    "weight" : 1
  }
}

修改路由模式为负载均衡模式（数据库主节点接受读请求）。

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"
}

SDK代码示例

SDK代码示例如下。

修改路由模式为权重负载模式。

        
         
           
           
             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 ModifyGaussMySqlProxyRouteModeSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ModifyGaussMySqlProxyRouteModeRequest request = new ModifyGaussMySqlProxyRouteModeRequest();
        ModifyGaussMySqlProxyRouteModeRequestBody body = new ModifyGaussMySqlProxyRouteModeRequestBody();
        body.withMasterWeight(100);
        body.withRouteMode(0);
        request.withBody(body);
        try {
            ModifyGaussMySqlProxyRouteModeResponse response = client.modifyGaussMySqlProxyRouteMode(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());
        }
    }
}

            

          

        
       

修改路由模式为负载均衡模式（数据库主节点不接受读请求）。

        
         
           
           
             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 ModifyGaussMySqlProxyRouteModeSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ModifyGaussMySqlProxyRouteModeRequest request = new ModifyGaussMySqlProxyRouteModeRequest();
        ModifyGaussMySqlProxyRouteModeRequestBody body = new ModifyGaussMySqlProxyRouteModeRequestBody();
        body.withMasterWeight(0);
        body.withRouteMode(1);
        request.withBody(body);
        try {
            ModifyGaussMySqlProxyRouteModeResponse response = client.modifyGaussMySqlProxyRouteMode(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());
        }
    }
}

            

          

        
       

修改路由模式为负载均衡模式（数据库主节点接受读请求）。

        
         
           
           
             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 ModifyGaussMySqlProxyRouteModeSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ModifyGaussMySqlProxyRouteModeRequest request = new ModifyGaussMySqlProxyRouteModeRequest();
        ModifyGaussMySqlProxyRouteModeRequestBody body = new ModifyGaussMySqlProxyRouteModeRequestBody();
        body.withMasterWeight(1);
        body.withRouteMode(2);
        request.withBody(body);
        try {
            ModifyGaussMySqlProxyRouteModeResponse response = client.modifyGaussMySqlProxyRouteMode(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());
        }
    }
}

            

          

        
       

修改路由模式为权重负载模式。

        
         
           
           
             # coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ModifyGaussMySqlProxyRouteModeRequest()
        request.body = ModifyGaussMySqlProxyRouteModeRequestBody(
            master_weight=100,
            route_mode=0
        )
        response = client.modify_gauss_my_sql_proxy_route_mode(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

修改路由模式为负载均衡模式（数据库主节点不接受读请求）。

        
         
           
           
             # coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ModifyGaussMySqlProxyRouteModeRequest()
        request.body = ModifyGaussMySqlProxyRouteModeRequestBody(
            master_weight=0,
            route_mode=1
        )
        response = client.modify_gauss_my_sql_proxy_route_mode(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

修改路由模式为负载均衡模式（数据库主节点接受读请求）。

        
         
           
           
             # coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ModifyGaussMySqlProxyRouteModeRequest()
        request.body = ModifyGaussMySqlProxyRouteModeRequestBody(
            master_weight=1,
            route_mode=2
        )
        response = client.modify_gauss_my_sql_proxy_route_mode(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

修改路由模式为权重负载模式。

        
         
           
           
             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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ModifyGaussMySqlProxyRouteModeRequest{}
	masterWeightModifyGaussMySqlProxyRouteModeRequestBody:= int32(100)
	request.Body = &model.ModifyGaussMySqlProxyRouteModeRequestBody{
		MasterWeight: &masterWeightModifyGaussMySqlProxyRouteModeRequestBody,
		RouteMode: int32(0),
	}
	response, err := client.ModifyGaussMySqlProxyRouteMode(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

修改路由模式为负载均衡模式（数据库主节点不接受读请求）。

        
         
           
           
             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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ModifyGaussMySqlProxyRouteModeRequest{}
	masterWeightModifyGaussMySqlProxyRouteModeRequestBody:= int32(0)
	request.Body = &model.ModifyGaussMySqlProxyRouteModeRequestBody{
		MasterWeight: &masterWeightModifyGaussMySqlProxyRouteModeRequestBody,
		RouteMode: int32(1),
	}
	response, err := client.ModifyGaussMySqlProxyRouteMode(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

修改路由模式为负载均衡模式（数据库主节点接受读请求）。

        
         
           
           
             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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ModifyGaussMySqlProxyRouteModeRequest{}
	masterWeightModifyGaussMySqlProxyRouteModeRequestBody:= int32(1)
	request.Body = &model.ModifyGaussMySqlProxyRouteModeRequestBody{
		MasterWeight: &masterWeightModifyGaussMySqlProxyRouteModeRequestBody,
		RouteMode: int32(2),
	}
	response, err := client.ModifyGaussMySqlProxyRouteMode(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	Success.
400	Client error.
500	Server error.

错误码

请参见错误码。

父主题：数据库代理

上一篇：设置读写分离权重

下一篇：设置数据库代理事务拆分

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

设置读写分离路由模式

功能介绍

接口约束

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线