ListMemorySessions - 查询记忆 Session 列表

更新时间:
复制 MD 格式

分页查询 MemoryStore 中的 Session,可独立按 UserId 和 AgentId 过滤。

接口说明

分页查询 MemoryStore 中的 Session,可独立按 UserId 和 AgentId 过滤。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

agentcore:ListMemorySessions

list

*MemoryStore

acs:agentcore:{#regionId}:{#accountId}:workspace/{#workspaceId}/memorystore/{#memoryStoreName}

无 无

请求语法

GET /workspaces/{workspaceId}/memorystores/{memoryStoreName}/sessions HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

workspaceId

string

是

AgentCore 工作空间 ID

ws-2f5f9c5a8d0e4c3b

memoryStoreName

string

是

MemoryStore 名称

customer-memory

请求参数

名称

类型

必填

描述

示例值

userId

string

否

用户 ID,不传时匹配全部用户,长度限制 1 - 128 UTF-8 字节,不允许包含 / 或使用 *

user-001

agentId

string

否

Agent ID,不传时匹配全部 Agent,长度限制 1 - 128 UTF-8 字节,不允许包含 / 或使用 *

agent-001

maxResults

integer

否

单页最大记录数,默认 100,取值范围 1~100

100

nextToken

string

否

下一页分页令牌

eyJvZmZzZXQiOjEwMH0=

返回参数

名称

类型

描述

示例值

object

code

string

业务状态码

SUCCESS

httpStatusCode

integer

HTTP 状态码

200

items

array<object>

Session 列表

object

单个 Memory Session

agentId

string

Agent ID,该 Session 未关联 Agent ID 时此字段不返回

agent-001

sessionId

string

Session ID

session-001

userId

string

用户 ID,该 Session 未关联用户 ID 时此字段不返回

user-001

maxResults

integer

单页最大记录数

100

message

string

响应消息

success

nextToken

string

下一页分页令牌

eyJvZmZzZXQiOjEwMH0=

requestId

string

请求 ID

01A00000-0000-0000-0000-000000000001

success

boolean

请求是否成功

示例

正常返回示例

JSON格式

{
  "code": "SUCCESS",
  "httpStatusCode": 200,
  "items": [
    {
      "agentId": "agent-001",
      "sessionId": "session-001",
      "userId": "user-001"
    }
  ],
  "maxResults": 100,
  "message": "success",
  "nextToken": "eyJvZmZzZXQiOjEwMH0=",
  "requestId": "01A00000-0000-0000-0000-000000000001",
  "success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The specified request parameter is invalid.
500 UnknownError The request processing has failed due to some unknown error.
404 Resource.NotFound The specified memory store does not exist.
429 Throttling Request was denied due to request throttling.
409 Operation.Conflict The memory store is not in a state that permits this operation.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。