更新时间:2025-04-01 GMT+08:00

关闭实例节点会话

功能介绍

关闭实例节点会话。

接口约束

该接口支持如下数据库实例:GeminiDB Redis,可以删除不活跃的节点会话。

URI

DELETE https://{Endpoint}/v3/{project_id}/redis/nodes/{node_id}/sessions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

node_id

String

参数解释:

节点ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

is_all

Boolean

参数解释:

是否删除全部会话。

约束限制:

不涉及。

取值范围:

  • true,表示全部关闭。
  • false,表示非全部关闭。

默认取值:

不涉及。

session_ids

Array of strings

参数解释:

需要删除的会话id。is_all为false的时候,session_ids为必填,不能为空。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

无响应参数。

请求示例

  • URI样例
    DELETE https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/nodes/784b3fb7bac14bc490659950dd4f022fno12/sessions 
  • 删除"1131"和"2323"的会话
    { 
      "is_all" : false, 
      "session_ids" : [ "1131", "2323" ] 
    }

响应示例

状态码: 200

Success

{ }

状态码

请参见状态码

错误码

请参见错误码