查询 UI 协议会话

按当前用户、来源和筛选条件读取会话记录。

POST https://api.moi.matrixorigin.cn/v5/sessions/list

调用前准备

BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。

配置同环境的身份、工作区和数值记录 ID。该入口采用普通产品身份认证,附加的任务运行期授权头会被拒绝。

请求

curl --request POST \
  "$BASE_URL/sessions/list" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data-raw '{"page":1,"page_size":20,"source":"moi"}'

明确 page_size=20 且对应普通分页范围仍有下一页时:

curl --request POST \
  "$BASE_URL/sessions/list" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data-raw '{"page":2,"page_size":20,"source":"moi"}'

参数

位置

类型

必填

说明

X-Workspace-ID

请求头

string

是

目标工作区 ID。

page

请求体

integer

否

读取的普通会话页码;省略或非正值实际按 1。

page_size

请求体

integer

否

实际页大小默认 20;普通和置顶底页超过 100 时按 20。

source

请求体

string

否

应用来源精确筛选;空值按 moi,不去掉非空值的前后空白。

keyword

请求体

string

否

标题关键词筛选;按提交的字符串匹配。

tags

请求体

string

否

一个标签名称筛选,不是数组,也不同时按标签 source 筛选。

返回 page/page_size 是请求原值,可能为 0 或超过有效上限,不保证是实际采用的分页值。明确发送合法页码和页大小,下一页保持筛选并增加 page;按普通列表 total 和有效页大小判断结束。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "sessions": [
      {
        "id": 41,
        "title": "临时会话",
        "source": "moi",
        "user_id": "user-example",
        "config": "{}",
        "tags": [],
        "created_at": 1794445200,
        "updated_at": 1794445200
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20
  }
}

字段

类型

说明

code

string

成功为 OK;HTTP 状态码为 200。

msg

string

成功为 OK。

data.sessions

array(对象数组)

本页会话对象。

data.total

integer

符合当前筛选的会话总数。

data.page

integer

请求的原始页码,不保证是规范化后的值。

data.page_size

integer

请求的原始页大小,不保证是实际页大小。

错误响应

错误格式和结果确认区分会话详情的 not-found 与其他入口的通用服务错误。

最后更新于