跳转到主要内容
POST
查询历史相似故障

限制说明

使用说明

  • 需要专业版及以上版本,否则返回 NoLicense。
  • 候选范围:同一协作空间内、开始时间在参考故障开始前 30 天内、语义相似度超过该协作空间相似度阈值的已关闭故障。
  • 排序规则:root_cause 与 resolution 文本越长越靠前;相同时 score 越高越靠前;再相同时 start_time 越新越靠前。
  • limit 不传或为 0 时默认返回 5 条。
  • items 为空数组表示没有找到相似故障,或参考故障尚未建立相似度索引。
  • 参考故障必须属于某个协作空间,否则返回 InvalidParameter。

授权

app_key
string
query
必填

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

请求体

application/json

查询历史相似故障的参数。

incident_id
string
必填

基准故障 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$
limit
integer<int64> | null
默认值:5

返回的相似故障最大数量。

必填范围: 0 <= x <= 100

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

历史相似故障列表,按相关性排序。