查询实时会话
接口约束
仅支持包含有CN或DN(主、备)组件的节点。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/instances/{instance_id}/real-time-session
| 名称 | 是否必选 | 说明 | 
|---|---|---|
| project_id | 是 | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 | 
| instance_id | 是 | 参数解释: 实例ID,此参数是用户创建实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| X-Language | 否 | String | 参数解释: 语言。 约束限制: 不涉及。 取值范围: 
 默认取值: en-us。 | 
| 名称 | 是否必选 | 参数类型 | 说明 | 
|---|---|---|---|
| node_id | 是 | String | 参数解释: 节点ID。 约束限制: 仅支持包含有CN或DN(主、备)组件的节点。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| component_id | 是 | String | 参数解释: 组件ID。 约束限制: 仅支持包含有CN或DN(主、备)组件ID,且需要是node_id参数上的组件。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| query_info | 否 | Object | 参数解释: 获取实时会话筛选条件。 详情请参见表4。 约束限制: 不涉及。 | 
响应参数
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| sessions | Array of objects | 参数解释: 数据库实例的实时会话列表。 详情请参见表6。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| 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 | 参数解释: 状态。 取值范围: 不涉及。 | 
| query_runtime | String | 参数解释: 语句执行时长。 取值范围: 不涉及。 | 
| query | String | 参数解释: SQL文本。 取值范围: 不涉及。 | 
| back_end_start | Long | 参数解释: 会话开始时间。 取值范围: 不涉及。 | 
| transaction_start | Long | 参数解释: 事务开始时间。 取值范围: 不涉及。 | 
| query_start | Long | 参数解释: 语句开始时间。 取值范围: 不涉及。 | 
| application_name | String | 参数解释: 应用名称。 取值范围: 不涉及。 | 
| exec_time | String | 参数解释: 会话建立时长(单位:秒)。 取值范围: 不涉及。 | 
| trans_num | String | 参数解释: 事务数。 取值范围: 不涉及。 | 
| rollback_num | String | 参数解释: 回滚次数。 取值范围: 不涉及。 | 
| sql_num | String | 参数解释: SQL数。 取值范围: 不涉及。 | 
请求示例
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"
   }] 
 }
 状态码
- 正常
- 异常
    请参见状态码。 
错误码
请参见错误码。
 
    