Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Session Management/ Manually Terminating Transactions
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Manually Terminating Transactions

Function

This API is used to manually terminate transactions. Before calling this API:

Constraints

This API is only available for nodes with CNs or DNs (primary or standby DNs) deployed.

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/instances/{instance_id}/transactions/kill

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 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 can contain 36 characters. 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.

You can obtain the token by calling the IAM API used to obtain a user token.

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

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

node_id

Yes

String

Definition

Node ID. Only CNs or DNs of the non-log type are supported.

Constraints

N/A

Range

N/A

Default Value

N/A

component_id

Yes

String

Definition

Component ID. Only CNs or DNs of the non-log type are supported.

Constraints

N/A

Range

N/A

Default Value

N/A

session_ids

Yes

List<String>

Definition

IDs of transactions to be terminated.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 4 Response body parameters

Parameter

Type

Description

sessionIds

List<String>

Definition

IDs of transactions terminated.

Range

N/A

success

Boolean

Definition

Whether the transaction termination operation is successful.

Range

  • true: successful
  • false: failed

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/transactions/kill
{ 
   "node_id" : "42cbf784585e419d9eb33c005f4ced94no14", 
   "component_id" : "dn_6001", 
   "session_ids" : [ 25347 ]
}

Example Response

Transactions manually terminated.

{
    "sessionIds" : [ "25347" ],
    "success" : true
 }

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Session Management