文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 会话管理/ 查询等待事件列表
更新时间：2025-10-20 GMT+08:00
查看PDF
分享

查询等待事件列表

功能介绍

查询数据库实例节点的等待事件列表。

接口约束

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

调试

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

URI

POST /v3/{project_id}/instances/{instance_id}/wait-event-list

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例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参数说明

名称

是否必选

参数类型

说明

node_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

system

否

Boolean

参数解释：

是否查询系统用户。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

false

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为数字，不能为负数。

取值范围：

不涉及。

默认取值：

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

limit

否

Integer

参数解释：

查询记录数。

约束限制：

不能为负数。

取值范围：

[1，100]

默认取值：

默认为10。

order_fields

否

List<List<String>>

参数解释：

排序字段列表。

内部List<String>，第一个值为需要排序字段，第二个值为排序方式。

约束限制：

不涉及。

wait_event_query_info

否

Object

参数解释：

获取等待事件筛选条件。

详情请参见表4

约束限制：

不涉及。
表4 WaitEventQueryInfo参数说明

参数

是否必选

参数类型

说明

database_name

否

String

参数解释：

数据库名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

user_name

否

String

参数解释：

用户名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

waiting

否

String

参数解释：

是否在等待状态。

约束限制：

不涉及。

取值范围：

  • t：是
  • f：否

默认取值：

不涉及。

session_id

否

String

参数解释：

会话ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

表5 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

等待事件的总数量。

取值范围：

不涉及。

rows

Array of objects

参数解释：

数据库实例的等待事件列表。参见表6
表6 WaitEvent参数说明

参数

参数类型

描述

session_id

String

参数解释：

会话ID。

取值范围：

不涉及。

pid

String

参数解释：

线程ID。

取值范围：

不涉及。

wait_event

String

参数解释：

等待事件。

参见“开发指南 > 系统表和系统视图 > 系统视图 > 其他系统视图 > PG_THREAD_WAIT_STATUS”中的wait_event字段。

取值范围：

不涉及。

wait_status

String

参数解释：

等待状态。

参见“开发指南 > 系统表和系统视图 > 系统视图 > 其他系统视图 > PG_THREAD_WAIT_STATUS”中的等待状态列表。

取值范围：

不涉及。

database_name

String

参数解释：

数据库。

取值范围：

不涉及。

user_name

String

参数解释：

用户名。

取值范围：

不涉及。

client_addr

String

参数解释：

客户端地址。

取值范围：

不涉及。

client_port

String

参数解释：

客户端用于与后台通讯的TCP端口号。

取值范围：

不涉及。

session_time

String

参数解释：

会话持续时间，单位秒。

取值范围：

不涉及。

xact_start

String

参数解释：

会话开始时间。

取值范围：

不涉及。

transaction_time

String

参数解释：

事务持续时间，单位秒。

取值范围：

不涉及。

query_start

String

参数解释：

查询开始时间。

取值范围：

不涉及。

state_change

String

参数解释：

上次状态改变的时间。

取值范围：

不涉及。

query_time

String

参数解释：

查询持续时间，单位秒。

取值范围：

不涉及。

backend_start

String

参数解释：

会话开始时间。

取值范围：

不涉及。

waiting

String

参数解释：

是否在等待锁。

取值范围：

  • t：是
  • f：否

lockmode

String

参数解释：

（等待获取的）锁模式。

取值范围：

不涉及。

block_sessionid

String

参数解释：

阻塞会话ID。

取值范围：

不涉及。

block_count

String

参数解释：

阻塞会话数。

取值范围：

不涉及。

unique_sql_id

String

参数解释：

归一化SQL ID。

取值范围：

不涉及。

query_id

String

参数解释：

查询 ID。

取值范围：

不涉及。

query

String

参数解释：

SQL文本。

取值范围：

不涉及。

current_xid

String

参数解释：

当前事务ID。

取值范围：

不涉及。

top_xid

String

参数解释：

顶层事务ID。

取值范围：

不涉及。

xlog_quantity

String

参数解释：

事务当前使用的XLOG量，单位为字节。

取值范围：

不涉及。

state

String

参数解释：

该会话当前总体状态。

取值范围：

  • active：后台正在执行一个查询。
  • idle：后台正在等待一个新的客户端命令。
  • idle in transaction：后台在事务中，但事务中没有语句在执行。
  • fastpath function call：后台正在执行一个fast-path函数。
  • disabled：如果后台禁用track_activities，则事务显示此状态。

application_name

String

参数解释：

应用名称。

取值范围：

不涉及。

connection_info

String

参数解释：

连接信息。

取值范围：

不涉及。

请求示例

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/wait-event-list
{
    "node_id": "1fafb3b79c4b41cdb2f8ecd90a80ba5eno14",
    "limit": 1,
    "offset": 10,
    "order_fields": [["query_start", "ASC"]],
    "wait_event_query_info": {
        "database_name": "postgres"
    }
}

响应示例

{
    "total": 1,
    "rows": [
        {
            "session_id": "3377",
            "database_name": "postgres",
            "user_name": "root",
            "unique_sql_id": "3545025713",
            "query_id": "1949495688698202784",
            "pid": "139646718113344",
            "client_addr": "127.0.0.1",
            "client_port": "50856",
            "state": "active",
            "query": "select pg_sleep(300);",
            "application_name": "gsql",
            "wait_event": "wait gs_sleep",
            "wait_status": "wait gs_sleep",
            "session_time": "76",
            "xact_start": "2024-12-21 14:29:38.360946+08",
            "transaction_time": "73",
            "query_start": "2024-12-21 14:29:38.360946+08",
            "state_change": "2024-12-21 14:29:38.360956+08",
            "query_time": "73934470",
            "backend_start": "2024-12-21 14:29:35.728347+08",
            "waiting": "f",
            "lockmode": "",
            "block_sessionid": "",
            "block_count": "",
            "current_xid": "0",
            "top_xid": "0",
            "xlog_quantity": "0",
            "connection_info": "{\"driver_name\":\"libpq\",\"driver_version\":\"(GaussDB Kernel 505.2.1 build 22cc96d0) compiled at 2024-11-27 02:07:13 commit 10063 last mr 20829 release\"}"
        }
    ]
}

状态码

错误码

请参见错误码。

父主题： 会话管理