列出请求日志

OpenAPI 契约

方法
GET
路径
/api/v1/request-logs
认证
jwtBearer (bearer) OR automationKey (bearer)
响应状态
200 400 401 403 429 500
请求与响应 Schema
JSON
{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Request log page",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestLogPageResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

GET /api/v1/request-logs 接受 JWT 或带 analytics:read 的 nfy_ 密钥,返回当前认证账户已记录 API 调用的分页列表,按时间从新到旧排列。page 默认为 0;size 默认为 20,并限制在 1..100。

可使用 search(匹配路径或查询字符串)、可重复的 method 和 status 过滤条件、statusClass(2xx、4xx 或 5xx)、带 * 通配符的 path 模式、apiKeyId、minLatencyMs/maxLatencyMs,以及 from/to 时间窗口来缩小结果范围。每条记录包含所使用的 API 密钥(id 和前缀)、认证方式、方法、路径、经过脱敏的查询字符串、状态码、延迟、客户端 IP、截断后的 User-Agent、所属用户 id,以及创建时间。

http
GET /api/v1/request-logs?page=0&size=20&statusClass=4xx
Authorization: Bearer <access token>