跳转到主要内容
POST
创建错误采集规则

限制说明

使用说明

  • 命中的错误仍会入库、可正常查询,只是不会被归入任何问题,且其 issue_grouping_excluded 字段为 true。
  • 规则匹配的是 SDK 上报的原始错误类型和错误信息,发生在服务端解析堆栈之前。
  • filters 中每个条件的 key 必须是受支持的 error.* 字段或 context.* 路径;key 不受支持、操作符无效、vals 为空,或正则/CIDR/数值模式无效时,返回 InvalidParameter。
  • 新建规则的初始状态为 enabled;如需创建后即处于停用状态,需再调用一次 disable。
  • 每次写操作都会先把应用变更前的完整规则集合保存为一个新的历史版本。
  • 采集端按应用缓存已启用的规则,缓存有效期 5 秒,因此变更最多约 5 秒后对新上报的错误生效。
  • 需要对该应用有编辑权限(账户所有者或管理员、应用创建者、应用所属团队的成员),否则返回 AccessDenied;application_id 不存在时返回 ResourceNotFound。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

创建错误采集规则的入参。

application_id
string
必填

RUM 应用 ID,可通过 POST /rum/application/list 获取。

filters
object[][]
必填

用于匹配错误的过滤条件(OR-of-ANDs 结构)。命中的错误仍会入库,但不会被归入任何问题。

AND 组:仅当组内每个条件都匹配时,该组才算命中。

rule_name
string
必填

规则名称,1-128 个字符。

Required string length: 1 - 128
description
string

规则描述,最多 512 个字符,不传时为空字符串。

Maximum string length: 512

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

新建规则的标识信息。