Advanced
Тема интерфейса

Killing Sessions of an Instance Node

Description

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

Restrictions

  • Community Edition 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

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

project_id

string

path

Yes

The project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

node_id

string

path

Yes

The node ID.

  • Select the mongos node in a cluster instance.
  • Select the primary or secondary node in a replica set instance.

Requests

  • Parameter description
    Table 2 Request body parameters

    Parameter

    Type

    Mandatory

    Description

    sessions

    Array of strings

    Yes

    The IDs of sessions to be terminated.

    For details, see the session ID returned in Table 4.

  • Request example
    {
    "sessions" : [ "34631", "34703" ]
    }

Responses

{}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.