预览标签增强规则效果
curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"rules": [
{
"kind": "extraction",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": [
"prod"
]
}
],
"settings": {
"source_field": "labels.host",
"result_label": "service_name",
"pattern": "^(?P<result>[a-z0-9-]+)-\\d+$",
"override": false
}
}
],
"event": {
"title": "CPU usage 94% on checkout-7",
"description": "CPU usage above 90% for 5 minutes.",
"event_status": "Critical",
"labels": {
"env": "prod",
"host": "checkout-7",
"check": "cpu"
}
}
}
'import requests
url = "https://api.flashcat.cloud/enrichment/preview?app_key="
payload = {
"integration_id": 6113996590131,
"rules": [
{
"kind": "extraction",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": ["prod"]
}
],
"settings": {
"source_field": "labels.host",
"result_label": "service_name",
"pattern": "^(?P<result>[a-z0-9-]+)-\d+$",
"override": False
}
}
],
"event": {
"title": "CPU usage 94% on checkout-7",
"description": "CPU usage above 90% for 5 minutes.",
"event_status": "Critical",
"labels": {
"env": "prod",
"host": "checkout-7",
"check": "cpu"
}
}
}
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({
integration_id: 6113996590131,
rules: [
{
kind: 'extraction',
if: [{key: 'labels.env', oper: 'IN', vals: ['prod']}],
settings: {
source_field: 'labels.host',
result_label: 'service_name',
pattern: '^(?P<result>[a-z0-9-]+)-\d+$',
override: false
}
}
],
event: {
title: 'CPU usage 94% on checkout-7',
description: 'CPU usage above 90% for 5 minutes.',
event_status: 'Critical',
labels: {env: 'prod', host: 'checkout-7', check: 'cpu'}
}
})
};
fetch('https://api.flashcat.cloud/enrichment/preview?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/enrichment/preview?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([
'integration_id' => 6113996590131,
'rules' => [
[
'kind' => 'extraction',
'if' => [
[
'key' => 'labels.env',
'oper' => 'IN',
'vals' => [
'prod'
]
]
],
'settings' => [
'source_field' => 'labels.host',
'result_label' => 'service_name',
'pattern' => '^(?P<result>[a-z0-9-]+)-\\d+$',
'override' => false
]
]
],
'event' => [
'title' => 'CPU usage 94% on checkout-7',
'description' => 'CPU usage above 90% for 5 minutes.',
'event_status' => 'Critical',
'labels' => [
'env' => 'prod',
'host' => 'checkout-7',
'check' => 'cpu'
]
]
]),
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/enrichment/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"prod\"\n ]\n }\n ],\n \"settings\": {\n \"source_field\": \"labels.host\",\n \"result_label\": \"service_name\",\n \"pattern\": \"^(?P<result>[a-z0-9-]+)-\\\\d+$\",\n \"override\": false\n }\n }\n ],\n \"event\": {\n \"title\": \"CPU usage 94% on checkout-7\",\n \"description\": \"CPU usage above 90% for 5 minutes.\",\n \"event_status\": \"Critical\",\n \"labels\": {\n \"env\": \"prod\",\n \"host\": \"checkout-7\",\n \"check\": \"cpu\"\n }\n }\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/enrichment/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"prod\"\n ]\n }\n ],\n \"settings\": {\n \"source_field\": \"labels.host\",\n \"result_label\": \"service_name\",\n \"pattern\": \"^(?P<result>[a-z0-9-]+)-\\\\d+$\",\n \"override\": false\n }\n }\n ],\n \"event\": {\n \"title\": \"CPU usage 94% on checkout-7\",\n \"description\": \"CPU usage above 90% for 5 minutes.\",\n \"event_status\": \"Critical\",\n \"labels\": {\n \"env\": \"prod\",\n \"host\": \"checkout-7\",\n \"check\": \"cpu\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/preview?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 \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"prod\"\n ]\n }\n ],\n \"settings\": {\n \"source_field\": \"labels.host\",\n \"result_label\": \"service_name\",\n \"pattern\": \"^(?P<result>[a-z0-9-]+)-\\\\d+$\",\n \"override\": false\n }\n }\n ],\n \"event\": {\n \"title\": \"CPU usage 94% on checkout-7\",\n \"description\": \"CPU usage above 90% for 5 minutes.\",\n \"event_status\": \"Critical\",\n \"labels\": {\n \"env\": \"prod\",\n \"host\": \"checkout-7\",\n \"check\": \"cpu\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"before": {
"title": "CPU usage 94% on checkout-7",
"labels": {
"check": "cpu",
"env": "prod",
"host": "checkout-7"
}
},
"after": {
"title": "CPU usage 94% on checkout-7",
"labels": {
"check": "cpu",
"env": "prod",
"host": "checkout-7",
"service_name": "checkout"
}
},
"steps": [
{
"index": 0,
"kind": "extraction",
"matched": true,
"skipped_reason": "",
"detail": "checkout",
"added": {
"service_name": "checkout"
},
"removed": null,
"changed": null,
"mapping_row": null
}
]
}
}{
"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."
}
}标签增强
预览标签增强规则效果
用未保存的标签增强规则按接入的方式处理一个事件，返回规则逐步的结果。
POST
/
enrichment
/
preview
预览标签增强规则效果
curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"rules": [
{
"kind": "extraction",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": [
"prod"
]
}
],
"settings": {
"source_field": "labels.host",
"result_label": "service_name",
"pattern": "^(?P<result>[a-z0-9-]+)-\\d+$",
"override": false
}
}
],
"event": {
"title": "CPU usage 94% on checkout-7",
"description": "CPU usage above 90% for 5 minutes.",
"event_status": "Critical",
"labels": {
"env": "prod",
"host": "checkout-7",
"check": "cpu"
}
}
}
'import requests
url = "https://api.flashcat.cloud/enrichment/preview?app_key="
payload = {
"integration_id": 6113996590131,
"rules": [
{
"kind": "extraction",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": ["prod"]
}
],
"settings": {
"source_field": "labels.host",
"result_label": "service_name",
"pattern": "^(?P<result>[a-z0-9-]+)-\d+$",
"override": False
}
}
],
"event": {
"title": "CPU usage 94% on checkout-7",
"description": "CPU usage above 90% for 5 minutes.",
"event_status": "Critical",
"labels": {
"env": "prod",
"host": "checkout-7",
"check": "cpu"
}
}
}
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({
integration_id: 6113996590131,
rules: [
{
kind: 'extraction',
if: [{key: 'labels.env', oper: 'IN', vals: ['prod']}],
settings: {
source_field: 'labels.host',
result_label: 'service_name',
pattern: '^(?P<result>[a-z0-9-]+)-\d+$',
override: false
}
}
],
event: {
title: 'CPU usage 94% on checkout-7',
description: 'CPU usage above 90% for 5 minutes.',
event_status: 'Critical',
labels: {env: 'prod', host: 'checkout-7', check: 'cpu'}
}
})
};
fetch('https://api.flashcat.cloud/enrichment/preview?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/enrichment/preview?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([
'integration_id' => 6113996590131,
'rules' => [
[
'kind' => 'extraction',
'if' => [
[
'key' => 'labels.env',
'oper' => 'IN',
'vals' => [
'prod'
]
]
],
'settings' => [
'source_field' => 'labels.host',
'result_label' => 'service_name',
'pattern' => '^(?P<result>[a-z0-9-]+)-\\d+$',
'override' => false
]
]
],
'event' => [
'title' => 'CPU usage 94% on checkout-7',
'description' => 'CPU usage above 90% for 5 minutes.',
'event_status' => 'Critical',
'labels' => [
'env' => 'prod',
'host' => 'checkout-7',
'check' => 'cpu'
]
]
]),
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/enrichment/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"prod\"\n ]\n }\n ],\n \"settings\": {\n \"source_field\": \"labels.host\",\n \"result_label\": \"service_name\",\n \"pattern\": \"^(?P<result>[a-z0-9-]+)-\\\\d+$\",\n \"override\": false\n }\n }\n ],\n \"event\": {\n \"title\": \"CPU usage 94% on checkout-7\",\n \"description\": \"CPU usage above 90% for 5 minutes.\",\n \"event_status\": \"Critical\",\n \"labels\": {\n \"env\": \"prod\",\n \"host\": \"checkout-7\",\n \"check\": \"cpu\"\n }\n }\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/enrichment/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"prod\"\n ]\n }\n ],\n \"settings\": {\n \"source_field\": \"labels.host\",\n \"result_label\": \"service_name\",\n \"pattern\": \"^(?P<result>[a-z0-9-]+)-\\\\d+$\",\n \"override\": false\n }\n }\n ],\n \"event\": {\n \"title\": \"CPU usage 94% on checkout-7\",\n \"description\": \"CPU usage above 90% for 5 minutes.\",\n \"event_status\": \"Critical\",\n \"labels\": {\n \"env\": \"prod\",\n \"host\": \"checkout-7\",\n \"check\": \"cpu\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/preview?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 \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"prod\"\n ]\n }\n ],\n \"settings\": {\n \"source_field\": \"labels.host\",\n \"result_label\": \"service_name\",\n \"pattern\": \"^(?P<result>[a-z0-9-]+)-\\\\d+$\",\n \"override\": false\n }\n }\n ],\n \"event\": {\n \"title\": \"CPU usage 94% on checkout-7\",\n \"description\": \"CPU usage above 90% for 5 minutes.\",\n \"event_status\": \"Critical\",\n \"labels\": {\n \"env\": \"prod\",\n \"host\": \"checkout-7\",\n \"check\": \"cpu\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"before": {
"title": "CPU usage 94% on checkout-7",
"labels": {
"check": "cpu",
"env": "prod",
"host": "checkout-7"
}
},
"after": {
"title": "CPU usage 94% on checkout-7",
"labels": {
"check": "cpu",
"env": "prod",
"host": "checkout-7",
"service_name": "checkout"
}
},
"steps": [
{
"index": 0,
"kind": "extraction",
"matched": true,
"skipped_reason": "",
"detail": "checkout",
"added": {
"service_name": "checkout"
},
"removed": null,
"changed": null,
"mapping_row": null
}
]
}
}{
"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）或 集成中心查看（on-call）或 集成中心管理（on-call） |
使用说明
- 不会保存任何内容，也不创建告警或事件。
integration_id必须是本账户的集成，且调用方有权读取它。mapping_type为api的mapping规则会用已存的请求头调用账户的映射 API，因此还需要编辑该集成的权限，否则请求失败。before是事件进入时的样子，after是规则执行后的事件；steps逐条说明规则是否满足条件、为什么被跳过、新增/删除/改写了哪些标签。- 触发事件会按接入在增强后的方式渲染，因此
after中的[TPL]标签、标题和描述就是最终形态。 if的条件键必须来自告警或变更事件的键（title、description、labels.<name>等），其他键返回InvalidParameter。
授权
在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集，请妥善保管。
请求体
application/json
此页面对您有帮助吗？