Help Center/ Distributed Cache Service/ API Reference/ API V2/ Session Management/ Killing Specified Sessions
Updated on 2025-05-13 GMT+08:00
View PDF

Killing Specified Sessions

Function

This API is used to kill specified sessions.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/clients/kill

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

node_id

Yes

String

Node ID.

client_addrs

Yes

Array of strings

List of addresses of the sessions to be killed. The value is the address and port of peer in the session information.

Response Parameters

Status code: 204

Successful.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Error message details.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Error message details.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Error message details.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Error message details.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Error message details.

Example Requests

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/clients/kill

{
  "node_id" : "8f7ee181-88e2-49b7-a4bf-81f18f93a135",
  "client_addrs" : [ "10.63.238.158:2048", "10.63.238.159:3058" ]
}

Example Responses

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4957",
  "error_msg" : "This operation is not allowed when the task is in the current state."
}

Status Codes

Status Code

Description

204

Successful.

400

Invalid request.

401

Invalid authentication information.

403

Access denied.

404

The requested resource could not be found.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Session Management