Querying Session Memory Contexts

This API is used to query session memory contexts of a database instance node. Before calling this API:

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

You can debug this API in API Explorer.

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. Constraints N/A Range N/A Default Value N/A
node_id	Yes	String	Definition Node ID. Constraints N/A Range N/A Default Value N/A
session_id	Yes	String	Definition Session 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

None

**Table 2** Response body parameters
Parameter	Type	Description
memory_context_info	Array of objects	Definition Session memory contexts. For details, see Table 3.
total	Integer	Definition Total number. Range N/A

**Table 3** 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. Range ≥ 0

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

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

For details, see Error Codes.

Parent topic: Session Management

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.