跳转到主要内容
POST
/
channel
/
unsubscribe
/
rule
/
create
创建排除规则
curl --request POST \
  --url 'https://api.flashcat.cloud/channel/unsubscribe/rule/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_id": 3521074710131,
  "rule_name": "Drop test environment alerts",
  "description": "Discard all alerts from the test environment before they create incidents",
  "filters": [
    [
      {
        "key": "labels.env",
        "oper": "IN",
        "vals": [
          "test",
          "dev"
        ]
      }
    ]
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "rule_id": "69db2f6ba0fe7db6448b1505",
    "rule_name": "Test drop rule"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

授权

app_key
string
query
必填

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

请求体

application/json

创建排除规则所需的参数。

channel_id
integer<int64>
必填

所属协作空间 ID。

rule_name
string
必填

规则名称,1 到 39 个字符。

Required string length: 1 - 39
priority
integer

匹配优先级,数值越小越优先。

description
string

规则描述,最多 500 个字符。

Maximum string length: 500
filters
object[][]

或-与组合条件树。每个外层元素为一组 AND 条件,组内所有条件需同时满足。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

每个接口自己的业务 payload,详见各接口的 200 响应 schema。