文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ 智能诊断/ 收集全部实时会话信息 - CollectRealtimeSession
更新时间:2026-07-09 GMT+08:00
分享

收集全部实时会话信息 - CollectRealtimeSession

功能介绍

收集目标实例截止当前时间点的实时会话信息。

调用方法

请参见如何调用API

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

获取方法请参见查询实例列表

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

node_id

String

参数解释

节点ID。

获取方法请参见查询实例详情信息

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,前面为UUID,后缀为no07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us:英文。

  • zh-cn:中文。

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

filter

String

参数解释

需要收集的实时会话类型。

约束限制

不涉及。

取值范围

  • slow:慢会话。

  • active:活跃会话。

  • total:会话总数。

  • long:长事务会话。

默认取值

total。

slow_process_threshold

Integer

参数解释

慢会话阈值,单位是秒。

约束限制

不涉及。

取值范围

1-86400。

默认取值

10。

user

String

参数解释

实时会话的用户。

获取方法请参见查询数据库用户

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

host

String

参数解释

实时会话的主机。

获取方法请参见查询数据库用户

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

db

String

参数解释

实时会话的数据库。

获取方法请参见查询数据库用户

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

command

String

参数解释

实时会话的命令类型。

约束限制

不涉及。

取值范围

  • Sleep:空闲连接,无任何操作。

  • Query:正在执行查询。

  • Connect:建立连接。

  • Init DB:切换数据库。

  • Field List:获取表字段列表。

  • Processlist:查看会话列表。

默认取值

不涉及。

sql_key

String

参数解释

实时会话的SQL语句。

您可以通过登录管理控制台,选择智能DBA助手下的实时会话,在会话列表中获取。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

sort_key

String

参数解释

实时会话的排序列。

约束限制

不涉及。

取值范围

  • id:会话ID。

  • state_duration:状态持续时间。

  • trx_executed_time:事务持续时间。

  • trx_id:事务ID。

  • trx_lock_duration:事务锁等待时长。

  • trx_lock_rows:事务锁定行数。

  • trx_lock_tables:事务锁定表数量。

  • trx_update_rows:事务更新行数。

默认取值

id。

sort_dir

String

参数解释

实时会话的排序方向。

约束限制

不涉及。

取值范围

  • desc:降序排列。

  • asc:升序排列。

默认取值

asc。

响应参数

状态码:202

表4 响应Body参数

参数

参数类型

描述

request_id

String

参数解释

收集全部实时会话信息的任务ID。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

收集目标实例截止当前时间点的实时会话信息。

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

响应示例

状态码:202

success

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

SDK代码示例

SDK代码示例如下。

收集目标实例截止当前时间点的实时会话信息。

 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());
        }
    }
}

收集目标实例截止当前时间点的实时会话信息。

 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)

收集目标实例截止当前时间点的实时会话信息。

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

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

202

success

400

Client error.

错误码

请参见错误码

相关文档