Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Database Proxy/ Changing Session Consistency of a Proxy Instance
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Changing Session Consistency of a Proxy Instance

Function

This API is used to change the session consistency of a proxy instance. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/session-consistence

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 parameter

Parameter

Mandatory

Type

Description

session_consistence

Yes

String

Whether session consistency is enabled.

Values:

  • true: Session consistency is enabled.
  • false: Session consistency is disabled.

consistence_mode

No

String

Consistency mode. The default value is empty. In this case, the value of session_consistence is used.

Values:

  • session: session consistency
  • global: global consistency
  • eventual: eventual consistency

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 session consistency for a proxy instance

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/d512257ecca04d96a0f3a9021018a385in07/proxy/7bf4a8bbb4f4fb58233a242ee13603bpo01/session-consistence
{
  "session_consistence" : "true"
}

Example Response

Status code: 200

Success

{
  "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
 
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy