Killing Sessions of an Instance Node
Description
This API is used to kill sessions of an instance node.
Constraints
- This function is available for DB instances of Community Edition 3.4 or later.
- Inactive sessions cannot be terminated.
URI
| Parameter | Type | IN | Mandatory | Description |
|---|---|---|---|---|
| X-Auth-Token | string | header | Yes | Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A |
| project_id | string | path | Yes | Definition Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| node_id | string | path | Yes | Definition Node ID. Constraints
Range N/A Default Value N/A |
Request Parameters
- Parameter description
Table 2 Request body parameters Parameter
Type
Mandatory
Description
sessions
Array of strings
Yes
Definition
The IDs of sessions to be terminated.
Constraints
N/A
Range
For details, see the session ID returned in Table 4.
Default Value
N/A
Response Parameters
{} Example Requests
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session
{
"sessions" : [ "34631", "34703" ]
} Example Responses
None
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
