Configuring the Routing Policy for a Database Proxy

Function

This API is used to configure the routing policy for a database proxy.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

URI

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

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A
proxy_id	Yes	Definition Database proxy ID. Constraints N/A Range You can obtain the value of this parameter from pool_id in Table 4 by calling the API for querying database proxies. Default Value N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
master_weight	Yes	Integer	Definition Read weight of the primary instance. Constraints N/A Range When route_mode is set to 0, the value of this parameter ranges from 0 to 1000. When route_mode is set to a value other than 0, this parameter does not take effect. Default Value N/A
readonly_instances	Yes	Array of objects	Definition Read weights of database nodes. For details, see Table 3. Constraints You can only configure weights for read replicas. This parameter can be left blank.
route_mode	Yes	Integer	Definition Routing policy of the database proxy. Constraints N/A Range 0: weighted 1: load balancing (The primary instance does not process read requests.) 2: load balancing (The primary instance processes read requests.) Default Value N/A

**Table 3** readonly_instances field data structure description
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
weight	Yes	Integer	Definition Read weight assigned. Constraints N/A Range N/A Default Value N/A

Example Request

Configure the routing policy for a database proxy.

POST https://{Endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/ba0fd7c13cca4655820e0f858d5d467bin01/proxy/4e2a0c70f70f4807940db73a30b5b522po01/route-mode

{ 
   "master_weight" : 0, 
   "readonly_instances" : [ { 
     "instance_id" : "2edc88e921bb4129bb4d9b76be66811dno07", 
     "weight" : 1 
   } ], 
   "route_mode" : 2 
 }