文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 查询HTAP实例当前会话 - ShowHtapProcessList
更新时间：2026-02-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询HTAP实例当前会话 - ShowHtapProcessList

功能介绍

查询HTAP实例当前会话。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/instances/{instance_id}/htap/process

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认值：

不涉及。

instance_id

是

String

参数解释：

HTAP标准版实例ID，严格匹配UUID规则。可通过调用查询HTAP实例列表接口获取。

约束限制：

不涉及。

取值范围：

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

默认值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

String

参数解释：

查询记录数。

约束限制：

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

取值范围：

1-100。

默认值：

100。

offset

否

String

参数解释：

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

约束限制：

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

取值范围：

≥0

默认值：

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。

X-Language

是

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认值：

en-us。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

process_list

Array of HtapProcessInfo objects

参数解释：

HTAP标准版查询的会话信息。

默认值：

不涉及。
表5 HtapProcessInfo

参数

参数类型

描述

id

String

参数解释：

会话ID。

取值范围：

不涉及。

user

String

参数解释：

会话用户名。

取值范围：

不涉及。

host

String

参数解释：

会话主机。

取值范围：

不涉及。

state

String

参数解释：

会话状态。

取值范围：

不涉及。

database

String

参数解释：

会话对应数据库。

取值范围：

不涉及。

sql_statement

String

参数解释：

会话执行的SQL语句。

取值范围：

不涉及。

duration

String

参数解释：

会话持续时间，单位是秒。

取值范围：

不涉及。

command

String

参数解释：

会话命令类型。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询HTAP实例当前会话。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin17/htap/process?offset=1&limit=10

响应示例

状态码：200

Success.

{
  "process_list" : [ {
    "id" : "1",
    "user" : "user",
    "host" : "host",
    "state" : "OK",
    "database" : "sys",
    "sql_statement" : "show full processlist",
    "duration" : 10,
    "command" : "Query"
  } ]
}

状态码：400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： HTAP-标准版

相关文档