文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 智能诊断/ 收集全部实时会话信息 - CollectRealtimeSession
更新时间：2026-05-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

收集全部实时会话信息 - CollectRealtimeSession

功能介绍

收集目标实例截止当前时间点的实时会话信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:getRealtimeSession

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:getRealtimeSession

    -

URI

POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/realtime-session

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

node_id

是

String

参数解释：

节点ID。

获取方法请参见查询实例详情信息。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为no07，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

filter

否

String

参数解释：

需要收集的实时会话类型。

约束限制：

不涉及。

取值范围：

  • slow：慢会话。

  • active：活跃会话。

  • total：会话总数。

  • long：长事务会话。

默认取值：

total。

slow_process_threshold

否

Integer

参数解释：

慢会话阈值，单位是秒。

约束限制：

不涉及。

取值范围：

1-86400。

默认取值：

10。

user

否

String

参数解释：

实时会话的用户。

获取方法请参见查询数据库用户。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

host

否

String

参数解释：

实时会话的主机。

获取方法请参见查询数据库用户。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

db

否

String

参数解释：

实时会话的数据库。

获取方法请参见查询数据库用户。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

command

否

String

参数解释：

实时会话的命令类型。

约束限制：

不涉及。

取值范围：

  • Sleep：空闲连接，无任何操作。

  • Query：正在执行查询。

  • Connect：建立连接。

  • Init DB：切换数据库。

  • Field List：获取表字段列表。

  • Processlist：查看会话列表。

默认取值：

不涉及。

sql_key

否

String

参数解释：

实时会话的SQL语句。

您可以通过登录管理控制台，选择智能DBA助手下的实时会话，在会话列表中获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort_key

否

String

参数解释：

实时会话的排序列。

约束限制：

不涉及。

取值范围：

  • id：会话ID。

  • state_duration：状态持续时间。

  • trx_executed_time：事务持续时间。

  • trx_id：事务ID。

  • trx_lock_duration：事务锁等待时长。

  • trx_lock_rows：事务锁定行数。

  • trx_lock_tables：事务锁定表数量。

  • trx_update_rows：事务更新行数。

默认取值：

id。

sort_dir

否

String

参数解释：

实时会话的排序方向。

约束限制：

不涉及。

取值范围：

  • desc：降序排列。

  • asc：升序排列。

默认取值：

asc。

响应参数

状态码：202

表4 响应Body参数

参数

参数类型

描述

request_id

String

参数解释：

收集全部实时会话信息的任务ID。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

收集目标实例截止当前时间点的实时会话信息。

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/6754902da1f447269c6979b0590102a5in07/nodes/941d21130b3c4899ad1a752a0945befdno07/realtime-session

{
  "filter" : "long",
  "slow_process_threshold" : 3,
  "user" : "root",
  "host" : "192.168.8.8",
  "db" : "db1",
  "command" : "Query",
  "sql_key" : "select count(*) from tbl where sleep(600) and 6=6",
  "sort_key" : "trx_executed_time",
  "sort_dir" : "asc"
}

响应示例

状态码：202

success

{
  "request_id" : "realtime_session-300d998f-9b07-40b5-957f-f69dfa2e22f4-225b"
}

状态码

状态码

描述

202

success

400

Client error.

错误码

请参见错误码。

父主题： 智能诊断

相关文档