Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Session Management/ Querying the Automatic Transaction Termination Configuration

Updated on 2025-10-20 GMT+08:00

View PDF

Querying the Automatic Transaction Termination Configuration

Function

This API is used to obtain the automatic transaction termination configuration of an instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/transactions/get-auto-kill-config

**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** Query parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Type of transactions configured for automatic termination. Constraints Only lowercase letters are allowed. Range exec_time: long transaction. xlog_quantity: large transaction. Default Value N/A

Response Parameters

**Table 4** Response body parameters
Parameter	Type	Description
type	String	Definition Type of transactions configured for automatic termination. Range N/A
usernames	List<String>	Definition Usernames used as filter criteria. Range N/A
threshold	Long	Definition Threshold. Range N/A
auto_stop	Boolean	Definition Whether to enable the function. Range N/A
database_names	List<String>	Definition All databases contained in the current instance. Range N/A
database_names_select	List<String>	Definition Database names used as filter criteria. Range N/A

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/transactions/get-auto-kill-config?type=exec_time

Example Response

Obtained the automatic transaction termination configuration of an instance.

{
   "type" : "exec_time", 
   "usernames" : [ "root" ], 
   "threshold" : 86400, 
   "auto_stop" : false, 
   "database_names" : [ "postgres" ], 
   "database_names_select" : [ "postgres" ]
 }