文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 会话管理/ 查询会话内存上下文列表 - QueryingSessionMemoryContexts
更新时间:2026-07-16 GMT+08:00

查询会话内存上下文列表 - QueryingSessionMemoryContexts

功能介绍

查询数据库实例节点的会话内存上下文列表。

接口约束

仅支持包含有CN或DN(主、备)组件的节点。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/session/memory-context

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。请参考查询数据库实例列表 - QueryingDBInstances接口获取实例ID。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值

不涉及。

node_id

String

参数解释:

节点ID。获取方式请参考查询实例的组件列表 - QueryingtheComponentsofaDBInstance

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

session_id

String

参数解释:

会话ID。获取方式请参考查询实时会话 - QueryingReal-TimeSessions

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

offset

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。例如:该参数指定为0,limit指定为10,则只展示第1~10条数据。

约束限制:

不涉及。

取值范围:

[0, 2147483647]

默认取值

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。

约束限制:

不涉及。

取值范围:

[1, 100]

默认取值

默认为100。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

指定接口返回信息的语言类型。

约束限制:

不涉及。

取值范围

  • zh-cn:中文
  • en-us英文

默认取值

en-us

响应参数

表3 响应Body参数

参数

参数类型

描述

memory_context_info

Array of objects

参数解释:

会话内存上下文列表。详细内容请参见表4

total

Integer

参数解释:

会话内存上下文列表总数。

取值范围:

不涉及。

表4 SessionMemoryContextInfo参数说明

参数

参数类型

描述

context_name

String

参数解释:

内存上下文名称。

取值范围:

不涉及。

amount

Integer

参数解释:

会话上下文数量。

取值范围:

大于等于0。

size

Double

参数解释:

会话内存上下文总大小,单位:Byte。

取值范围:

大于等于0。

请求示

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

响应示例

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

状态码

错误码

请参见错误码