Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Database Proxy/ Enabling or Disabling Transaction Splitting of a Proxy Instance
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Enabling or Disabling Transaction Splitting of a Proxy Instance

Function

This API is used to enable or disable transaction splitting of a proxy instance. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/transaction-split

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.

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 parameters

Parameter

Mandatory

Type

Description

transaction_split

Yes

String

Whether transaction splitting is enabled.

Values:

  • ON: Transaction splitting is enabled.
  • OFF: Transaction splitting is disabled.

proxy_id_list

Yes

Array of strings

Proxy instances under a DB instance.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Workflow 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

Disabling transaction splitting of a proxy instance

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/6b030d160ac24eda9a5320fb38dc2d0ain07/proxy/transaction-split
{
  "transaction_split" : "OFF",
  "proxy_id_list" : [ "2a2060f2486e4a47934182d91a3b53d2po01" ]
}

Example Response

Status code: 200

success

{
  "job_id" : "11921bf5-f286-45ee-ab35-12a3d4084c57"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy