Enabling Database Proxy¶
Function¶
This API is used to enable database proxy in ELB mode. Before using this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
POST /v3/{project_id}/instances/{instance_id}/proxy
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 | DB instance ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
X-Language | No | String | Language. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
flavor_ref | Yes | String | Proxy specification code. |
node_num | Yes | Integer | Number of proxy instance nodes. The value is an integer from 2 to 32. |
proxy_name | No | String | Proxy instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). |
proxy_mode | No | String | Proxy instance type. The default type is readwrite. Valid value:
|
nodes_read_weight | No | Array of NodesWeight objects | Read weight of the node. If proxy_mode is set to readonly, you can assign weights only for read replicas. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
id | No | String | Node ID. |
weight | No | Integer | Weight assigned to the node. Value: 0 to 1000. |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
job_id | String | Task ID. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Request¶
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy
{
"flavor_ref" : "gaussdb.mysql.large.x86.4",
"node_num" : 2,
"proxy_name" : "gaussdb-proxy",
"proxy_mode" : "readonly",
"nodes_read_weight" : [ {
"id" : "45021bf73a244312a3f2af95092feeecno07",
"weight" : 50
}, {
"id" : "d78a65690cea4af5ad14585e110ff89bno07",
"weight" : 400
} ]
}
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.