跳转到主要内容
POST
导出洞察故障

限制说明

使用说明

  • 响应是 CSV 文件(Content-Type: application/octet-stream),不是 JSON 响应包。参数校验失败时,在写出任何 CSV 内容之前返回 JSON 错误。
  • 过滤条件与排序方式与 /insight/incident/list 相同。写出的行数超过 100,000 后停止导出。
  • start_time 会被推后到账户数据保留期内最早的日期;整个时间范围都早于该日期时请求会被拒绝。
  • export_fields 决定导出哪些列及其顺序:incident_id, title, severity, progress, channel_id, channel_name, team_id, team_name, created_at, alert_cnt, active_alert_cnt, alert_event_cnt, seconds_to_ack, seconds_to_close, closed_by, owner_id, owner_name, creator_id, creator_name, closer_id, closer_name, engaged_seconds, hours, notifications, interruptions, acknowledgements, ackers, assignments, reassignments, escalations, manual_escalations, timeout_escalations, assigned_to, raw_assigned_to, escalate_rule_name, responders, raw_responders, snooze_status, snoozed_before, ever_muted, frequency, is_rare, description, labels, fields。未知或重复的 key 会被拒绝;不传时导出除别名 owner_id、creator_id、closer_id、snoozed_before、is_rare 以外的全部列。
  • description_html_to_text 为 true 时去掉 description 列中的 HTML 标记。
  • 列名和格式化值依次使用请求语言、成员语言、账户语言。时间按 time_zone 渲染,未传时依次回退到账户时区、Asia/Shanghai。

授权

app_key
string
query
必填

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

请求体

application/json

洞察与导出接口共享的过滤参数。severities 至多 3 项,team/channel/responder/incident 过滤条件每项至多 100 条,时间范围不能超过一年。

start_time
integer<int64>
必填

起始时间,Unix 秒。必须大于 0。

end_time
integer<int64>
必填

结束时间,Unix 秒,必须大于 start_time。

team_ids
integer<int64>[]

按团队 ID 过滤,至多 100 项。

Maximum array length: 100
channel_ids
integer<int64>[]

按协作空间 ID 过滤,至多 100 项。

Maximum array length: 100
responder_ids
integer<int64>[]

按响应人成员 ID 过滤。用于 /insight/responder(返回哪些响应人)以及故障列表/导出(任一指定成员参与响应的故障);账户、团队、协作空间维度和 Top-K 接口忽略该字段。最多 100 个。

Maximum array length: 100
severities
enum<string>[]

按严重程度过滤:Critical、Warning、Info 或 Ok。最多 3 个。

Maximum array length: 3
可用选项:
Critical,
Warning,
Info,
Ok
incident_ids
string[]

按故障 ID(24 位十六进制)过滤。仅用于故障列表和故障导出。最多 100 个。

Maximum array length: 100
Pattern: ^[0-9a-fA-F]{24}$
query
string

对故障标题做子串匹配(SQL LIKE %query%)。

labels
object

标签过滤(精确匹配)。

fields
object

自定义字段过滤(精确匹配)。

orderby
enum<string>

故障列表的排序字段;仅支持 created_at(故障创建时间,默认)。用于 /insight/incident/list 和 /insight/incident/export。

可用选项:
created_at
asc
boolean

为 true 时升序,否则降序(默认)。用于故障列表和故障导出;/insight/alert/topk-by-label 有自己的 asc。

is_my_team
boolean

只看调用者所在团队的数据(同时传 team_ids 时取交集)。交集为空或调用者不属于任何团队时,结果为空。

time_zone
string

用于切分 aggregate_unit 时间桶的 IANA 时区(如 Asia/Shanghai、UTC);EST 之类的缩写以及 Etc/GMT±N 会被拒绝。默认 UTC。/insight/incident/export 用它渲染时间,未传时依次回退到账户时区、Asia/Shanghai。

seconds_to_close_from
integer<int64>

解决时长下界(秒,包含)。

必填范围: x >= 0
seconds_to_close_to
integer<int64>

解决时长上界(秒,不包含)。两端同时设置时必须大于 seconds_to_close_from:故障列表和导出会返回 InvalidParameter,其他接口返回空结果。

必填范围: x >= 0
seconds_to_ack_from
integer<int64>

认领时长下界(秒,包含)。

必填范围: x >= 0
seconds_to_ack_to
integer<int64>

认领时长上界(秒,不包含)。两端同时设置时必须大于 seconds_to_ack_from:故障列表和导出会返回 InvalidParameter,其他接口返回空结果。

必填范围: x >= 0
export_fields
string[]

导出 CSV 的列 key 列表,按给定顺序输出;未知或重复的 key 会被拒绝。各导出接口支持的 key 集合不同,见对应接口的描述。仅导出接口使用;最多 50 个。

Maximum array length: 50
description_html_to_text
boolean

导出时是否将描述列中的 HTML 标签转换为纯文本。

include_ever_muted
boolean

是否包含曾被收敛的故障;默认不包含。

响应

成功

CSV 文件(Content-Type: application/octet-stream,Content-Disposition: attachment; filename*=UTF-8''incident_export_yyyyMMdd_HHmmss.csv)。第一行为本地化的列名。