查询告警列表

返回满足过滤条件的告警列表，支持游标分页。

POST /alert/list

查询告警列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/alert/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1712620800,
  "end_time": 1712707200,
  "limit": 20,
  "is_active": true
}
'

import requests

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

payload = {
    "start_time": 1712620800,
    "end_time": 1712707200,
    "limit": 20,
    "is_active": True
}
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({start_time: 1712620800, end_time: 1712707200, limit: 20, is_active: true})
};

fetch('https://api.flashcat.cloud/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/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([
    'start_time' => 1712620800,
    'end_time' => 1712707200,
    'limit' => 20,
    'is_active' => true
  ]),
  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/alert/list?app_key="

	payload := strings.NewReader("{\n  \"start_time\": 1712620800,\n  \"end_time\": 1712707200,\n  \"limit\": 20,\n  \"is_active\": true\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/alert/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_time\": 1712620800,\n  \"end_time\": 1712707200,\n  \"limit\": 20,\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/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  \"start_time\": 1712620800,\n  \"end_time\": 1712707200,\n  \"limit\": 20,\n  \"is_active\": true\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "has_next_page": false,
    "search_after_ctx": "",
    "items": [
      {
        "alert_id": "663a1b2c3d4e5f6789abcdef",
        "integration_id": 10001,
        "channel_id": 20001,
        "account_id": 10023,
        "title": "CPU 使用率 > 90%",
        "alert_severity": "Critical",
        "alert_status": "Critical",
        "start_time": 1712650000,
        "last_time": 1712655000,
        "end_time": 0,
        "labels": {
          "host": "web-01"
        },
        "ever_muted": false,
        "created_at": 1712650000,
        "updated_at": 1712655000,
        "integration_name": "Prometheus",
        "integration_type": "prometheus",
        "channel_name": "生产",
        "event_cnt": 3
      }
    ]
  }
}

{
  "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）

​

使用说明

• start_time 和 end_time 均为必填的 Unix 时间戳（秒），最大跨度 31 天。
• 使用上次响应中的 search_after_ctx 获取下一页。
• 结果会根据调用方的协作空间数据访问权限进行过滤。
• 将 is_active 设为 true 可仅返回活跃（触发中）告警；设为 false 返回已恢复告警。

授权

app_key · string · query · 必填

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

请求体

application/json

告警列表查询的过滤和分页条件，时间范围必填。

start_time · integer<int64> · 必填

检索窗口开始时间，Unix 时间戳（秒）。

end_time · integer<int64> · 必填

检索窗口结束时间，Unix 时间戳（秒）。最大跨度 31 天。

p · integer<int64>

页码，从 1 开始。未提供 search_after_ctx 时使用。

limit · integer<int64>

每页条数，最大 100，默认 20。

search_after_ctx · string

上次响应返回的不透明游标，用于获取下一页。

is_active · boolean | null

过滤活跃（true）或已恢复（false）状态告警。

ever_muted · boolean | null

按告警是否曾被静默过滤。

alert_severity · string

逗号分隔的严重程度过滤，如 Critical,Warning。可选值：Critical、Warning、Info、Ok。

channel_ids · integer<int64>[]

按协作空间 ID 过滤。

integration_ids · integer<int64>[]

按集成 ID 过滤。

alert_ids · string[]

按告警 ID（ObjectID 十六进制字符串）过滤。

alert_keys · string[]

按告警去重键过滤。

orderby · enum<string>

排序字段。

可用选项: created_at, updated_at

asc · boolean

为 true 时升序排序，默认降序。

by_updated_at · boolean

为 true 时，时间范围过滤作用于 updated_at 而非 start_time。

响应

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