Flashcat API

空间创建

POST

/channel/create

最后修改时间：2024-11-19 03:36:36

请求参数

Authorization

在 query 添加参数

app_key

示例：

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

Header 参数

Content-Type

string

可选

示例值:

application/json

Body 参数application/json

channel_name

string

名称

必需

description

string

描述

可选

team_id

integer

负责团队ID

可选

不传，仅创建者和主体账号可以管理空间配置

escalate_rule

object

默认分派策略

可选

aggr_window

integer

聚合窗口，单位秒，范围[0,720]

可选

template_id

string

模板ID

必需

target

object (EscalateTarget)

通知对象

必需

plugin_ids

array[integer]

告警事件集成类型ID列表

可选

auto_resolve_timeout

integer

超时自动恢复时间，单位秒

可选

不传不自动恢复

>= 0<= 86400

is_private

boolean

是否私有访问

可选

不传默认公开

group

object (Group)

告警聚合配置

可选

不传不聚合

method

enum<string>

聚合方式

必需

枚举值:

ipn

cases

array[object (CaseEqual) {2}]

分支聚合维度

可选

仅按策略聚合时存在。优先从上至下匹配分支条件，匹配到即使用分支的维度进行聚合

<= 10 items

equals

array [array]

默认聚合维度

可选

仅按策略聚合时存在。如果所有分支都没有匹配上，则使用此维度兜底。注意此维度是多组聚合维度，任意一组维度满足，则告警被聚合

<= 5 items

all_equals_required

boolean

是否需要相同项全部存在

可选

仅按策略聚合时存在。默认为false。区别在于配置多个相同项时：- 开启，告警与故障中值都为空的聚合条件将视为不同项。- 不开启，告警与故障中值都为空的聚合条件将视为相同项。

time_window

integer

时间窗口，单位分钟，取值范围[0,60]

可选

为0，代表一直合并告警直到故障关闭

storm_threshold

integer

风暴阈值，聚合告警条数超过该阈值进行风暴预警。取值范围[0,10000]

可选

为0代表不设置风暴预警

flapping

object (Flapping)

故障收敛配置

可选

不传按默认值处理

is_disabled

boolean

是否关闭

必需

true 关闭，false 开启，默认值false

max_changes

enum<string>

时间窗口内相同故障最大发生次数

必需

范围[2,100]，默认值4。dedup_key相同时，认为故障相同。dedup_key来自于合并入的第一条告警的alert_key

枚举值:

ipn

in_mins

integer

统计时间窗口，单位分钟

必需

范围[1,1440]，默认值60

mute_mins

integer

静默时间窗口，单位分钟

必需

范围[30,1440]，默认值120

示例

{
  "channel_name": "string",
  "description": "string",
  "team_id": 0,
  "escalate_rule": {
    "aggr_window": 0,
    "template_id": "string",
    "target": {
      "team_ids": [
        0
      ],
      "person_ids": [
        0
      ],
      "schedule_to_role_ids": {
        "{schedule_id}": [
          0
        ]
      },
      "by": {
        "follow_preference": true,
        "critical": [
          "email"
        ],
        "warning": [
          "email"
        ],
        "info": [
          "email"
        ]
      },
      "webhooks": [
        {
          "type": "feishu_app",
          "settings": {}
        }
      ]
    }
  },
  "plugin_ids": [
    0
  ],
  "auto_resolve_timeout": 0,
  "is_private": true,
  "group": {
    "method": "i",
    "cases": [
      {
        "if": [
          {
            "key": "title",
            "oper": "IN",
            "vals": [
              "string"
            ]
          }
        ],
        "equals": [
          "string"
        ]
      }
    ],
    "equals": [
      [
        "title"
      ]
    ],
    "all_equals_required": true,
    "time_window": 0,
    "storm_threshold": 0
  },
  "flapping": {
    "is_disabled": true,
    "max_changes": "i",
    "in_mins": 0,
    "mute_mins": 0
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.flashcat.cloud/channel/create?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel_name": "string",
    "description": "string",
    "team_id": 0,
    "escalate_rule": {
        "aggr_window": 0,
        "template_id": "string",
        "target": {
            "team_ids": [
                0
            ],
            "person_ids": [
                0
            ],
            "schedule_to_role_ids": {
                "{schedule_id}": [
                    0
                ]
            },
            "by": {
                "follow_preference": true,
                "critical": [
                    "email"
                ],
                "warning": [
                    "email"
                ],
                "info": [
                    "email"
                ]
            },
            "webhooks": [
                {
                    "type": "feishu_app",
                    "settings": {}
                }
            ]
        }
    },
    "plugin_ids": [
        0
    ],
    "auto_resolve_timeout": 0,
    "is_private": true,
    "group": {
        "method": "i",
        "cases": [
            {
                "if": [
                    {
                        "key": "title",
                        "oper": "IN",
                        "vals": [
                            "string"
                        ]
                    }
                ],
                "equals": [
                    "string"
                ]
            }
        ],
        "equals": [
            [
                "title"
            ]
        ],
        "all_equals_required": true,
        "time_window": 0,
        "storm_threshold": 0
    },
    "flapping": {
        "is_disabled": true,
        "max_changes": "i",
        "in_mins": 0,
        "mute_mins": 0
    }
}'

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

可选

channel_id

string

必需

channel_name

string

名称

必需

示例

{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "data": {
    "channel_id": "string",
    "channel_name": "string"
  }
}

修改于 2024-11-19 03:36:36

空间详情

空间更新