AI 助手
TRAE 智能问答助手
你好,我是 TRAE 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
TRAE IDE 里最热门的 Skill 是哪些?
如何创建自定义智能体?
如何配置 Rules?
文档反馈

获取 OpenAPI 调用日志

获取指定时间范围内,企业的 OpenAPI 调用日志。

所需权限

audit

请求说明

  • 请求方式:GET
  • 请求地址:{域名}/openapi/v1/audit/openapi-logs

注意事项

时间跨度最大为 90 天。

请求参数

请求头参数

Header 参数 是否必填 描述
Authorization 固定取值为 Bearer {access_token}。关于如何获取访问令牌,参考鉴权

查询参数

参数 类型 是否必填 默认值 描述
start_time int - 开始时间,Unix 秒级时间戳。
end_time int - 结束时间,Unix 秒级时间戳。
page int 1 需要获取的页数。
page_size int 50 每页返回的日志条数。取值范围:[1, 200]。
source_ip string - 按来源 IP 过滤日志。
api_path string - 按 API 路径过滤日志。

响应参数

该接口独有的响应参数如下,参数位于 data.items[] 数组中。通用响应参数参考此文档

参数 类型 描述
log_id string 日志 ID。
app_id string 脱敏后的应用 ID。
api_path string 请求路径。
http_method string HTTP 方法。
source_ip string 来源 IP。
status_code int HTTP 响应状态码。
operation_time int64 调用时间(秒时间戳)。

示例

请求示例

curl -X GET "https://{domain}/openapi/v1/audit/openapi-logs?start_time=1700000000&end_time=1700086400&page=1&page_size=50" \
  -H "Authorization: Bearer {access_token}"

响应示例

{
  "code": 0,
  "message": "success",
  "request_id": "req_xxx",
  "data": {
    "items": [
      {
        "log_id": "123",
        "app_id": "AK1234****5678",
        "api_path": "/openapi/v1/users",
        "http_method": "GET",
        "source_ip": "1.2.3.4",
        "status_code": 200,
        "operation_time": 1700000000
      }
    ],
    "pagination": {
      "page": 1,
      "page_size": 50,
      "total": 100,
      "total_pages": 2
    }
  }
}

错误码

若该接口的请求返回错误码,参考错误码文档进行排查。