查看 SQL 历史概览

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

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

调用前准备

准备有当前工作区访问权限的个人访问令牌和当前工作区 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

否

统计当前身份或当前工作区的记录。

start

string

否

统计开始时间，例如 2026-08-26T08:00:00Z。

end

string

否

统计结束时间，例如 2026-08-26T09:00:00Z。

sql_source_type

array of string

否

按 SQL 来源类型筛选。非空数组按其值筛选。

non_user

boolean

否

是否同时统计非用户 SQL。

查看范围

scope 值

可统计的记录

权限条件

self

当前身份的记录。

默认范围。

workspace

工作区范围的记录。

需要工作区审计读取权限。

查询时间和 SQL 来源

时间需填写完整的日期、时间和时区。开始和结束时间都未填写时，默认统计请求前 5 分钟内的记录；可以只填写其中一个时间作为统计边界。

指定 SQL 来源时，以 sql_source_type 为准。未指定 SQL 来源时，non_user 为 true 会统计全部来源；false 或省略时，只统计用户 SQL 和外部 SQL。

成功响应

成功时返回 SQL 执行记录的数量汇总。data.total 为 0 表示本次筛选范围内没有可统计的记录，不表示查询失败。

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

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data.total

integer

符合筛选条件的记录总数。

data.success

integer

状态为 Success 的记录数。

data.running

integer

状态为 Running 的记录数。

data.failed

integer

状态为 Failed 的记录数。

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

—

后续操作

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

最后更新于