查询 SQL 历史概览¶

按时间范围和 SQL 来源汇总当前工作区内的 SQL 执行记录数量。结果只包含各执行状态的数量，不返回单条 SQL 执行记录。默认只统计当前身份的记录。具备相应权限时，可以统计工作区范围的记录。

POST https://api.moi.matrixorigin.cn/v5/query/history/overview

调用前准备¶

准备有当前工作区访问权限的个人访问令牌和当前工作区 ID。

请求体¶

将示例中的 $AI_STUDIO_API_KEY、$WORKSPACE_ID 替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/query/history/overview" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
  "start": "2026-08-26T08:00:00Z",
  "end": "2026-08-26T09:00:00Z"
}'

参数说明

字段	类型	是否必填	说明
`scope`	string 或 null	否	统计当前身份或当前工作区的记录。取值：空字符串、`self`、`workspace`。
`non_user`	boolean 或 null	否	是否同时统计非用户 SQL。
`start`	string 或 null	否	统计开始时间，例如 2026-08-26T08:00:00Z。RFC 3339 时间。
`end`	string 或 null	否	统计结束时间，例如 2026-08-26T09:00:00Z。RFC 3339 时间。
`sql_source_type`	string（字符串数组）或 null	否	按 SQL 来源类型筛选。非空数组按其值筛选。

省略时间范围时，使用部署配置的默认查询窗口。该窗口并非固定为 5 分钟。

查看范围

scope 值	可统计的记录	权限条件。
self	当前身份的记录。	默认范围。
workspace	工作区范围的记录。	需要工作区审计读取权限。

查询时间和 SQL 来源

时间需填写完整的日期、时间和时区。开始和结束时间都未填写时，按部署配置的默认回看窗口统计记录。可以只填写其中一个时间作为统计边界。

填写 sql_source_type 时，按指定来源统计。未填写时，non_user=true 统计全部来源。填 false 或省略时，只统计用户 SQL 和外部 SQL。

成功响应¶

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 3,
    "success": 2,
    "running": 0,
    "failed": 1
  }
}

字段说明

字段	类型	说明
`data.total`	integer	符合筛选条件的记录总数。
`data.success`	integer	状态为 Success 的记录数。
`data.running`	integer	状态为 Running 的记录数。
`data.failed`	integer	状态为 Failed 的记录数。

需要查看单条 SQL 执行记录时，使用查询 SQL 执行记录。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效"
}

字段说明

字段	类型	说明
code	string	错误代码。
msg	string	错误信息。

最后更新于 2026 年 10 月 19 日