查看操作日志¶
按条件分页查看当前身份在当前工作区的操作记录,可用于追溯操作时间、结果和相关资源。
GET https://api.moi.matrixorigin.cn/v5/audit/logs
调用前准备¶
查询参数¶
curl -G "https://api.moi.matrixorigin.cn/v5/audit/logs" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
--data-urlencode 'method=POST' \
--data-urlencode 'result=success' \
--data-urlencode 'start_time=2026-08-18T00:00:00Z' \
--data-urlencode 'end_time=2026-08-18T01:00:00Z' \
--data-urlencode 'page=1' \
--data-urlencode 'page_size=20'
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
operator_user_id |
string |
否 |
无需填写;系统只返回当前身份的操作记录。 |
method |
string |
否 |
按请求方法筛选。 |
result |
string |
否 |
按操作结果筛选。可填写 success 或 failed。 |
status_code |
integer |
否 |
按状态码筛选。 |
start_time |
string |
否 |
查询开始时间,例如 2026-08-18T00:00:00Z。 |
end_time |
string |
否 |
查询结束时间,例如 2026-08-18T01:00:00Z。 |
page |
integer |
否 |
页码,从 1 开始。 |
page_size |
integer |
否 |
每页返回的记录数。 |
查询时间和分页
时间需填写完整的日期、时间和时区。页码省略或小于 1 时使用第 1 页;每页条数省略或小于 1 时使用 20,最大为 200。
筛选操作日志
读取下一页时保留原筛选条件,并将 page 加 1。例如,读取第 2 页:
curl -G "https://api.moi.matrixorigin.cn/v5/audit/logs" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
--data-urlencode 'method=POST' \
--data-urlencode 'result=success' \
--data-urlencode 'start_time=2026-08-18T00:00:00Z' \
--data-urlencode 'end_time=2026-08-18T01:00:00Z' \
--data-urlencode 'page=2' \
--data-urlencode 'page_size=20'
累计读取的日志数达到总数,或当前页没有记录时,停止翻页。
成功响应¶
成功时返回操作日志。日志按 created_at 降序排列。
{
"code": "OK",
"msg": "OK",
"data": {
"items": [
{
"id": "0190e1b6-7fe3-7cc2-9d7f-f589f9d37653",
"workspace_id": "workspace-123",
"operator_user_id": "user-123",
"operator_name_snapshot": "张三",
"method": "POST",
"path": "/workflow/v2/workflow-apps",
"route_pattern": "/workflow/v2/workflow-apps",
"status_code": 200,
"result": "success",
"duration_ms": 35,
"created_at": "2026-08-18T00:30:00Z"
}
],
"total": 1,
"page": 1,
"page_size": 20
}
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
成功时为 OK。 |
msg |
string |
成功时为 OK。 |
data.items |
array of object |
本页的操作日志。 |
data.total |
integer |
符合筛选条件的日志总数。 |
data.page |
integer |
本次响应使用的页码。 |
data.page_size |
integer |
本次响应实际使用的每页条数。 |
data.items[].id |
string |
日志 ID。 |
data.items[].workspace_id |
string |
日志所属工作区 ID。 |
data.items[].operator_user_id |
string |
执行操作的用户 ID。 |
data.items[].operator_name_snapshot |
string |
记录时保存的操作人名称。 |
data.items[].method |
string |
请求方法。 |
data.items[].path |
string |
实际请求路径。 |
data.items[].route_pattern |
string |
路由模板。 |
data.items[].query_json |
string |
已记录的查询参数。 |
data.items[].request_body_json |
string |
已记录的请求内容。 |
data.items[].response_body_json |
string |
已记录的响应内容。 |
data.items[].status_code |
integer |
状态码。 |
data.items[].result |
string |
操作结果,success 或 failed。 |
data.items[].error_code |
string |
错误代码。 |
data.items[].error_message |
string |
错误信息。 |
data.items[].duration_ms |
integer |
操作耗时,单位为毫秒。 |
data.items[].client_ip |
string |
客户端 IP。 |
data.items[].user_agent |
string |
客户端标识。 |
data.items[].request_id |
string |
请求 ID。 |
data.items[].action_type |
string |
操作类型。 |
data.items[].resource_type |
string |
资源类型。 |
data.items[].resource_id |
string |
资源 ID。 |
data.items[].resource_name |
string |
资源名称。 |
data.items[].operation_summary |
string |
操作摘要。 |
data.items[].metadata_json |
string |
附加信息。 |
data.items[].created_at |
string |
日志创建时间。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
错误代码。 |
msg |
string |
错误信息。 |
data |
null |
— |
后续操作¶
需要先了解成功和失败操作的数量时,使用查看操作日志概览。