查询故障关联告警

查询合并到指定故障中的所有告警列表。

POST /incident/alert/list

查询故障关联告警

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/incident/alert/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "incident_id": "69da451ef77b1b51f40e83ee",
  "is_active": true,
  "limit": 100,
  "p": 1
}
'

import requests

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

payload = {
    "incident_id": "69da451ef77b1b51f40e83ee",
    "is_active": True,
    "limit": 100,
    "p": 1
}
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', is_active: true, limit: 100, p: 1})
};

fetch('https://api.flashcat.cloud/incident/alert/list?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/alert/list?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',
    'is_active' => true,
    'limit' => 100,
    'p' => 1
  ]),
  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/alert/list?app_key="

	payload := strings.NewReader("{\n  \"incident_id\": \"69da451ef77b1b51f40e83ee\",\n  \"is_active\": true,\n  \"limit\": 100,\n  \"p\": 1\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/alert/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"incident_id\": \"69da451ef77b1b51f40e83ee\",\n  \"is_active\": true,\n  \"limit\": 100,\n  \"p\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/incident/alert/list?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  \"is_active\": true,\n  \"limit\": 100,\n  \"p\": 1\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "items": [
      {
        "alert_id": "69da451df77b1b51f40e83de",
        "integration_id": 2490562293131,
        "data_source_id": 2490562293131,
        "channel_id": 2551105804131,
        "account_id": 2451002751131,
        "description": "",
        "title": "CPU usage high - web-server-01",
        "title_rule": "",
        "alert_key": "100128:prom-10.99.1.107:A:1579244238440766834:anydata",
        "alert_severity": "Critical",
        "alert_status": "Critical",
        "start_time": 1775912219,
        "last_time": 1775969819,
        "end_time": 0,
        "labels": {
          "check": "cpu_usage_high",
          "resource": "web-server-01"
        },
        "ever_muted": false,
        "created_at": 1775912221,
        "updated_at": 1775969821,
        "integration_name": "FlashMonit",
        "integration_type": "monit.alert",
        "integration_ref_id": "a_2451002751131",
        "channel_name": "Ops Channel",
        "channel_status": "enabled",
        "responder_name": "",
        "responder_email": "",
        "incident": {
          "incident_id": "69da451ef77b1b51f40e83ee",
          "title": "CPU usage high - web-server-01",
          "progress": "Triggered"
        },
        "event_cnt": 17,
        "images": null,
        "data_source_name": "FlashMonit",
        "data_source_type": "monit.alert",
        "data_source_ref_id": "a_2451002751131"
      }
    ]
  }
}

{
  "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 · string · 必填

故障 ID（MongoDB ObjectID）。

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

include_events · boolean

true 时返回每条告警下的原始事件。

is_active · boolean | null

true 时只返回活跃告警（Critical/Warning/Info），false 时只返回已恢复告警（Ok），不传则返回全部。

limit · integer<int64> · 默认值: 1000

分页大小，最大 1000。

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

p · integer<int64> · 默认值: 1

页码，从 1 开始。

必填范围: x >= 0

响应

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