Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying the Current Sessions of an HTAP Instance
Updated on 2026-02-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Current Sessions of an HTAP Instance

Function

This API is used to query the current sessions of an HTAP instance. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Standard HTAP instance ID, which is compliant with the UUID format. You can call the API for querying HTAP instances to obtain the ID.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Definition

Number of records to be queried.

Constraints

The value must be an integer and cannot be a negative number.

Range

1–100

Default Value

100

offset

No

String

Definition

Index offset. The query starts from the next piece of data indexed by this parameter.

Constraints

The value must be an integer and cannot be a negative number.

Range

≥ 0

Default Value

0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

process_list

Array of HtapProcessInfo objects

Definition

Sessions of a standard HTAP instance.

Default Value

N/A
Table 5 HtapProcessInfo

Parameter

Type

Description

id

String

Definition

Session ID.

Range

N/A

user

String

Definition

Session username.

Range

N/A

host

String

Definition

Session host.

Range

N/A

state

String

Definition

Session status.

Range

N/A

database

String

Definition

Database corresponding to the session.

Range

N/A

sql_statement

String

Definition

SQL statement executed by the session.

Range

N/A

duration

String

Definition

Session duration, in seconds.

Range

N/A

command

String

Definition

Session command type.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the current sessions of an HTAP instance

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

Example Response

Status code: 200

Success.

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

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: HTAP (Standard Edition)