> ## 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`） | ## 使用说明 * 默认按最新事件优先返回；设置 `asc=true` 可按最早事件优先读取。 * 使用上次响应中的 `search_after_ctx` 搭配 `limit` 获取下一页。 * 也支持通过 `p` 使用页码分页，但 `p * limit` 必须在 10,000 条以内。 * 单条告警可能累积大量原始事件，热点告警建议优先使用游标分页。 ## OpenAPI ````yaml /api-reference/on-call.openapi.zh.json post /alert/event/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: /alert/event/list: post: tags: - On-call/告警管理 summary: 查询告警事件列表 description: 通过游标或页码分页返回指定告警的原始事件。 operationId: alert-read-event-list requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlertEventListRequest' example: alert_id: 663a1b2c3d4e5f6789abcdef limit: 20 responses: '200': description: 成功 content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/AlertEventListResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: total: 57 has_next_page: true search_after_ctx: 663a1b2c3d4e5f6789abc001 items: - event_id: 663a1b2c3d4e5f6789abc001 alert_id: 663a1b2c3d4e5f6789abcdef title: CPU 使用率 > 90% event_severity: Critical event_status: Critical event_time: 1712650000 labels: host: web-01 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: AlertEventListRequest: type: object required: - alert_id properties: alert_id: type: string pattern: ^[0-9a-fA-F]{24}$ description: 告警 ID（MongoDB ObjectID）。 asc: type: boolean default: false description: 为 true 时按最早事件优先返回；默认按最新事件优先返回。 limit: type: integer format: int64 minimum: 0 maximum: 100 default: 20 description: 分页大小，默认 20，最大 100。 p: type: integer format: int64 minimum: 0 default: 1 description: 页码，从 1 开始；未传 `search_after_ctx` 时生效。 search_after_ctx: type: string pattern: ^[0-9a-fA-F]{24}$ description: 上一页响应返回的游标；传入后使用游标分页而非页码分页。 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 AlertEventListResponse: type: object required: - items - total - has_next_page properties: items: type: array items: $ref: '#/components/schemas/AlertEventItem' description: 按请求顺序返回的原始告警事件。 total: type: integer format: int64 description: 命中的事件总数。 has_next_page: type: boolean description: 是否还有下一页。 search_after_ctx: type: string description: 下一页请求可作为 `search_after_ctx` 传入的游标。 AlertEventItem: type: object description: 单条原始告警事件。 properties: event_id: type: string pattern: ^[0-9a-fA-F]{24}$ description: 事件 ID（MongoDB ObjectID）。 alert_id: type: string pattern: ^[0-9a-fA-F]{24}$ description: 父告警 ID（MongoDB ObjectID）。 account_id: type: integer format: int64 description: 账户 ID。 channel_id: type: integer format: int64 description: 事件路由到的协作空间 ID。 integration_id: type: integer format: int64 description: 产生该事件的集成 ID。 integration_type: type: string description: 产生该事件的集成类型/插件键。 data_source_id: type: integer format: int64 description: 已废弃，请使用 `integration_id`。 title: type: string description: 事件标题。 title_rule: type: string description: 用于从标签派生 `title` 的标题模板。 description: type: string description: 事件描述。 alert_key: type: string description: 用于将事件合并到告警的去重键。 event_severity: type: string enum: - Critical - Warning - Info - Ok description: 事件严重程度。 event_status: type: string enum: - Critical - Warning - Info - Ok description: 事件状态。 event_time: type: integer format: int64 description: 事件时间戳，Unix 时间戳（秒）。 labels: type: object additionalProperties: type: string description: 标签键值对。 images: type: array items: $ref: '#/components/schemas/AlertImage' description: 事件附加的图片。 created_at: type: integer format: int64 description: 记录创建时间，Unix 时间戳（秒）。 updated_at: type: integer format: int64 description: 记录更新时间，Unix 时间戳（秒）。 deleted_at: type: integer format: int64 description: 软删除时间戳（秒），未删除时为 0。 ErrorResponse: type: object description: 错误响应结构。`error` 必填，`data` 不存在。 properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: $ref: '#/components/schemas/DutyError' required: - request_id - error AlertImage: type: object description: 告警或事件的图片附件。 required: - src properties: href: type: string description: 点击图片时的跳转链接（可选）。 src: type: string description: 图片源地址或内部引用（以 `img_` 或 `http` 开头）。 alt: type: string description: 替代文本。 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 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。 ````