Assigning Read Weights¶

Function¶

This API is used to assign read weights for nodes. Being using this API:

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

URI¶

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/weight

**Table 1** URI parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region.
instance_id	Yes	String	DB instance ID, which is compliant with the UUID format.
proxy_id	Yes	String	Database proxy 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.
X-Language	No	String	Language.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
master_weight	No	Integer	Weight of the primary node.
readonly_nodes	No	Array of TaurusModifyProxyWeightReadonlyNode objects	Weight information of the read replicas.

**Table 4** TaurusModifyProxyWeightReadonlyNode¶
Parameter	Mandatory	Type	Description
id	No	String	Read replica ID.
weight	No	Integer	Weight of the read replica.

Response Parameters¶

Status code: 200

**Table 5** Response body parameters¶
Parameter	Type	Description
job_id	String	Task ID.

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¶

PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight
{
  "master_weight" : 100
}

Example Response¶

Status code: 200

Success.

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

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-05-20 01:10