Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Creating a Proxy Instance
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Creating a Proxy Instance

Function

This API is used to create a proxy instance in ELB mode. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/proxy

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

flavor_ref

Yes

String

Definition

Specification code of the proxy instance.

Constraints

N/A

Range

To obtain this value, see the spec_code field returned in Querying Proxy Instance Specifications.

Default Value

N/A

node_num

Yes

Integer

Definition

Number of proxy instance nodes.

Constraints

N/A

Range

2–16

Default Value

N/A

proxy_name

No

String

Definition

Proxy instance name.

Constraints

Instances of the same type can have the same name under the same tenant.

Range

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

Default Value

N/A

proxy_mode

No

String

Definition

Proxy instance type.

Constraints

N/A

Range

  • readwrite: read/write

  • readonly: read-only

Default Value

readwrite

route_mode

No

Integer

Definition

Routing policy of the proxy instance.

Constraints

N/A

Range

  • 0: weighted

  • 1: load balancing (The primary node does not process read requests.)

  • 2: load balancing (The primary node processes read requests.)

Default Value

0

nodes_read_weight

No

Array of NodesWeight objects

Definition

Read weights of database nodes.

Constraints

If proxy_mode is set to readonly, you can only assign weights for read replicas.

subnet_id

No

String

Definition

Subnet ID. You can obtain the value with either of the following methods:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the subnet ID on the displayed page.

  • Method 2: Query the subnet ID through the VPC API. For details, see Querying Subnets.

Constraints

N/A

Range

N/A

Default Value

N/A

new_node_auto_add_status

No

String

Definition

Whether new nodes are automatically associated with proxy instances.

Constraints

N/A

Range

  • ON: New nodes are automatically associated with proxy instances.

  • OFF: New nodes are not automatically associated with proxy instances.

Default Value

OFF

new_node_weight

No

Integer

Definition

Read weight of a new node.

Constraints

This parameter is mandatory when new_node_auto_add_status is set to ON.

Range

  • If route_mode is 0 and new_node_auto_add_status is ON, the value of this parameter is between 0 and 1000.

  • If route_mode is not 0 and new_node_auto_add_status is OFF, this parameter is unavailable.

Default Value

N/A
Table 4 NodesWeight

Parameter

Mandatory

Type

Description

id

No

String

Definition

Database node ID.

Constraints

The node ID must belong to the corresponding instance.

Range

The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed.

Default Value

N/A

weight

No

Integer

Definition

Node weight.

Constraints

N/A

Range

  • route_mode set to 0: The value range is 0 to 1000.

  • route_mode set to 1: The value for the primary node is 0 and the value for read replicas is 0 or 1.

  • route_mode set to 2: The value for the primary node is 1 and the value for read replicas is 0 or 1.

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Creating a proxy instance (The proxy instance specifications are 2 vCPUs and 8 GB memory, and the proxy mode is read-only)

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy
{
  "flavor_ref" : "gaussdb.proxy.large.x86.2",
  "node_num" : 2,
  "proxy_name" : "gaussdb-proxy",
  "proxy_mode" : "readonly",
  "route_mode" : 0,
  "nodes_read_weight" : [ {
    "id" : "45021bf73a244312a3f2af95092feeecno07",
    "weight" : 50
  }, {
    "id" : "d78a65690cea4af5ad14585e110ff89bno07",
    "weight" : 400
  } ],
  "subnet_id" : "6991d82d-9166-4aff-a1fa-d2a8748b7084"
}

Example Response

Status code: 201

Success.

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy