Querying Real-Time Session Statistics

Function

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

Learn how to authenticate this API.
Obtain the required region and endpoint.

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-statistics

**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
dimension	Yes	String	Definition Real-time session statistics dimension. Constraints N/A Range usename: username client_addr: access source datname: database name Default Value N/A
order_field	No	String	Definition Field for sorting real-time session statistics. Constraints N/A Range active_num: number of active sessions total_num: total number of sessions Default Value N/A
order	No	String	Definition Sorting mode of real-time session statistics. Constraints N/A Range ASC: ascending order based on the value of order_field DESC: descending order based on the value of order_field Default Value N/A
offset	No	String	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	No	String	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
statistics_list	Array of objects	Definition Statistics. For details, see Table 3.
total	Integer	Definition Total number of statistics records. Range N/A

**Table 3** statistics parameter description
Parameter	Type	Description
name	String	Definition Name of the statistical data. Range N/A
active_num	String	Definition Number of active sessions. Range ≥ 0
total_num	String	Definition Total number of sessions. Range ≥ 0

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/session-statistics?dimension=usename&order_field=total_num&order=DESC

Example Response

{ 
  "total" : 1, 
  "statistics_list" : [ { 
    "name" : "root", 
    "active_num" : "50", 
    "total_num" : "100" 
  } ] 
}

Status Codes

Normal
200
Abnormal
For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Session Management

Previous topic: Querying Real-Time Session Overview

Next topic: Querying Waiting Event Statistics of Real-Time Sessions

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot