跳转到主要内容
POST
/
monit
/
rule
/
list
/
basic
查询告警规则列表
curl --request POST \
  --url 'https://api.flashcat.cloud/monit/rule/list/basic?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folder_id": 100
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": [
    {
      "id": 50001,
      "folder_id": 100,
      "name": "CPU 过高",
      "ds_type": "prometheus",
      "enabled": true,
      "triggered": true,
      "created_at": 1710000000
    }
  ]
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求告警规则查看monit

使用说明

  • folder_id 设为 0 可列出当前用户有权查看的所有文件夹下的规则。
  • triggered 字段表示该规则当前是否有活跃告警。

授权

app_key
string
query
必填

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

请求体

application/json

按文件夹查询规则的过滤参数。

folder_id
integer<uint64>

文件夹 ID,设为 0 可列出所有可访问规则。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]
必填

告警规则基础信息列表。