跳转到主要内容
POST
执行自定义操作

限制说明

使用说明

  • 集成必须是已启用的自定义操作集成,且其关联的协作空间包含该故障所在的协作空间,否则返回 InvalidParameter。
  • 服务端会以 2 秒超时把故障数据 POST 到该操作配置的地址。该请求失败时接口仍返回 HTTP 200,错误信息放在 data.message 中;成功时 data 为 null。
  • 执行成功后会写入一条 i_custom 时间线记录。

授权

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}$
integration_id
integer<int64>
必填

自定义操作集成 ID,必须已启用且关联故障所在协作空间。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object | null

操作的 HTTP 请求成功时为 null;失败时为包含 message 的对象。