Killing All Sessions of a Specified Node or Instance

This API is used to kill all the sessions of a specified node or instance.

For details, see Calling APIs.

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

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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
node_id	No	String	Node ID of the sessions to be killed. Mandatory when kill_all_nodes is false.
kill_all_nodes	No	Boolean	true: Kill sessions of all nodes of the instance. false: Kill all sessions of specified nodes of the instance.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	ID of the task for killing a specified node or instance.

Status code: 400

Status code: 401

Status code: 403

Status code: 404

Status code: 500

{
  "node_id" : "8f7ee181-88e2-49b7-a4bf-81f18f93a135",
  "kill_all_nodes" : true
}

Status code: 200

Successful.

{
  "job_id" : "8abf6e1e824dfcb201824e02ee9a0015"
}

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 Code	Description
200	Successful.
400	Invalid request.
401	Invalid authentication information.
403	Access denied.
404	The requested resource could not be found.
500	Internal service error.

Parent topic: Session Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.