自定义操作

配置故障自定义操作，允许您在故障排查期间，快速调用外部接口，实现故障自愈、信息丰富等任何自定义操作。

一、创建操作

点击添加自定义操作集成

配置操作名称，此名称将以按钮的形式体现在故障详情中

配置协作空间，可以配置多个，但每个协作空间至多添加三个自定义操作

配置 Endpoint、自定义 Headers

保存，完成

二、推送描述

请求方式

POST, Content-Type:"application/json"

请求 Payload：

字段	类型	必含	释义
event_time	int64	是	事件发生`毫秒时间戳`
event_type	string	是	事件类型，固定值`i_custom`
event_id	string	是	事件 ID，`同一个事件可能因为超时等原因重试多次，接收方需要能够去重`
person	Person	否	操作人，仅人为动作时存在
incident	Incident	是	故障详情

Person:

字段	类型	必含	释义
person_id	int64	是	人员 ID
person_name	string	是	人员名称
email	string	是	邮件地址

Responder:

字段	类型	必含	释义
person_id	int64	是	人员 ID
person_name	string	是	人员名称
email	string	是	邮件地址
assigned_at	int64	否	分派时间
acknowledged_at	int64	否	认领时间

Incident:

字段	类型	必含	释义
incident_id	string	是	故障 ID
title	string	是	故障标题
description	string	否	故障描述
impact	string	否	故障影响
root_cause	string	否	故障根本原因
resolution	string	否	故障解决办法
incident_severity	string	是	严重程度，枚举值：Critical，Warning，Info
incident_status	string	是	故障状态，枚举值：Critical，Warning，Info，Ok
progress	string	是	处理进度，枚举值：Triggered，Processing，Closed
created_at	int64	是	创建时间
updated_at	int64	是	更新时间
start_time	int64	是	触发时间，Unix 秒时间戳
last_time	int64	否	最新事件时间，关联告警中的最新事件推送时间，Unix 秒时间戳，默认为 0
end_time	int64	否	恢复时间，关联的告警全部恢复时，故障也会自动恢复，Unix 秒时间戳，默认为 0
ack_time	int64	否	首次认领时间，故障可被多人认领，此时间为最早的认领时间。Unix 秒时间戳，默认为 0
close_time	int64	否	关闭时间，end_time代表故障恢复时间，close_time代表处理进度的关闭时间，故障恢复时会同时关闭，故障关闭时不影响故障恢复。Unix 秒时间戳，默认为 0
snoozed_before	int64	否	暂缓截止时间
labels	map[string]string	否	标签 KV，Key 和 Value 均为字符串。手动创建时无此信息，自动创建时为聚合的第一条告警的标签信息
fields	map[string]interface{}	否	自定义字段 KV，Key 为字符串，Value 可能为任意类型，取决于字段类型
creator	Person	否	创建人员信息，仅手动创建故障时存在
closer	Person	否	关闭人员信息，仅手动关闭故障时存在
responders	[]Responder	否	处理人员信息列表
alerts	Alert	否	关联告警
alert_cnt	int64	否	关联告警个数
channel_id	int64	否	协作空间ID，为0代表不属于任何空间
channel_name	string	否	协作空间名称
detail_url	string	是	详情地址
group_method	string	否	聚合方式，枚举值：n：不聚合，p：按规则聚合，i：智能聚合

Alert:

字段	类型	必含	释义
alert_id	string	是	告警 ID
data_source_id	int64	是	集成 ID
title	string	是	告警标题
description	string	否	告警描述
alert_key	string	是	告警关联依据
alert_severity	string	是	严重程度，枚举值：Critical，Warning，Info
alert_status	string	是	告警状态，枚举值：Critical，Warning，Info，Ok
progress	string	是	处理进度，枚举值：Triggered，Closed
created_at	int64	是	创建时间
updated_at	int64	是	更新时间
start_time	int64	是	首次触发时间（平台接收到的首个事件的时间），Unix 秒时间戳
last_time	int64	是	最新事件时间（平台接收到的最新事件时间），Unix 秒时间戳
end_time	int64	否	告警恢复时间（平台上一次接收到结束类型事件的时间），Unix 秒时间戳，默认为 0
close_time	int64	否	关闭时间，不同于 end_time，这个是处理进度的关闭，不代表告警真的恢复。Unix 秒时间戳，默认为 0
labels	map[string]string	否	标签 KV，Key 和 Value 均为字符串

请求响应

HTTP status code 为 200，认为推送成功。

请求示例

三、使用场景

重启主机

当主机内存或CPU打满，触发主机重启脚本，快速完成主机重启。

信息丰富

当故障发生时，回调您的服务，根据告警详情调取 Tracing、Logging、拓扑等信息，主动调用 FlashDuty Open API 来更新故障信息，比如增加标签或设定自定义字段，辅助排障。

回滚变更

当发生故障时，如果确定故障由变更导致，可以直接触发回调到您的部署平台，开启回滚进程，加速故障恢复。

更新 status page

当确定故障影响到线上服务，可以触发外部 status page 更新，及时的通知到您的客户或上下游。

四、常见问题

服务是否有响应超时时间？

服务需要在 1 秒内返回响应，超过 1 秒则认为响应失败

推送来源可信 IP 白名单？

{ip_whitelist}

未来可能会更新，请定期查验

一、创建操作#

二、推送描述#

请求方式#

请求 Payload：#

请求响应#

请求示例#

三、使用场景#

重启主机#

信息丰富#

回滚变更#

更新 status page#

四、常见问题#