文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 关闭实例节点会话
更新时间：2023-12-25 GMT+08:00
查看PDF
分享

关闭实例节点会话

功能介绍

关闭实例节点会话。

接口约束

该接口支持如下数据库实例：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

是否删除全部会话。

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

{ }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理