跳转到主要内容
POST
创建映射规则

限制说明

使用说明

  • 需要专业版或更高版本的订阅,否则返回 NoLicense。
  • schema_name 在账户未删除的映射规则中必须唯一。
  • source_labels(1–3 个)组成查找键,result_labels(1–10 个)在匹配后写入告警。标签名须匹配 ^[a-zA-Z_][a-zA-Z0-9_]*$,列表内不得重复,两个列表不得重叠。两个列表创建后都不能修改。
  • 每个账户默认最多 20 个未删除的映射规则(部分账户上限更高),超出返回 InvalidParameter。
  • 同一账户并发创建会返回 RequestTooFrequently。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json
schema_name
string
必填

映射规则名称,在账户未删除的映射规则中唯一(最长 39 字符)。

Maximum string length: 39
source_labels
string[]
必填

查找键标签名(1–3 个)。每个须匹配 ^[a-zA-Z_][a-zA-Z0-9_]*$;列表内不得重复,且不得与 result_labels 重叠。

Required array length: 1 - 3 elements
Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
result_labels
string[]
必填

匹配后写入的输出标签名(1–10 个)。每个须匹配 ^[a-zA-Z_][a-zA-Z0-9_]*$;列表内不得重复,且不得与 source_labels 重叠。

Required array length: 1 - 10 elements
Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
description
string

可选描述(最多 500 个字符)。

Maximum string length: 500
team_id
integer<int64>

所属团队 ID,可通过 POST /team/list 获取。不传或传 0 表示不属于任何团队;非 0 时须为已存在的团队。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。