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

查询实时会话统计

功能介绍

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

接口约束

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

dimension

是

String

参数解释：

实时会话统计维度。

约束限制：

不涉及。

取值范围：

  • usename：用户名。
  • client_addr：访问来源。
  • datname：数据库名。

默认取值：

不涉及。

order_field

否

String

参数解释：

实时会话统计排序字段。

约束限制：

不涉及。

取值范围：

active_num：活跃会话数。

total_num：总会话数。

默认取值：

不涉及。

order

否

String

参数解释：

实时会话统计排序方式。

约束限制：

不涉及。

取值范围：

  • ASC：根据order_field值升序。
  • DESC：根据order_field值降序。

默认取值：

不涉及。

offset

否

String

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为0，limit指定为10，则只展示第1~10条数据。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]

默认取值：

默认为0（偏移0条数据，表示从第一条数据开始查询）。

limit

否

String

参数解释：

查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。

约束限制：

不涉及。

取值范围：

[1, 100]

默认取值：

默认为100。

请求参数

无。

响应参数

表2 响应Body参数

参数

参数类型

描述

statistics_list

Array of objects

参数解释：

统计数据。详细内容请参见表3。

total

Integer

参数解释：

统计总条数。

取值范围：

不涉及。
表3 statistics参数说明

参数

参数类型

描述

name

String

参数解释：

统计数据名称。

取值范围：

不涉及。

active_num

String

参数解释：

活跃会话数。

取值范围：

大于等于0。

total_num

String

参数解释：

总会话数。

取值范围：

大于等于0。

请求示例

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/session-statistics?dimension=usename&order_field=total_num&order=DESC

响应示例

{ 
  "total" : 1, 
  "statistics_list" : [ { 
    "name" : "root", 
    "active_num" : "50", 
    "total_num" : "100" 
  } ] 
}

状态码

错误码

请参见错误码。

父主题： 会话管理

相关文档