检索 App Services 日志

获取 /groups/{groupId}/apps/{appId}/logs

路径参数

查询参数

  • co_id 字符串

    仅返回与给定请求关联 ID 关联的日志消息。

  • errors_only 布尔

    此字段的值无关紧要。如果包含在请求中,则此端点仅返回错误日志(即使该值设置为 false)。如果从请求中排除此字段,则此端点仅返回非错误日志。

  • user_id 字符串

    仅返回与给定 user_id 关联的日志消息。

  • start_date 字符串

    采用 ISO 8601 格式的日期和时间,且会从此时间(不含)开始返回结果。

  • end_date 字符串

    采用 ISO 8601 格式的日期和时间,且会从此日期和时间(含)停止返回结果。

  • 跳过 整型

    在将匹配日志条目包含在响应中之前要跳过的匹配日志条目的偏移量。

  • limit 整型

    要包含在响应中的日志条目的最大数量。如果查询匹配的日志数超过此数,则会按日期升序返回文档,直到达到限制为止。

    最小值为 1,最大值为 100。

  • 类型 字符串

    您希望检索的日志类型。

    值为 TRIGGER_FAILURE、TRIGGER_ERROR_HANDLER、DB_TRIGGER、AUTH_TRIGGER、SCHEDULED_TRIGGER、FUNCTION、SERVICE_FUNCTION、STREAM_FUNCTION、SERVICE_STREAM_FUNCTION、AUTH、WEBHOOK、ENDPOINT、 PUSH、API、API_KEY、GRAPHQL、SYNC_CONNECTION_START、SYNC_CONNECTION_END、SYNC_SESSION_START、SYNC_SESSION_END、SYNC_CLIENT_WRITE、SYNC_ERROR、SYNC_OTHER、SCHEMA_ADDITIVE_CHANGE、SCHEMA_GENERATION、SCHEMA_VALIDATION 或 LOG_FORWARDER。

响应

  • 200 application/json

    已成功检索。

    隐藏响应属性 显示响应属性 对象
    • logs 大量[对象]

      每个请求最多 100 个结果。

      不超过 100 个元素。

      以下之一:
    • nextEndDate 字符串 必需

      ISO 8601 格式的下一页日志条目的结束日期和时间。App Services会对匹配超过 100 个日志条目的查询结果集进行分页,并在分页响应中包含此字段。要获取最多包含 100 个条目的下一页,请在后续请求中将此值作为 end_date 参数传递。

    • nextSkip 整型 必需

      ISO 8601 格式的日志条目下一页的偏移量。MongoDB App Services会对匹配超过 100 个日志条目的查询结果集进行分页,并在分页响应中包含此字段,其中下一页上的第一个条目与此页面上最后一个条目具有相同的时间戳。要获取最多包含 100 个条目的下一页,请将此值(如果存在)作为 skip 参数在后续请求中传递。

GET /groups/{groupId}/apps/{appId}/logs
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/logs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
响应示例 (200)
{
  "logs": [
    {
      "_id": "63922bf071bdce7b19e14e76",
      "co_id": "63922bf071bdce7b19e14e75",
      "domain_id": "60c8f69884b0a73d14bb634b",
      "app_id": "60c8f69884b0a73d14bb634a",
      "group_id": "5b2ec426970199272441a214",
      "request_url": "/api/client/v2.0/app/test-for-now-vbwlr/auth/providers/anon-user/login",
      "request_method": "POST",
      "started": "2022-12-08T18:24:48.409Z",
      "completed": "2022-12-08T18:24:48.41Z",
      "type": "API"
    }
  ],
  "nextEndDate": "string",
  "nextSkip": 42
}