Killing Sessions of an Instance Node¶

Function¶

This API is used to kill sessions of an instance node.

Constraints¶

Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.
Inactive sessions cannot be terminated.

URI¶

URI format
POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/session

Parameter description

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID of a tenant in a region.
node_id	Yes	String	Specifies the node ID. The following nodes can be queried: mongos nodes in the cluster, and all nodes in the replica set and single node instances.

Requests¶

Parameter description
Table 2 Request body parameters¶
Parameter
Mandatory
Type
Description
sessions
Yes
Array of strings
Specifies the IDs of sessions to be terminated.
For details, see the session ID returned in Table 4.

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
sessions	Yes	Array of strings	Specifies the IDs of sessions to be terminated. For details, see the session ID returned in Table 4.

Request example

POST https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session
{
  "sessions" : [ "34631", "34703" ]
}

Example request

POST https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session
{
  "sessions" : [ "34631", "34703" ]
}

Responses¶

{}

Status Code¶

Status Code:200.

For more information, see Status Code.

Error Code¶

For more information, see Error Code.

last updated: 2024-12-11 10:07 UTC - commit: 8bbd062201a69d7687a66f569aa6c471feb068d0