> ## 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.

# 更新错误采集规则

> 更新错误采集规则的名称、描述或过滤条件。

## 限制说明

| 项目   | 说明                           |
| ---- | ---------------------------- |
| 速率限制 | 每个账户 **300 次/分钟**；**20 次/秒** |
| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用    |

## 使用说明

* 仅更新请求中出现的字段，未传入的字段保持原值不变。
* 不传任何可更新字段时视为空操作，仍会返回成功。
* 若 `rule_id` 在该 `application_id` 下不存在，返回 `ResourceNotFound`。
* 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。


## OpenAPI

````yaml /api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/update
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: RUM/应用管理
    description: 管理前端性能监控（RUM）应用。
  - name: RUM/RUM 数据查询
    description: 对 RUM 事件数据执行分析查询。
  - name: RUM/RUM 问题跟踪
    description: 查询和管理 RUM 异常追踪 Issue 及预设严重性规则。
  - name: RUM/RUM 自定义字段
    description: 查询 RUM 自定义字段及其值分布，用于构建分析过滤条件。
  - name: RUM/RUM Sourcemap
    description: 管理和查询用于 Browser、Android、iOS 错误符号化的 RUM Sourcemap 文件。
  - name: RUM/Session replay
    description: 查询 RUM 会话的回放元数据与录制分段。
  - name: RUM/错误采集规则
    description: 配置和查看决定 RUM 应用采集哪些错误的规则，并可查看其编辑历史。
  - name: RUM/Issue 预设严重性规则
    description: 管理按应用配置的预设严重性规则，用于为匹配的前端错误指定严重级别，并管理其评估顺序与变更历史。
  - name: RUM/资源
    description: 查询账户的 RUM 资源记录及当前用量。
paths:
  /rum/error-ingestion/rules/update:
    post:
      tags:
        - RUM/错误采集规则
      summary: 更新错误采集规则
      description: 更新错误采集规则的名称、描述或过滤条件。
      operationId: rum-error-ingestion-rules-update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RumErrorIngestionUpdateRequest'
            example:
              application_id: WoyQQ3BohkdtPivubEvE8o
              rule_id: 9spXEVoMeZWujjz25yrgTe
              description: Now also excludes staging traffic.
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/RumErrorIngestionEmptyResponse'
              example:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                data: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    RumErrorIngestionUpdateRequest:
      type: object
      description: 对已有错误采集规则的部分字段更新，未传入的字段保持不变。
      required:
        - application_id
        - rule_id
      properties:
        application_id:
          type: string
          description: RUM 应用 ID，可通过 `POST /rum/application/list` 获取。
        rule_id:
          type: string
          description: 要更新的规则 ID，可通过 `POST /rum/error-ingestion/rules/list` 获取。
        rule_name:
          type:
            - string
            - 'null'
          description: 新的规则名称，1-128 个字符；不传则保持不变。
          minLength: 1
          maxLength: 128
        description:
          type:
            - string
            - 'null'
          description: 新的规则描述，最多 512 个字符；不传则保持不变。
          maxLength: 512
        filters:
          $ref: '#/components/schemas/RumErrorIngestionOrFilters'
          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
    RumErrorIngestionEmptyResponse:
      type: object
      description: 成功时返回的空响应体。
      properties: {}
    RumErrorIngestionOrFilters:
      type: array
      description: OR-of-ANDs 过滤器集合：外层数组为 OR，一个错误只要匹配其中任意一个内层 AND 组即视为命中该规则。
      items:
        type: array
        description: AND 组：仅当组内每个条件都匹配时，该组才算命中。
        items:
          $ref: '#/components/schemas/RumErrorIngestionFilterCondition'
    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
    RumErrorIngestionFilterCondition:
      type: object
      description: 单条过滤条件，匹配错误的某一个字段。
      required:
        - key
        - oper
        - vals
      properties:
        key:
          type: string
          description: >-
            字段
            key。取值范围：`error.usr_id`、`error.usr_email`、`error.error_type`、`error.error_message`、`error.error_stack`、`error.view_url`、`error.env`、`error.version`、`error.service`、`error.browser_name`、`error.browser_version`、`error.fingerprint`、`error.is_crash`，或以
            `context.` 为前缀、最多三级嵌套的自定义上下文字段。
        oper:
          type: string
          enum:
            - IN
            - NOTIN
          description: 匹配方式：`IN` 表示字段值命中 `vals` 中任意一项即匹配，`NOTIN` 表示都不命中才匹配。
        vals:
          type: array
          description: >-
            待匹配的取值列表，至少 1 项。每项为精确字符串，或使用通配符（`*`/`?`）、正则（以 `/` 包裹）、`cidr:`
            前缀、`num:lt|le|gt|ge:` 前缀表示的特殊匹配模式。
          minItems: 1
          items:
            type: string
    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
        时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

````