> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt > Use this file to discover all available pages before exploring further. # 数据源诊断 > 执行同步诊断查询(Loki/VictoriaLogs 使用 `log_patterns`,Prometheus 使用 `metric_trends`)。Flashduty AI SRE 用于日志模式聚类与时间序列趋势分析。长耗时——最长可达 35 秒。 ## 调用限制 | 项 | 值 | | ---- | ------------------------------ | | 速率限制 | **600 次/分钟**;**10 次/秒** 每账户 | | 权限 | 任意有效的 `app_key`(只读;不受特定权限分类约束) | ## 使用说明 * 这是诊断 / RCA 接口,而非原始数据查询接口——如需查看明细行,请配合 `/monit/query/rows` 使用。 * `operation` 由 `ds_type` 推导:`loki` / `victorialogs` → `log_patterns`,`prometheus` → `metric_trends`。其他数据源必须显式传入 `operation`。 * `methods` 选择要执行的分析方法;省略时,`log_patterns` 默认为 `pattern_snapshot + pattern_compare(previous_window)`,`metric_trends` 默认为 `single_window_shape + window_compare(previous_window)`。 * `time_range` 单位为 Unix 秒;缺失或无效时默认最近 15 分钟;窗口宽度超过 6 小时将被拒绝。 * 请求通过 WebSocket 转发至 `monit-edge`。长耗时:边缘侧执行可能耗时约 30 秒,叠加 webapi 开销。客户端超时应至少设置为 **35 秒**。 * `options.*` 由边缘侧设置上限(`max_logs_scanned` ≤ 50 000,`max_patterns` ≤ 50,`examples_per_pattern` ≤ 3,`step_seconds` ∈ \[15, 300],`max_series` ≤ 200,`topk` ≤ 50,`timeout_seconds` ≤ 30)。 * 与 `/monit/query/rows` 一样存在两层错误:边缘侧执行错误以 HTTP 200 返回,响应体中带 `error` 对象——务必同时检查两层。 * 日志样例在返回前会经过基础脱敏处理,响应中会带 `warnings: ["examples redacted"]`。不可作为原始日志使用。 ## OpenAPI ````yaml /api-reference/monitors.openapi.zh.json post /monit/query/diagnose openapi: 3.1.0 info: title: Flashduty 开放 API description: >- Flashduty 事件管理平台的公开 HTTP API —— 覆盖故障、通知模板、协作空间、值班排班、监控、RUM、以及平台管理。每次调用都需在 query 中携带 `app_key`，该 key 在 Flashduty 控制台 账户 → APP Key 中签发。所有响应使用统一结构：成功时为 `{ request_id, data }`，失败时为 `{ request_id, error }`。 version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: Monitors/告警规则 description: 创建、管理和导出监控告警规则，查询规则统计和审计历史。 - name: Monitors/告警数据源 description: 管理监控告警规则用于查询指标的数据源。 - name: Monitors/规则集 description: 管理 Monitors 规则仓库中的共享规则集，规则集可在账户内或公开共享。 - name: Monitors/诊断分析 description: Flashduty AI SRE 使用的诊断与查询接口——数据源即席查询、日志/指标诊断,以及监控对象侧的工具调用。 - name: Monitors/通用工具 description: 监控服务开通及数据预览工具。 paths: /monit/query/diagnose: post: tags: - Monitors/诊断分析 summary: 数据源诊断 description: >- 执行同步诊断查询(Loki/VictoriaLogs 使用 `log_patterns`,Prometheus 使用 `metric_trends`)。Flashduty AI SRE 用于日志模式聚类与时间序列趋势分析。长耗时——最长可达 35 秒。 operationId: monit-read-query-diagnose requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DiagnoseRequest' example: account_id: 10001 ds_type: victorialogs ds_name: vmlogs-read operation: log_patterns time_range: start: 1776847544 end: 1776849344 methods: - name: pattern_snapshot - name: pattern_compare baseline: same_window_yesterday input: query: _stream:{status='500'} options: max_logs_scanned: 10000 max_patterns: 20 examples_per_pattern: 2 timeout_seconds: 25 responses: '200': description: 成功 content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/DiagnoseResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: operation: log_patterns ds_type: victorialogs ds_name: vmlogs-read query: _stream:{status='500'} window: start: 1776847544 end: 1776849344 results: - method: pattern_snapshot window: start: 1776847544 end: 1776849344 summary: logs_scanned: 405 baseline_logs_scanned: 0 current_truncated: false baseline_truncated: false patterns_total: 2 returned_patterns: 2 new_patterns: 0 surging_patterns: 0 surging_threshold: change_ratio_min: 3 count_min: 5 patterns: - pattern_hash: 239fa5da template: POST /api/v/orders/ HTTP/ count: 213 first_seen: 1776847562 last_seen: 1776849336 severity: unknown approximate: false sources: - field: pod value: order-api-7f69d8d9b6-m4x9n count: 130 examples: - POST /api/v/orders/ HTTP/ warnings: - examples redacted '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: DiagnoseRequest: type: object required: - ds_type - ds_name - input properties: account_id: type: integer format: int64 description: 可选的一致性校验。若提供,必须等于已认证账户。 ds_type: type: string description: >- 数据源类型。`log_patterns` 支持 `loki` 与 `victorialogs`;`metric_trends` 支持 `prometheus`。 ds_name: type: string description: 租户下已配置的数据源名称。 operation: type: string enum: - log_patterns - metric_trends description: >- 诊断操作类型。省略时根据 `ds_type` 推断(loki / victorialogs → `log_patterns`,prometheus → `metric_trends`)。其他数据源必须显式指定。 time_range: type: object description: 诊断窗口,Unix 秒。缺失或无效时默认最近 15 分钟;窗口宽度超过 6 小时将被拒绝。 properties: start: type: integer format: int64 description: 窗口起点,Unix 秒。 end: type: integer format: int64 description: 窗口终点,Unix 秒。 methods: type: array description: >- 要执行的诊断方法。省略时,`log_patterns` 默认为 `pattern_snapshot + pattern_compare(previous_window)`,`metric_trends` 默认为 `single_window_shape + window_compare(previous_window)`。 items: type: object properties: name: type: string description: >- `log_patterns` 支持 `pattern_snapshot`、`pattern_compare`。`metric_trends` 支持 `single_window_shape`、`window_compare`。 baseline: type: string enum: - previous_window - same_window_yesterday - same_window_last_week description: 仅对 compare 类方法有意义。默认 `previous_window`。 input: type: object required: - query properties: query: type: string description: >- 查询表达式。`log_patterns` 使用 LogQL / VictoriaLogs 查询语法;`metric_trends` 使用 PromQL。 options: type: object description: 执行选项,所有值均受 monit-edge 上限约束。 properties: max_logs_scanned: type: integer description: 单窗口日志扫描上限。默认 10 000,硬上限 50 000。 max_patterns: type: integer description: 返回的最大模式数。默认 20,硬上限 50。 examples_per_pattern: type: integer description: 每个模式返回的脱敏样例最大条数。默认 2,硬上限 3。 step_seconds: type: integer description: '`metric_trends` 的 query_range 步长。默认 60,取值范围 [15, 300]。' max_series: type: integer description: '`metric_trends` 考察的最大序列数。默认 50,硬上限 200。' topk: type: integer description: '`metric_trends` 返回的显著序列最大数量。默认 10,硬上限 50。' timeout_seconds: type: integer description: 边缘侧诊断超时,单位秒。默认 25,硬上限 30。 SuccessEnvelope: type: object description: >- 成功响应结构。2xx 响应中 `request_id` 标识本次调用（同时出现在 `Flashcat-Request-Id` 响应头中），`data` 为接口业务 payload。失败响应使用不同结构，参见 `ErrorResponse`。 properties: request_id: type: string description: 本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。 example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: 每个接口自己的业务 payload，详见各接口的 200 响应 schema。 required: - request_id - data DiagnoseResponse: type: object description: >- 按 operation 区分的诊断结果。请先检查 `operation`,再处理 `results[]`。`results[].patterns`(对应 `log_patterns`)与 `results[].series`(对应 `metric_trends`)的结构因 operation 不同而不同;完整 schema 见 monit-webapi diagnose-api 文档。 properties: operation: type: string enum: - log_patterns - metric_trends ds_type: type: string ds_name: type: string query: type: string description: 从请求中回显的查询字符串。 window: type: object properties: start: type: integer format: int64 end: type: integer format: int64 results: type: array description: 与请求中的 `methods[]` 一一对应,顺序一致。 items: type: object properties: method: type: string description: >- `log_patterns` 对应 `pattern_snapshot` / `pattern_compare`;`metric_trends` 对应 `single_window_shape` / `window_compare`。 baseline: type: string description: 仅在 compare 类方法中出现。 window: type: object properties: start: type: integer format: int64 end: type: integer format: int64 baseline_window: type: object description: 仅在 compare 类方法中出现。 properties: start: type: integer format: int64 end: type: integer format: int64 summary: type: object description: >- 该方法的聚合摘要。结构因方法而异:`log_patterns` 包含 logs_scanned、patterns_total、surging_threshold 等;`metric_trends` 包含 series_total、data_quality、observations 等。 patterns: type: array description: >- 仅 `log_patterns` 返回。按 RCA 优先级排序;每项包含 pattern_hash、template、count、severity、sources、examples,以及(compare 情形下)baseline_count、change_ratio、is_new、is_gone。 items: type: object series: type: array description: >- 仅 `metric_trends` 返回。显著序列,带 current / baseline / change / notable_period 字段。 items: type: object warnings: type: array items: type: string description: 单方法的提示信息(如 `examples redacted`、采样提示等)。 ErrorResponse: type: object description: 错误响应结构。`error` 必填，`data` 不存在。 properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: $ref: '#/components/schemas/DutyError' required: - request_id - error DutyError: type: object description: 响应结构中的错误 payload，仅在非 2xx 响应时出现。 properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: 用户可读的错误描述，语言会跟随调用方的 Accept-Language。可能包含字段名、ID 等请求上下文。 example: The specified parameter template_id is not valid. required: - code - message ErrorCode: type: string description: >- Flashduty 错误码枚举。每个失败响应的 `error.code` 都是下列稳定值之一，HTTP 状态码仅作参考。 | 错误码 | HTTP | 含义 | |---|---|---| | `OK` | 200 | 保留值，正常错误响应不会返回。 | | `InvalidParameter` | 400 | 必填参数缺失或未通过校验。 | | `BadRequest` | 400 | 通用的 400 错误，通常是请求本身不合法。 | | `InvalidContentType` | 400 | 请求头 `Content-Type` 不是 `application/json`。 | | `ResourceNotFound` | 400 | 目标资源不存在。注意 HTTP 状态码是 400 而非 404（历史设计）。 | | `NoLicense` | 400 | 功能需要有效授权，但未找到可用的 license。 | | `ReferenceExist` | 400 | 该资源仍被其他实体引用，无法删除。 | | `Unauthorized` | 401 | `app_key` 缺失、无效或已过期。 | | `BalanceNotEnough` | 402 | 账户余额不足，无法执行需要计费的操作。 | | `AccessDenied` | 403 | 身份认证通过，但 RBAC 权限不足以执行该操作。 | | `RouteNotFound` | 404 | 请求的 URL 路径不是已知路由。 | | `MethodNotAllowed` | 405 | 当前路径不接受所使用的 HTTP 方法。 | | `UndonedOrderExist` | 409 | 账户存在未完成的订单，请稍后重试。 | | `RequestLocked` | 423 | 因连续失败被临时锁定。 | | `EntityTooLarge` | 413 | 请求体超过允许的最大长度。 | | `RequestTooFrequently` | 429 | 命中限流（全局、账户级或集成级）。 | | `RequestVerifyRequired` | 428 | 操作需要二次验证码，但未提供。 | | `DangerousOperation` | 428 | 危险操作，需要进行 MFA 验证。 | | `InternalError` | 500 | 服务端未预期错误。反馈问题请附上 `request_id`。 | | `ServiceUnavailable` | 503 | 后端依赖不可用，请稍后重试。 | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: 保留值，正常错误响应不会返回。 InvalidParameter: 必填参数缺失或未通过校验。 BadRequest: 通用的 400 错误，通常是请求本身不合法。 InvalidContentType: 请求头 `Content-Type` 不是 `application/json`。 ResourceNotFound: 目标资源不存在。注意 HTTP 状态码是 400 而非 404（历史设计）。 NoLicense: 功能需要有效授权，但未找到可用的 license。 ReferenceExist: 该资源仍被其他实体引用，无法删除。 Unauthorized: '`app_key` 缺失、无效或已过期。' BalanceNotEnough: 账户余额不足，无法执行需要计费的操作。 AccessDenied: 身份认证通过，但 RBAC 权限不足以执行该操作。 RouteNotFound: 请求的 URL 路径不是已知路由。 MethodNotAllowed: 当前路径不接受所使用的 HTTP 方法。 UndonedOrderExist: 账户存在未完成的订单，请稍后重试。 RequestLocked: 因连续失败被临时锁定。 EntityTooLarge: 请求体超过允许的最大长度。 RequestTooFrequently: 命中限流（全局、账户级或集成级）。 RequestVerifyRequired: 操作需要二次验证码，但未提供。 DangerousOperation: 危险操作，需要进行 MFA 验证。 InternalError: 服务端未预期错误。反馈问题请附上 `request_id`。 ServiceUnavailable: 后端依赖不可用，请稍后重试。 example: InvalidParameter responses: BadRequest: description: 请求非法 — 通常是参数缺失或格式不正确。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: app_key 缺失或无效。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. TooManyRequests: description: 命中限流。可能是全局 API 限流、账户级限流或集成级限流。限流按账户聚合。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: 服务端未预期错误。反馈问题时请携带 request_id。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- 在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。 ````