Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Database Proxy/ Enabling or Disabling Automatic Association of New Nodes with Proxy Instances

Updated on 2024-09-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Enabling or Disabling Automatic Association of New Nodes with Proxy Instances

Function

This API is used to enable or disable automatic association of new nodes with proxy instances. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

Constraints

This API is in the open beta test (OBT) phase. To use this API, submit a service ticket.

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/new-node-auto-add

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.
proxy_id	Yes	String	Proxy instance ID, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
switch_status	Yes	String	Whether new nodes are automatically associated with proxy instances. Values: ON: New nodes are automatically associated with proxy instances. OFF: New nodes are not automatically associated with proxy instances.
weight	No	Integer	Read weight of the new node. If switch_status is ON, the value ranges from 0 to 1000. If switch_status is OFF, this parameter is unavailable.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	String	Result of enabling or disabling association of new nodes with proxy instances.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Automatically associating new nodes with proxy instances

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/new-node-auto-add

{
  "switch_status" : "ON",
  "weight" : 100
}