# 查询实时会话 - QueryingReal-TimeSessions #### 功能介绍 查询数据库实例节点的实时会话列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 接口约束 仅支持包含有CN或DN（主、备）组件的节点。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListRealTimeSessions)中调试该接口。 #### URI POST /v3/{project_id}/instances/{instance_id}/real-time-session 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围** **：** - **zh-cn：**中文 - **en-us** **：**英文 **默认取值** **：** **en-us** | 表3请求Body参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | node_id | 是 | String | **参数解释：** 节点ID。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制：** 仅支持包含有CN或DN（主、备）组件的节点。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | component_id | 是 | String | **参数解释：** 组件ID。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制：** 仅支持包含有CN或DN（主、备）组件ID，且需要是node_id参数上的组件。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | query_info | 否 | Object | **参数解释：** 获取实时会话筛选条件。 详情请参见[表4]。 **约束限制：** 不涉及。 | 表4SessionQueryInfo参数说明 | 参数 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | database_name | 否 | String | **参数解释：** 数据库名。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | client_ip | 否 | String | **参数解释：** 客户端IP。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | user_name | 否 | String | **参数解释：** 用户名。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | #### 响应参数 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sessions | Array of objects | **参数解释：** 数据库实例的实时会话列表。 详情请参见[表6]。 | 表6RealTimeSession参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | session_id | String | **参数解释：** 会话ID。 **取值范围** **：** 不涉及。 | | pid | String | **参数解释：** 线程ID。 **取值范围** **：** 不涉及。 | | unique_sql_id | String | **参数解释：** SQL ID。 **取值范围** **：** 不涉及。 | | database_name | String | **参数解释：** 数据库名。 **取值范围** **：** 不涉及。 | | client_ip | String | **参数解释：** 客户端IP。 **取值范围** **：** 不涉及。 | | user_name | String | **参数解释：** 用户名。 **取值范围** **：** 不涉及。 | | wait | String | **参数解释：** 是否等待。 **取值范围** **：** 不涉及。 | | block_session | String | **参数解释：** 阻塞会话。 **取值范围** **：** 不涉及。 | | wait_event | String | **参数解释：** 等待事件。 **取值范围** **：** 不涉及。 | | state | String | **参数解释：** 状态。 **取值范围** **：** - active：后台正在执行一个查询。 - idle：后台正在等待一个新的客户端命令。 - idle in transaction：后台在事务中，但事务中没有语句在执行。 - idle in transaction (aborted)：后台在事务中，但事务中有任务执行失败。 - fastpath function call：后台正在执行一个fast-path函数。 - disabled：如果后台禁用track_activities，则报告这个状态。 | | query_runtime | String | **参数解释：** 语句执行时长，单位：毫秒。 **取值范围** **：** 不涉及。 | | query | String | **参数解释：** SQL文本。 **取值范围** **：** 不涉及。 | | back_end_start | Long | **参数解释：** 会话开始时间。UTC时间的毫秒时间戳。 **取值范围** **：** 不涉及。 | | transaction_start | Long | **参数解释：** 事务开始时间。UTC时间的毫秒时间戳。 **取值范围** **：** 不涉及。 | | query_start | Long | **参数解释：** 语句开始时间。UTC时间的毫秒时间戳。 **取值范围** **：** 不涉及。 | | application_name | String | **参数解释：** 应用名称。 **取值范围** **：** 不涉及。 | | exec_time | String | **参数解释：** 会话建立时长（单位：秒）。 **取值范围** **：** 不涉及。 | | trans_num | String | **参数解释：** 事务数。 **取值范围** **：** 不涉及。 | | rollback_num | String | **参数解释：** 回滚次数。 **取值范围** **：** 不涉及。 | | sql_num | String | **参数解释：** SQL数。 **取值范围** **：** 不涉及。 | | client_port | String | **参数解释：** 客户端用于与后台通讯的TCP端口号，如果使用Unix套接字，则为-1。 **取值范围** **：** 不涉及。 | | query_id | String | **参数解释：** 查询语句的ID。 **取值范围** **：** 不涉及。 | | transaction_time_cost | String | **参数解释：** 当前用户上一次执行的事务持续时间，单位：毫秒。 **取值范围** **：** 不涉及。 | | trace_id | String | **参数解释：** 驱动传入的trace id，用于标识应用的一次请求。 **取值范围** **：** 不涉及。 | | global_session_id | String | **参数解释：** 当前用户上次执行的全局会话ID。 **取值范围** **：** 不涉及。 | | top_transaction_id | String | **参数解释：** 当前用户上次执行的顶层事务ID。 **取值范围** **：** 不涉及。 | | current_transaction_id | String | **参数解释：** 当前用户上次执行的事务ID。 **取值范围** **：** 不涉及。 | | xlog_quantity_pretty | String | **参数解释：** 当前用户上次执行的事务使用的XLOG量，易读格式。 **取值范围** **：** 不涉及。 | | wait_status | String | **参数解释：** 实例线程等待状态。 **取值范围** **：** 不涉及。 | | lwt_id | String | **参数解释：** 实例线程的轻量级线程号。 **取值范围** **：** 不涉及。 | | thread_name | String | **参数解释：** 实例线程名。 **取值范围** **：** 不涉及。 | | lock_mode | String | **参数解释：** 实例等锁模式。 **取值范围** **：** 不涉及。 | | parent_session_id | String | **参数解释：** 实例父会话ID。 **取值范围** **：** 不涉及。 | | smp_id | String | **参数解释：** 实例并行线程的ID。 **取值范围** **：** 不涉及。 | | lock_tag | String | **参数解释：** 实例线程正等待获取的锁的信息。 **取值范围** **：** 不涉及。 | | component_name | String | **参数解释：** 组件名称。 **取值范围** **：** 不涉及。 | #### 请求示例 ``` POST https://{Endpoint}/gaussdb/v3/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/real-time-session { "node_id": "52c25e148a4a48c293b66ca95565719cno14", "component_id": "cn_5001", "query_info": { "database_name": "postgres", "client_ip": "127.0.0.1", "user_name": "user1" } } ``` #### 响应示例 ``` { "sessions" : [{ "session_id" : "725", "pid" : "140623987341056", "unique_sql_id" : "3545025713", "database_name" : "postgres", "client_ip" : "23.100.74.131", "user_name" : "root", "wait" : "f", "block_session" : "", "wait_event" : "none", "state" : "active", "query_runtime" : "00:00:22.641774", "query" : "select pg_sleep(100);", "back_end_start" : 1690448618645, "transaction_start" : 1690448618689, "query_start" : 1690448618689, "application_name" : "gsql" , "exec_time": "97", "trans_num": "0", "rollback_num": "0", "sql_num": "0", "client_port": "60642", "query_id": "1946117988995447961", "transaction_time_cost": "12.2350", "trace_id": "", "global_session_id": "", "top_transaction_id": "0", "current_transaction_id": "0", "xlog_quantity_pretty": "0 bytes", "wait_status": "none", "lwt_id": "124841", "thread_name": "gsql", "lock_mode": "", "parent_session_id": "", "smp_id": "0", "lock_tag": "", "component_name": "dn_6001" }] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。