文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 会话管理/ 结束空闲会话
更新时间：2025-09-11 GMT+08:00
查看PDF
分享

结束空闲会话

功能介绍

查杀空闲会话。

接口约束

仅支持包含有CN或DN（主、备）组件的节点。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/{project_id}/instances/{instance_id}/kill-free-session

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Body参数说明

名称

是否必选

参数类型

说明

node_id

是

String

参数解释：

节点ID。

约束限制：

仅支持包含有CN或DN（主、备）组件的节点。

取值范围：

不涉及。

默认取值：

不涉及。

component_id

是

String

参数解释：

组件ID。

约束限制：

仅支持包含有CN或DN（主、备）组件ID，且需要是node_id参数上的组件。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

表3 参数说明

参数

参数类型

描述

success

Boolean

参数解释：

是否成功。

取值范围：

  • true：成功。
  • false：失败。

请求示例

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/kill-free-session
{
	"node_id": "52c25e148a4a48c293b66ca95565719cno14",
	"component_id": "cn_5001"
}

响应示例

{ 
  "success" : true 
}

状态码

错误码

请参见错误码。

父主题： 会话管理

相关文档