Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Connection Management/ Closing Sessions of All Nodes on an Instance
Updated on 2025-09-16 GMT+08:00

Closing Sessions of All Nodes on an Instance

Function

This API is used to close sessions of all nodes on an instance.

Constraints

This API can be used only for the following instance type:

  • GeminiDB Redis (proxy cluster)

URI

DELETE /v3/{project_id}/instances/{instance_id}/sessions

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

To obtain this value, call the IAM API for obtaining a user token.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

None

Example Request

DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/c865f921f3dd45198f209a607533a779in12/sessions

Example Response

Status code: 200

Successful request

{ 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.