Updated on 2026-03-16 GMT+08:00

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:

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

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	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
proxy_id	Yes	String	Definition Proxy instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
session_consistence	Yes	String	Definition Whether session consistency is enabled. Constraints N/A Range true: Session consistency is enabled. false: Session consistency is disabled. Default Value N/A
consistence_mode	No	String	Definition Consistency level. Constraints N/A Range session: session consistency (Only this value can be used when session_consistence is true.) global: global consistency (This value can be used when session_consistence is false.) eventual: eventual consistency (This value can be used when session_consistence is false.) Default Value The parameter is left blank by default.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A

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