Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Session Management/ Querying Session Memory Contexts
Updated on 2026-07-16 GMT+08:00
View PDF
Share

Querying Session Memory Contexts

Function

This API is used to query session memory contexts of a database instance node. 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/memory-context

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, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances.

Constraints

N/A

Range

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

Default Value

N/A

node_id

Yes

String

Definition

Node ID. To obtain the value, see Querying the Components of a DB Instance.

Constraints

N/A

Range

N/A

Default Value

N/A

session_id

Yes

String

Definition

Session ID. To obtain the value, see Querying Real-Time Sessions.

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, 2147483647]

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

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 a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language of the information returned by the API.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

memory_context_info

Array of objects

Definition

Session memory contexts. For details, see Table 4.

total

Integer

Definition

Total number of session memory contexts.

Range

N/A
Table 4 Parameter description of the SessionMemoryContextInfo field

Parameter

Type

Description

context_name

String

Definition

Memory context name.

Range

N/A

amount

Integer

Definition

Number of session contexts.

Range

≥ 0

size

Double

Definition

Total memory size of session contexts, in bytes.

Range

≥ 0

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/session/memory-context?node_id=11e88af2febe49d48e405b083e78fa04no14&session_id=1017570&limit=20&offset=0C

Example Response

{ 
  "total" : 1, 
  "memory_context_info" : [ { 
    "context_name" : "AITopMemoryContext", 
    "amount" : 1, 
    "size" : 2.45 
  } ] 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Session Management