> ## Documentation Index > Fetch the complete documentation index at: https://test-8ad8522e-feat-ai-sre.mintlify.site/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 /status-page/change/create 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: '' - name: On-call/标签增强 description: 自定义字段、富化规则及数据映射（映射规则、映射数据、映射 API）管理。 - name: On-call/分析看板 description: '' - name: On-call/状态页 description: '' - name: On-call/变更管理 description: '' paths: /status-page/change/create: post: tags: - On-call/状态页 summary: 创建状态页事件 description: 在状态页上创建新的故障或维护事件。 operationId: statusPageChangeCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateStatusPageChangeRequest' example: page_id: 5750613685214 type: incident title: Web Console Degraded Performance description: >- We are investigating degraded performance affecting the web console. status: investigating start_at_seconds: 1712000000 notify_subscribers: true updates: - status: investigating description: >- We are currently investigating an issue affecting some users. component_changes: - component_id: 01KC3GAZ6ZJE40H55GM31RPWZE status: degraded responses: '200': description: 成功 content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/StatusPageChangeCreateResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: change_id: 6294539747131 change_name: API Test Incident '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: CreateStatusPageChangeRequest: type: object description: 创建状态页故障或维护事件所需的参数。首条更新必须包含 `component_changes` 以声明受影响组件;回溯事件至少需要 2 条更新。 required: - page_id - type - title - description - status - updates properties: page_id: type: integer format: int64 description: 状态页 ID，可通过 `GET /status-page/list` 获取。 type: type: string enum: - incident - maintenance description: 事件类型：`incident` 故障，`maintenance` 计划维护。 title: type: string maxLength: 255 description: 事件标题,最多 255 个字符。 description: type: string description: 事件描述（支持 Markdown），必填，不能为空。 status: type: string enum: - investigating - identified - monitoring - resolved - scheduled - ongoing - completed description: >- 事件初始状态。故障事件支持 `investigating`/`identified`/`monitoring`/`resolved`;维护事件支持 `scheduled`/`ongoing`/`completed`。 start_at_seconds: type: integer format: int64 description: >- 事件开始时间（Unix 秒）。存储的开始时间始终以第一条更新的 `at_seconds` 为准（该字段缺省时取当前时间）；对于开启 `auto_update_by_schedule` 的维护事件，本字段用于调度自动切换为 `ongoing` 的任务。 responders: type: array items: type: integer format: int64 description: 事件负责成员的 ID 列表。 linked_changes: type: array items: type: string description: 关联的事件 ID 列表(相关故障、发布等)。 close_at_seconds: type: integer format: int64 description: >- 事件结束时间（Unix 秒），必须大于或等于第一条更新的 `at_seconds`。回溯事件用它表示结束时间；对于开启 `auto_update_by_schedule` 的维护事件，它用于调度自动切换为 `completed` 的任务，且距当前时间不能超过 30 天。 updates: type: array items: type: object description: 时间线更新条目。 properties: update_id: type: string description: 更新 ID。创建时由服务端生成;回溯历史更新时可手动指定。 at_seconds: type: integer format: int64 description: 更新时间戳（Unix 秒）。第一条更新缺省或为 0 时取当前时间。 status: type: - string - 'null' enum: - investigating - identified - monitoring - resolved - scheduled - ongoing - completed description: >- 更新后的事件状态。若整体状态未变化可省略。前四个值仅适用于 incident 类型，后三个仅适用于 maintenance 类型。 | 值 | 含义 | |---|---| | `investigating` | 排查中（incident）。 | | `identified` | 已定位原因（incident）。 | | `monitoring` | 已修复，观察中（incident）。 | | `resolved` | 已解决（incident）。 | | `scheduled` | 已计划（maintenance）。 | | `ongoing` | 进行中（maintenance）。 | | `completed` | 已完成（maintenance）。 | description: type: - string - 'null' description: 更新说明(支持 Markdown)。 component_changes: type: array items: type: object required: - component_id - status properties: component_id: type: string description: 组件 ID，可通过 `GET /status-page/info` 获取。 status: type: string enum: - operational - degraded - partial_outage - full_outage - under_maintenance description: >- 组件新状态。故障事件支持 `operational`/`degraded`/`partial_outage`/`full_outage`;维护事件支持 `operational`/`under_maintenance`。 description: 本次更新应用的组件状态变更。 description: >- 时间线更新列表。至少传 1 条，且至少有一条必须包含 `component_changes`。即时事件一般只传一条；回溯事件需传入全部历史更新。 minItems: 1 notify_subscribers: type: boolean description: 是否通知订阅者本事件及其所有更新。 auto_update_by_schedule: type: boolean description: 仅维护事件:根据计划窗口自动推进状态。 is_retrospective: type: boolean 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 StatusPageChangeCreateResponse: type: object description: 创建状态页事件的结果。 required: - change_id - change_name properties: change_id: type: integer format: int64 description: 新创建的事件 ID。 change_name: type: string description: 事件标题（来自请求）。 ErrorResponse: type: object description: 错误响应结构。`error` 必填，`data` 不存在。 properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 description: 本次请求的唯一追踪 ID（trace ID），反馈问题时请提供该值以便检索日志。 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 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。 ````