Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Closing Sessions of an Instance Node
Updated on 2025-12-04 GMT+08:00
View PDF
Share

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.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:deleteSession

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:session:delete

    -

URI

DELETE /v3/{project_id}/redis/nodes/{node_id}/sessions

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

node_id

Yes

String

Definition

Node ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

is_all

Yes

Boolean

Definition

Whether all sessions are closed.

Constraints

N/A

Range

  • true: All sessions are closed.
  • false: Not all sessions are closed.

Default Value

N/A

session_ids

No

Array of strings

Definition

ID of the session to be closed. When the value of is_all is false, this parameter cannot be left empty.

Constraints

N/A

Range

N/A

Default Value

N/A

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

Successful response

{ }

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances