Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Intelligent Diagnosis/ Collecting All Real-Time Session Information
Updated on 2026-06-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Collecting All Real-Time Session Information

Function

This API is used to collect all real-time session information of an instance up to the current time. 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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:instance:getRealtimeSession

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:getRealtimeSession

    -

URI

POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/realtime-session

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

Instance ID, which uniquely identifies an instance.

To obtain this value, see Querying DB Instances.

Constraints

N/A

Range

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

Default Value

N/A

node_id

Yes

String

Definition

Node ID.

To obtain this value, see Querying Details of a DB Instance.

Constraints

N/A

Range

The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 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: English

  • zh-cn: Chinese

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

filter

No

String

Definition

Type of real-time sessions to be collected.

Constraints

N/A

Range

  • slow: slow sessions

  • active: active sessions

  • total: total sessions

  • long: long-running transaction sessions

Default Value

total

slow_process_threshold

No

Integer

Definition

Slow session threshold, in seconds.

Constraints

N/A

Range

1–86400

Default Value

10

user

No

String

Definition

User of a real-time session.

To obtain this value, see Querying Database Users.

Constraints

N/A

Range

N/A

Default Value

N/A

host

No

String

Definition

Host of a real-time session.

To obtain this value, see Querying Database Users.

Constraints

N/A

Range

N/A

Default Value

N/A

db

No

String

Definition

Database of a real-time session.

To obtain this value, see Querying Database Users.

Constraints

N/A

Range

N/A

Default Value

N/A

command

No

String

Definition

Command type of a real-time session.

Constraints

N/A

Range

  • Sleep: idle connection

  • Query: executing a query

  • Connect: establishing a connection

  • Init DB: switching the database

  • Field List: retrieving the list of table fields

  • Processlist: viewing the session list

Default Value

N/A

sql_key

No

String

Definition

SQL statement of a real-time session.

You can log in to the console, choose DBA Assistant > Sessions, and obtain this value from the session list.

Constraints

N/A

Range

N/A

Default Value

N/A

sort_key

No

String

Definition

Sorting column of a real-time session.

Constraints

N/A

Range

  • id: session ID

  • state_duration: state duration

  • trx_executed_time: transaction duration

  • trx_id: transaction ID

  • trx_lock_duration: transaction lock wait duration

  • trx_lock_rows: number of rows locked by a transaction

  • trx_lock_tables: number of tables locked by a transaction

  • trx_update_rows: number of rows updated by a transaction

Default Value

id

sort_dir

No

String

Definition

Sorting direction of a real-time session.

Constraints

N/A

Range

  • desc: descending order

  • asc: ascending order

Default Value

asc

Response Parameters

Status code: 202

Table 4 Response body parameter

Parameter

Type

Description

request_id

String

Definition

ID of the task for collecting all real-time session information.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Collecting all real-time session information of an instance up to the current time

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/6754902da1f447269c6979b0590102a5in07/nodes/941d21130b3c4899ad1a752a0945befdno07/realtime-session

{
  "filter" : "long",
  "slow_process_threshold" : 3,
  "user" : "root",
  "host" : "192.168.8.8",
  "db" : "db1",
  "command" : "Query",
  "sql_key" : "select count(*) from tbl where sleep(600) and 6=6",
  "sort_key" : "trx_executed_time",
  "sort_dir" : "asc"
}

Example Response

Status code: 202

success

{
  "request_id" : "realtime_session-300d998f-9b07-40b5-957f-f69dfa2e22f4-225b"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Intelligent Diagnosis