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

Downloading All Real-Time Session Information

Function

This API is used to download 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

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

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
Table 2 Query parameters

Parameter

Mandatory

Type

Description

request_id

Yes

String

Definition

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

To obtain this value, see Collecting All Real-Time Session Information.

Constraints

N/A

Range

N/A

Default Value

N/A

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

  • zh-cn: Chinese

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

-

File

Definition

A CSV file containing all real-time session information up to the current time.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

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

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/6754902da1f447269c6979b0590102a5in07/nodes/941d21130b3c4899ad1a752a0945befdno07/realtime-session-result?request_id=realtime_session-0627a175-a4d4-44cd-b78a-51dc3ef8ba9a-98e9

Example Response

Status code: 200

success

The response body is in the file stream format, and the downloaded file is in CSV format.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Intelligent Diagnosis