文档首页/云数据库 GaussDB/API参考/API（推荐）/会话管理/查询实时会话概览 - QueryingReal-TimeSessionOverview
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

查询实时会话概览 - QueryingReal-TimeSessionOverview

功能介绍

查询数据库实例节点的实时会话概览信息。

接口约束

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

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/session-overview

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表3 响应Body参数

参数

参数类型

描述

active_num

String

参数解释：

实时会话的活跃会话数。

取值范围：

不涉及。

total_num

String

参数解释：

实时会话的总会话数。

取值范围：

不涉及。

slow_sql_num

String

参数解释：

实时会话中的慢SQL数量。

取值范围：

不涉及。

lock_num

String

参数解释：

实时会话中的锁等会话数。

取值范围：

不涉及。

请求示例

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/session-overview

响应示例

{
    "active_num": "12",
    "total_num": "036",
    "slow_sql_num": "1",
    "lock_num": "0"
}

状态码

错误码

请参见错误码。

父主题：会话管理