获取故障详情

获取单个故障的详细信息，包括时间线、关联告警、处理人员和自定义字段。

POST /incident/info

获取故障详情

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/incident/info?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "incident_id": "69da451ef77b1b51f40e83ee"
}
'

import requests

url = "https://api.flashcat.cloud/incident/info?app_key="

payload = { "incident_id": "69da451ef77b1b51f40e83ee" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({incident_id: '69da451ef77b1b51f40e83ee'})
};

fetch('https://api.flashcat.cloud/incident/info?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/incident/info?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'incident_id' => '69da451ef77b1b51f40e83ee'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/incident/info?app_key="

	payload := strings.NewReader("{\n  \"incident_id\": \"69da451ef77b1b51f40e83ee\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/incident/info?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"incident_id\": \"69da451ef77b1b51f40e83ee\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/incident/info?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"incident_id\": \"69da451ef77b1b51f40e83ee\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "incident_id": "69da451ef77b1b51f40e83ee",
    "account_id": 2451002751131,
    "channel_id": 2551105804131,
    "integration_id": 2490562293131,
    "integration_ids": [
      2490562293131
    ],
    "integration_types": [
      "monit.alert"
    ],
    "dedup_key": "100128:prom-10.99.1.107:A:1579244238440766834:anydata",
    "equals_md5": "",
    "start_time": 1775912219,
    "end_time": 0,
    "last_time": 1775969819,
    "ack_time": 0,
    "close_time": 0,
    "creator_id": 0,
    "closer_id": 0,
    "owner_id": 0,
    "incident_status": "Critical",
    "incident_severity": "Critical",
    "progress": "Triggered",
    "title": "CPU usage high - web-server-01",
    "description": "",
    "ai_summary": "",
    "impact": "",
    "root_cause": "",
    "resolution": "",
    "num": "0E83EE",
    "frequency": "frequent",
    "created_at": 1775912222,
    "updated_at": 1775972145,
    "snoozed_before": 0,
    "group_method": "n",
    "ever_muted": false,
    "labels": {
      "check": "cpu_usage_high",
      "resource": "web-server-01",
      "env": "production"
    },
    "fields": {},
    "assigned_to": {
      "person_ids": [
        2476444212131
      ],
      "escalate_rule_id": "000000000000000000000000",
      "layer_idx": 0,
      "type": "assign",
      "assigned_at": 1775972128,
      "id": "MvQfH9Dc8eNS8k79jmrWn6",
      "escalate_rule_name": ""
    },
    "alert_cnt": 1,
    "active_alert_cnt": 1,
    "alert_event_cnt": 17,
    "responders": [
      {
        "person_id": 2476444212131,
        "assigned_at": 1775972128,
        "acknowledged_at": 0
      }
    ],
    "account_name": "",
    "account_locale": "",
    "account_time_zone": "",
    "channel_name": "Ops Channel",
    "channel_status": "enabled",
    "detail_url": "https://app.flashcat.cloud/incident/detail/69da451ef77b1b51f40e83ee",
    "silence_url": "https://app.flashcat.cloud/channel/detail/2551105804131?tab=alertSuppression&fromIncidentId=69da451ef77b1b51f40e83ee",
    "integration_type": "monit.alert",
    "post_mortem_id": "",
    "images": null,
    "manual_overrides": [
      "title"
    ]
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	故障查看（on-call）

授权

app_key · string · query · 必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

请求体

application/json

单个故障查询参数。incident_id 与 num 二者择一传入。

incident_id · string

故障 ID（MongoDB ObjectID）。

Pattern: ^[0-9a-fA-F]{24}$

num · string

故障短 ID（界面上展示的 6 位大写 ID）。不唯一——命中多个时返回最近一个。incident_id 与 num 二者择一传入。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

故障详细信息。

Show child attributes