Querying and Killing Specified Sessions

Function

This API is used to query and kill specified 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-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 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. 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
session_ids	Yes	Array of strings	Definition IDs of sessions to be killed. Constraints 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 4** Parameter description
Parameter	Type	Description
session_ids	Array of strings	Definition IDs of sessions that were killed.
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-session
{
	"node_id": "52c25e148a4a48c293b66ca95565719cno14",
	"component_id": "cn_5001",
	"session_ids": ["10180"]
}

Example Response

{ 
  "session_ids" : [ "10180" ], 
  "success" : true 
}

Status Codes

Normal
200
Abnormal
For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Session Management

Previous topic: Querying Top SQL Statistics of Real-Time Sessions

Next topic: Querying and Killing Idle Sessions

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot