> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt > Use this file to discover all available pages before exploring further. # 查询洞察故障列表 > 返回用于分析看板的故障分页列表，包含每条故障的处理效能指标。 ## 限制说明 | 项目 | 说明 | | ---- | ------------------------------ | | 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** | | 权限要求 | **分析看板查看**（`on-call`） | ## OpenAPI ````yaml /api-reference/on-call.openapi.zh.json post /insight/incident/list 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: On-call/故障管理 description: '' - name: On-call/协作空间 description: '' - name: On-call/告警管理 description: 查询、查看和处理告警，管理卡片视图与告警处理规则。 - name: On-call/集成中心 description: '' - name: On-call/IM 集成 description: IM 集成相关查询，例如查看哪些集成开启了作战室。 - name: On-call/值班排班 description: '' - name: On-call/日历管理 description: '' - name: On-call/通知模板 description: '' - name: On-call/标签增强 description: 自定义字段、富化规则及数据映射（映射规则、映射数据、映射 API）管理。 - name: On-call/分析看板 description: '' - name: On-call/状态页 description: '' - name: On-call/变更管理 description: '' paths: /insight/incident/list: post: tags: - On-call/分析看板 summary: 查询洞察故障列表 description: 返回用于分析看板的故障分页列表，包含每条故障的处理效能指标。 operationId: insightIncidentList requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InsightIncidentListRequest' example: start_time: 1712000000 end_time: 1712604800 p: 1 limit: 20 severities: - Critical responses: '200': description: 成功 content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/InsightIncidentListResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: total: 2 has_next_page: false items: - incident_id: 67ca560c381a4fedb664f5f8 title: CPU spike on prod-web-01 description: CPU usage exceeded 90% threshold team_id: 4295771902131 team_name: SRE Team channel_id: 4321322010131 channel_name: Production Alerts progress: Closed severity: Info created_at: 1741313548 closed_by: manually seconds_to_ack: 1052085 seconds_to_close: 1483880 engaged_seconds: 1052085 hours: work responders: - person_id: 3790925372131 assigned_at: 1741313548 acknowledged_at: 1742365633 person_name: alice email: alice@example.com assigned_to: person_ids: - 3790925372131 escalate_rule_id: '000000000000000000000000' layer_idx: 0 type: reassign labels: {} fields: {} notifications: 4 interruptions: 2 assignments: 2 reassignments: 1 acknowledgements: 1 escalations: 0 timeout_escalations: 0 manual_escalations: 0 creator_id: 3790925372131 creator_name: alice '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: InsightIncidentListRequest: allOf: - $ref: '#/components/schemas/InsightFilter' - type: object description: 故障分页列表请求。在 InsightFilter 基础上增加分页字段。 properties: p: type: integer minimum: 1 default: 1 description: 页码，从 1 开始，默认 1。 limit: type: integer minimum: 1 maximum: 100 default: 20 description: 每页条数，范围 1-100，默认 20。 search_after_ctx: type: string description: 上一页返回的游标 token，下一页请求时回传。 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 InsightIncidentListResponse: type: object properties: total: type: integer format: int64 description: 匹配的故障总数。 has_next_page: type: boolean search_after_ctx: type: string description: 用于翻下一页的游标 token，下次请求时通过 `search_after_ctx` 回传。 items: type: array items: $ref: '#/components/schemas/IncidentRawItem' InsightFilter: type: object description: >- 洞察与导出接口共享的过滤参数。`severities` 至多 3 项，team/channel/responder/incident 过滤条件每项至多 100 条，时间范围不能超过一年。 required: - start_time - end_time properties: start_time: type: integer format: int64 description: 起始时间，Unix 秒，必须大于 0。 end_time: type: integer format: int64 description: 结束时间，Unix 秒，必须大于 `start_time`。 team_ids: type: array items: type: integer format: int64 description: 按团队 ID 过滤，至多 100 项。 channel_ids: type: array items: type: integer format: int64 description: 按协作空间 ID 过滤，至多 100 项。 responder_ids: type: array items: type: integer format: int64 description: 按处理人员 ID 过滤，至多 100 项。 severities: type: array items: type: string enum: - Critical - Warning - Info - Ok description: 按严重程度过滤，至多 3 项。 incident_ids: type: array items: type: string pattern: ^[0-9a-fA-F]{24}$ description: 按故障 ID（MongoDB ObjectID）过滤，至多 100 项。 query: type: string description: 作用于故障标题与描述的全文关键字。 labels: type: object additionalProperties: type: string description: 标签过滤（精确匹配）。 fields: type: object additionalProperties: true description: 自定义字段过滤（精确匹配）。 orderby: type: string enum: - created_at description: 底层故障集合的排序字段。 asc: type: boolean description: 为 `true` 时升序，否则降序。 is_my_team: type: boolean description: 是否仅返回调用者所属团队的数据。若调用者无任何团队，返回空集合。 time_zone: type: string description: IANA 时区名（如 `Asia/Shanghai`），用于解释时间范围。默认使用账户时区。 seconds_to_close_from: type: integer format: int64 description: 解决时长下界（秒，包含）。 seconds_to_close_to: type: integer format: int64 description: 解决时长上界（秒，不包含）。两端同时设置时，必须大于 `seconds_to_close_from`。 seconds_to_ack_from: type: integer format: int64 description: 认领时长下界（秒，包含）。 seconds_to_ack_to: type: integer format: int64 description: 认领时长上界（秒，不包含）。两端同时设置时，必须大于 `seconds_to_ack_from`。 export_fields: type: array items: type: string enum: - incident_id - title - severity - progress - channel_id - channel_name - team_id - team_name - created_at - seconds_to_ack - seconds_to_close - closed_by - engaged_seconds - hours - notifications - interruptions - acknowledgements - assignments - reassignments - escalations - manual_escalations - timeout_escalations - assigned_to - responders - description - labels - fields - creator_id - creator_name description: 导出 CSV 时要包含的列键子集，至多 50 项。仅导出接口会读取。 description_html_to_text: type: boolean description: 导出时是否将描述列中的 HTML 标签转换为纯文本。 IncidentRawItem: type: object description: 分析看板故障列表返回的原始故障记录，附带每条故障的处理效能指标。 properties: incident_id: type: string pattern: ^[0-9a-fA-F]{24}$ title: type: string description: type: string team_id: type: integer format: int64 team_name: type: string channel_id: type: integer format: int64 channel_name: type: string progress: type: string description: 故障处理进度——`Triggered`、`Processing`、`Closed` 之一。 severity: type: string enum: - Critical - Warning - Info - Ok created_at: type: integer format: int64 closed_by: type: string enum: - auto - timeout - manually seconds_to_ack: type: integer format: int64 seconds_to_close: type: integer format: int64 engaged_seconds: type: integer format: int64 hours: type: string responders: type: array items: type: object description: 处理人员条目（结构详见故障模块）。 assigned_to: type: object description: 故障的当前分派目标。 properties: person_ids: type: array items: type: integer format: int64 description: 直接分派给该故障的成员 ID 列表。 escalate_rule_id: type: string pattern: ^[0-9a-fA-F]{24}$ description: 驱动分派的升级规则 ID（MongoDB ObjectID）。 escalate_rule_name: type: string description: 升级规则的显示名称。 layer_idx: type: integer description: 升级规则中的当前级别索引。 type: type: string enum: - assign - reassign - escalate - reopen description: 分派类型。 assigned_at: type: integer format: int64 description: 本次分派发生的时间戳（Unix 秒）。 id: type: string description: 内部分派记录 ID。 labels: type: object additionalProperties: type: string fields: type: object additionalProperties: true notifications: type: integer format: int64 interruptions: type: integer format: int64 assignments: type: integer format: int64 reassignments: type: integer format: int64 acknowledgements: type: integer format: int64 escalations: type: integer format: int64 timeout_escalations: type: integer format: int64 manual_escalations: type: integer format: int64 creator_id: type: integer format: int64 creator_name: type: string 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 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。 ````