curl --request POST \
--url 'https://api.flashcat.cloud/insight/alert/topk-by-label?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712000000,
"end_time": 1712604800,
"label": "check",
"k": 10,
"orderby": "total_alert_cnt"
}
'import requests
url = "https://api.flashcat.cloud/insight/alert/topk-by-label?app_key="
payload = {
"start_time": 1712000000,
"end_time": 1712604800,
"label": "check",
"k": 10,
"orderby": "total_alert_cnt"
}
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: 1712000000,
end_time: 1712604800,
label: 'check',
k: 10,
orderby: 'total_alert_cnt'
})
};
fetch('https://api.flashcat.cloud/insight/alert/topk-by-label?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/insight/alert/topk-by-label?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' => 1712000000,
'end_time' => 1712604800,
'label' => 'check',
'k' => 10,
'orderby' => 'total_alert_cnt'
]),
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/insight/alert/topk-by-label?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"label\": \"check\",\n \"k\": 10,\n \"orderby\": \"total_alert_cnt\"\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/insight/alert/topk-by-label?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"label\": \"check\",\n \"k\": 10,\n \"orderby\": \"total_alert_cnt\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/insight/alert/topk-by-label?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\": 1712000000,\n \"end_time\": 1712604800,\n \"label\": \"check\",\n \"k\": 10,\n \"orderby\": \"total_alert_cnt\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"label": "cpu-high",
"total_alert_cnt": 312,
"total_alert_event_cnt": 987
},
{
"label": "disk-full",
"total_alert_cnt": 178,
"total_alert_event_cnt": 452
},
{
"label": "memory-oom",
"total_alert_cnt": 94,
"total_alert_event_cnt": 231
}
]
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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."
}
}查看按 check/resource 聚合的 Top-K 告警
返回指定时间范围内按 check 或 resource 聚合的 Top-K 告警组。
curl --request POST \
--url 'https://api.flashcat.cloud/insight/alert/topk-by-label?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712000000,
"end_time": 1712604800,
"label": "check",
"k": 10,
"orderby": "total_alert_cnt"
}
'import requests
url = "https://api.flashcat.cloud/insight/alert/topk-by-label?app_key="
payload = {
"start_time": 1712000000,
"end_time": 1712604800,
"label": "check",
"k": 10,
"orderby": "total_alert_cnt"
}
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: 1712000000,
end_time: 1712604800,
label: 'check',
k: 10,
orderby: 'total_alert_cnt'
})
};
fetch('https://api.flashcat.cloud/insight/alert/topk-by-label?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/insight/alert/topk-by-label?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' => 1712000000,
'end_time' => 1712604800,
'label' => 'check',
'k' => 10,
'orderby' => 'total_alert_cnt'
]),
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/insight/alert/topk-by-label?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"label\": \"check\",\n \"k\": 10,\n \"orderby\": \"total_alert_cnt\"\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/insight/alert/topk-by-label?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"label\": \"check\",\n \"k\": 10,\n \"orderby\": \"total_alert_cnt\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/insight/alert/topk-by-label?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\": 1712000000,\n \"end_time\": 1712604800,\n \"label\": \"check\",\n \"k\": 10,\n \"orderby\": \"total_alert_cnt\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"label": "cpu-high",
"total_alert_cnt": 312,
"total_alert_event_cnt": 987
},
{
"label": "disk-full",
"total_alert_cnt": 178,
"total_alert_event_cnt": 452
},
{
"label": "memory-oom",
"total_alert_cnt": 94,
"total_alert_event_cnt": 231
}
]
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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) |
使用说明
- 只有时间范围、
team_ids、channel_ids、severities、is_my_team和split_hours会影响结果;其他过滤字段以及aggregate_unit不生效。 - 告警按小时粒度统计,实际时间范围按整点对齐。
split_hours为 true 时,会分别对work、sleep、off各取前k条,最多返回 3 ×k行。- 非账户所有者、非管理员的成员只能看到自己有权访问的协作空间的数据,其他协作空间会被静默排除。
授权
在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。
请求体
洞察维度聚合请求。在 InsightFilter 基础上增加聚合控制字段。
起始时间,Unix 秒。必须大于 0。
结束时间,Unix 秒,必须大于 start_time。
聚合维度。check 按告警事件的 labels.check 标签(监控检查项)取值聚合;resource 按 labels.resource 标签(监控资源标识)取值聚合。
check, resource 按团队 ID 过滤,至多 100 项。
100按协作空间 ID 过滤,至多 100 项。
100按响应人成员 ID 过滤。用于 /insight/responder(返回哪些响应人)以及故障列表/导出(任一指定成员参与响应的故障);账户、团队、协作空间维度和 Top-K 接口忽略该字段。最多 100 个。
100按严重程度过滤:Critical、Warning、Info 或 Ok。最多 3 个。
3Critical, Warning, Info, Ok 按故障 ID(24 位十六进制)过滤。仅用于故障列表和故障导出。最多 100 个。
100^[0-9a-fA-F]{24}$对故障标题做子串匹配(SQL LIKE %query%)。
标签过滤(精确匹配)。
Show child attributes
Show child attributes
自定义字段过滤(精确匹配)。
排序字段。total_alert_cnt 按告警数排序;total_alert_event_cnt 按原始告警事件数排序(默认)。
为 true 时升序,否则降序。
只看调用者所在团队的数据(同时传 team_ids 时取交集)。交集为空或调用者不属于任何团队时,结果为空。
用于切分 aggregate_unit 时间桶的 IANA 时区(如 Asia/Shanghai、UTC);EST 之类的缩写以及 Etc/GMT±N 会被拒绝。默认 UTC。/insight/incident/export 用它渲染时间,未传时依次回退到账户时区、Asia/Shanghai。
解决时长下界(秒,包含)。
x >= 0解决时长上界(秒,不包含)。两端同时设置时必须大于 seconds_to_close_from:故障列表和导出会返回 InvalidParameter,其他接口返回空结果。
x >= 0认领时长下界(秒,包含)。
x >= 0认领时长上界(秒,不包含)。两端同时设置时必须大于 seconds_to_ack_from:故障列表和导出会返回 InvalidParameter,其他接口返回空结果。
x >= 0导出 CSV 的列 key 列表,按给定顺序输出;未知或重复的 key 会被拒绝。各导出接口支持的 key 集合不同,见对应接口的描述。仅导出接口使用;最多 50 个。
50导出时是否将描述列中的 HTML 标签转换为纯文本。
是否包含曾被收敛的故障;默认不包含。
为 true 时,每个时间桶再按 work、sleep、off 拆分,分别作为带 hours 的独立行返回。
将时间范围切分为时间桶;不传则整个范围作为一个桶。要求时间范围至少 24 小时,day 最多 31 天。
day:按time_zone的自然日切分(第一个桶从start_time到下一个零点)。week:从start_time起每 7 天一个桶(不对齐到周一)。month:按time_zone的自然月切分(第一个桶从start_time到下个月 1 日)。
day, week, month 返回的标签值个数,1–100(默认 20)。设置 split_hours 时按每个小时桶分别生效。
1 <= x <= 100响应
成功
此页面对您有帮助吗?