1
0
forked from docs/doc-exports
doc-exports/docs/dds/api-ref/dds_connect_0003.html
Wang , Deng Ke 60010eb9d0 dds api 2.0.38sp24 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-01-13 08:55:41 +00:00

7.0 KiB

Killing Sessions of an Instance Node

Function

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

Constraints

  • Community Edition 3.4 and 4.0 instances are supported.
  • Inactive sessions cannot be terminated.

URI

  • 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.

  • 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.