Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Session Management/ Querying Real-Time Session Overview
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Querying Real-Time Session Overview

Function

This API is used to query the real-time session overview of a database instance node. Before calling this API:

Constraints

This API is suitable only for nodes with CNs or DNs (primary or standby DNs).

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/session-overview

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. 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.

You can obtain the token by calling the IAM API used to obtain a user token.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

active_num

String

Definition

Number of active real-time sessions.

Range

N/A

total_num

String

Definition

Total number of real-time sessions.

Range

N/A

slow_sql_num

String

Definition

Number of slow SQL sessions in real-time sessions.

Range

N/A

lock_num

String

Definition

Number of lock-waiting sessions in real-time sessions.

Range

N/A

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/session-overview

Example Response

{
    "active_num": "12",
    "total_num": "036",
    "slow_sql_num": "1",
    "lock_num": "0"
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Session Management