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

Querying Waiting Event Statistics of Real-Time Sessions

Function

This API is used to query statistics of the most frequent wait events in real-time sessions of a database instance. Before calling this API:

Constraints

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

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/session/statistic/wait-event

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

offset

Yes

Integer

Definition

Index offset. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th records are displayed.

Constraints

N/A

Range

[0, 2^31-1]

Default Value

0: The query starts from the first data record.

limit

Yes

Integer

Definition

Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

Constraints

N/A

Range

[1, 100]

Default Value

100

Request Parameters

None

Response Parameters

Table 2 Response body parameters

Parameter

Type

Description

wait_event_info

Array of objects

Definition

Statistics. For details, see Table 3.

total

Integer

Definition

Total number of statistics records.

Range

N/A
Table 3 Parameter description of the SessionWaitEventStatisticInfo field

Parameter

Type

Description

node_name

String

Definition

Component name.

Range

N/A

event_name

String

Definition

Wait event name.

Range

N/A

count

String

Definition

Number of wait events.

Range

≥ 0

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/session/statistic/wait-event?limit=20&offset=0

Example Response

{ 
  "total" : 1, 
  "wait_event_info" : [ { 
    "node_name" : "cn_5001", 
    "event_name" : "wait gs_sleep", 
    "count" : 1 
  } ] 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Session Management