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

限制说明

使用说明

  • mapping_type 为 api 的富化规则会携带配置的 headers 发送 POST <url>,请求体为 JSON {"result_label_keys": [...], "event": {...}}(告警事件)。API 须返回 HTTP 200 和 {"result_labels": {"<label>": "<value>"}}。
  • url 必须使用 http 或 https;SaaS 环境下主机名不得解析到内网 IP。
  • timeout 是整个请求的超时秒数(1–3,默认 2);retry_count 是失败后的重试次数(0–1,默认 0)。
  • SaaS 环境下会拒绝以下敏感请求头(不区分大小写):Authorization、Proxy-Authorization、Cookie、X-Api-Key、X-Access-Token、X-Forwarded-For、X-Real-Ip、True-Client-Ip、X-Client-Ip、Host、X-Forwarded-Host、X-Forwarded-Proto、X-Internal-Id、X-User-Id、Transfer-Encoding、Upgrade、Connection。
  • api_name 在未删除的映射 API 中必须唯一;每个账户最多 50 个未删除的映射 API。team_id 非 0 时必须是已存在的团队。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json
api_name
string
必填

映射 API 名称,在未删除的映射 API 中唯一(最长 199 字符)。

Maximum string length: 199
url
string<uri>
必填

以 POST 调用的地址。须为 http 或 https URL,最长 500 字符;SaaS 环境下主机名不得解析到内网 IP。

Maximum string length: 500
description
string

可选描述,超过 500 字符会被静默截断。

insecure_skip_verify
boolean

是否跳过 TLS 证书验证,默认 false。

headers
object

自定义 HTTP 请求头。SaaS 模式下安全敏感的请求头名(authorization、cookie、x-forwarded-for 等)会被拒绝;键须为 RFC 7230 token 字符(最长 1024),值最长 4096 字符。

timeout
integer
默认值:2

整个请求的超时时间,单位秒(1–3)。不传或传 0 时为 2。

必填范围: 1 <= x <= 3
retry_count
integer
默认值:0

调用失败后的重试次数(0–1),默认 0。

必填范围: 0 <= x <= 1
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。