Updated on 2024-06-07 GMT+08:00

Configuring the Routing Policy for a Database Proxy

Function

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

  • Before calling an API, you need to understand the API in Authentication.

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

    Project ID of a tenant in a region.

    To obtain it, refer to Obtaining a Project ID.

    instance_id

    Yes

    Instance ID.

    proxy_id

    Yes

    Database proxy ID.

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

master_weight

Yes

Integer

Read weight of the primary instance.

  • 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.

readonly_instances

Yes

Array of objects

Read weights of database nodes. For details, see Table 3.

  • You can only configure weights for read replicas.
  • This parameter can be left blank.

route_mode

Yes

Integer

Routing policy of the database proxy. Valid values:

  • 0: weighted
  • 1: load balancing (The primary instance does not process read requests.)
  • 2: load balancing (The primary instance processes read requests.)

To use load balancing, contact customer service to apply for required permissions.

Table 3 readonly_instances field data structure description

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

weight

Yes

Integer

Read weight assigned.

Example Request

Configure the routing policy for a database proxy.

POST https://rds.ap-southeast-1.myhuaweicloud.com/v3/23a50154cf494ec9ad6883979a12db0a/instances/ba0fd7c13cca4655820e0f858d5d467bin01/proxy/4e2a0c70f70f4807940db73a30b5b522po01/route-mode

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

Response

  • Normal response
    Table 4 Parameters

    Parameter

    Type

    Description

    result

    String

    Result of changing the routing policy of the database proxy. Valid values:

    • failed
    • success

Status Code

Error Code

For details, see Error Codes.