Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Intelligent Diagnosis/ Collecting All Real-Time Session Information
Updated on 2026-07-16 GMT+08:00

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"
}

SDK Sample Code

The SDK sample code is as follows.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;


public class CollectRealtimeSessionSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        CollectRealtimeSessionRequest request = new CollectRealtimeSessionRequest();
        request.withInstanceId("{instance_id}");
        request.withNodeId("{node_id}");
        RealtimeSessionRequest body = new RealtimeSessionRequest();
        body.withSortDir("asc");
        body.withSortKey("trx_executed_time");
        body.withSqlKey("select count(*) from tbl where sleep(600) and 6=6");
        body.withCommand("Query");
        body.withDb("db1");
        body.withHost("192.168.8.8");
        body.withUser("root");
        body.withSlowProcessThreshold(3);
        body.withFilter("long");
        request.withBody(body);
        try {
            CollectRealtimeSessionResponse response = client.collectRealtimeSession(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CollectRealtimeSessionRequest()
        request.instance_id = "{instance_id}"
        request.node_id = "{node_id}"
        request.body = RealtimeSessionRequest(
            sort_dir="asc",
            sort_key="trx_executed_time",
            sql_key="select count(*) from tbl where sleep(600) and 6=6",
            command="Query",
            db="db1",
            host="192.168.8.8",
            user="root",
            slow_process_threshold=3,
            filter="long"
        )
        response = client.collect_realtime_session(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.CollectRealtimeSessionRequest{}
	request.InstanceId = "{instance_id}"
	request.NodeId = "{node_id}"
	sortDirRealtimeSessionRequest:= "asc"
	sortKeyRealtimeSessionRequest:= "trx_executed_time"
	sqlKeyRealtimeSessionRequest:= "select count(*) from tbl where sleep(600) and 6=6"
	commandRealtimeSessionRequest:= "Query"
	dbRealtimeSessionRequest:= "db1"
	hostRealtimeSessionRequest:= "192.168.8.8"
	userRealtimeSessionRequest:= "root"
	slowProcessThresholdRealtimeSessionRequest:= int32(3)
	filterRealtimeSessionRequest:= "long"
	request.Body = &model.RealtimeSessionRequest{
		SortDir: &sortDirRealtimeSessionRequest,
		SortKey: &sortKeyRealtimeSessionRequest,
		SqlKey: &sqlKeyRealtimeSessionRequest,
		Command: &commandRealtimeSessionRequest,
		Db: &dbRealtimeSessionRequest,
		Host: &hostRealtimeSessionRequest,
		User: &userRealtimeSessionRequest,
		SlowProcessThreshold: &slowProcessThresholdRealtimeSessionRequest,
		Filter: &filterRealtimeSessionRequest,
	}
	response, err := client.CollectRealtimeSession(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.