Querying and Killing Idle Sessions

Function

This API is used to query and kill idle sessions. Before calling this API:

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

Constraints

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

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/instances/{instance_id}/kill-free-session

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	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	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 body parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Definition Node ID. Constraints This API is suitable only for nodes with CNs or DNs (primary or standby DNs). Range N/A Default Value N/A
component_id	Yes	String	Definition Component ID. Constraints Only the ID of a CN or DN (primary or standby) component deployed on the node specified by node_id is allowed. Range N/A Default Value N/A
instance_id	No	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

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
success	Boolean	Definition Check whether the operation is successful. Range true: successful false: failed

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/kill-free-session
{
	"node_id": "52c25e148a4a48c293b66ca95565719cno14",
	"component_id": "cn_5001"
}