Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Database Proxy/ Changing the Connection Pool Type of a Proxy Instance
Updated on 2023-10-23 GMT+08:00
View PDF

Changing the Connection Pool Type of a Proxy Instance

Function

This API is used to change the connection pool type of a proxy instance. Before calling this API:

Constraints

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

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/connection-pool-type

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.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

connection_pool_type

Yes

String

Connection pool type.

Value:

  • CLOSED: The connection pool is closed.
  • SESSION: The session-level connection pool is enabled.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

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

Enabling the session connection pool for a proxy instance

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/5881e1ca66af4aefbc64dc2874e55b3fpo01/connection-pool-type
{ 
  "connection_pool_type" : "SESSION" 
}

Example Response

Status code: 200

Success.

{ 
  "job_id" : "a4217ac4-12cd-4fb3-acfc-db4a4a1896ea" 
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy