告警标签TOP - Flashcat API

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Body 参数application/json

start_time

integer

开始时间

必需

秒时间戳，故障的触发时间需大于此时间

end_time

integer

结束时间

必需

秒时间戳，故障的触发时间需小于等于此时间。最大时间跨度6个月，若aggregate_unit聚合粒度为day，则最大时间跨度6个月

team_ids

array[integer]

团队列表

可选

团队列表

channel_ids

array[integer]

协作空间列表

可选

空间列表，仅可选择您可见的空间

severities

array[string]

严重程度

可选

严重程度

枚举值:

InfoWarningCritical

time_zone

string

时区

可选

默认时区 Asia/Shanghai，用于结果和分组的时区。必须是 tzdata 格式。请参阅此处可接受的值列表。

默认值:

Asia/Shanghai

orderby

enum<string>

排序字段

可选

枚举值:

total_alert_cnttotal_alert_event_cnt

asc

boolean

是否升序

可选

默认降序

k

integer

数据数量

可选

默认全返回

>= 1<= 100

label

enum<string>

标签

必需

枚举值:

checkresource

示例

{
  "start_time": 0,
  "end_time": 0,
  "team_ids": [
    0
  ],
  "channel_ids": [
    0
  ],
  "severities": [
    "Info"
  ],
  "time_zone": "Asia/Shanghai",
  "orderby": "total_alert_cnt",
  "asc": true,
  "k": 1,
  "label": "check"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.flashcat.cloud/insight/alert/topk-by-label?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_time": 0,
    "end_time": 0,
    "team_ids": [
        0
    ],
    "channel_ids": [
        0
    ],
    "severities": [
        "Info"
    ],
    "time_zone": "Asia/Shanghai",
    "orderby": "total_alert_cnt",
    "asc": true,
    "k": 1,
    "label": "check"
}'

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

可选

items

array [object {3}]

必需

示例

{
  "error": {
    "code": "string",
    "message": "string"
  },
  "data": [
    {
      "total_alert_cnt": 11,
      "total_alert_event_cnt": 11,
      "label": "HTTP响应出错"
    },
    {
      "total_alert_cnt": 1,
      "total_alert_event_cnt": 1,
      "label": "cpu.ide<28"
    }
  ]
}