Closing Sessions of an Instance Node
Function
This API is used to close sessions of an instance node.
Constraints
This API supports GeminiDB Redis instances and can be used to close inactive sessions of an instance node.
URI
DELETE /v3/{project_id}/redis/nodes/{node_id}/sessions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
node_id |
Yes |
String |
Node ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
is_all |
Yes |
Boolean |
Whether all sessions are closed. |
session_ids |
No |
Array of strings |
ID of the session to be closed. When the value of is_all is false, this parameter cannot be left empty. |
Response Parameters
Status code: 200
No response parameters
Example Requests
- URI example
DELETE https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/nodes/784b3fb7bac14bc490659950dd4f022fno12/sessions
- Deleting sessions 1131 and 2323
{ "is_all" : false, "session_ids" : [ "1131", "2323" ] }
Example Responses
Status code: 200
Success
{ }
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.