创建或替换富化规则
curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/upsert?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 5001,
"rules": [
{
"kind": "extraction",
"settings": {
"source_field": "labels.env",
"result_label": "environment",
"pattern": "(?P<result>prod|staging|dev)",
"override": true
}
},
{
"kind": "composition",
"settings": {
"result_label": "full_env",
"template": "{{.Labels.region}}-{{.Labels.environment}}",
"override": false
}
}
]
}
'import requests
url = "https://api.flashcat.cloud/enrichment/upsert?app_key="
payload = {
"integration_id": 5001,
"rules": [
{
"kind": "extraction",
"settings": {
"source_field": "labels.env",
"result_label": "environment",
"pattern": "(?P<result>prod|staging|dev)",
"override": True
}
},
{
"kind": "composition",
"settings": {
"result_label": "full_env",
"template": "{{.Labels.region}}-{{.Labels.environment}}",
"override": False
}
}
]
}
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: 5001,
rules: [
{
kind: 'extraction',
settings: {
source_field: 'labels.env',
result_label: 'environment',
pattern: '(?P<result>prod|staging|dev)',
override: true
}
},
{
kind: 'composition',
settings: {
result_label: 'full_env',
template: '{{.Labels.region}}-{{.Labels.environment}}',
override: false
}
}
]
})
};
fetch('https://api.flashcat.cloud/enrichment/upsert?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/upsert?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' => 5001,
'rules' => [
[
'kind' => 'extraction',
'settings' => [
'source_field' => 'labels.env',
'result_label' => 'environment',
'pattern' => '(?P<result>prod|staging|dev)',
'override' => true
]
],
[
'kind' => 'composition',
'settings' => [
'result_label' => 'full_env',
'template' => '{{.Labels.region}}-{{.Labels.environment}}',
'override' => false
]
]
]
]),
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/upsert?app_key="
payload := strings.NewReader("{\n \"integration_id\": 5001,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"settings\": {\n \"source_field\": \"labels.env\",\n \"result_label\": \"environment\",\n \"pattern\": \"(?P<result>prod|staging|dev)\",\n \"override\": true\n }\n },\n {\n \"kind\": \"composition\",\n \"settings\": {\n \"result_label\": \"full_env\",\n \"template\": \"{{.Labels.region}}-{{.Labels.environment}}\",\n \"override\": false\n }\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/upsert?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 5001,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"settings\": {\n \"source_field\": \"labels.env\",\n \"result_label\": \"environment\",\n \"pattern\": \"(?P<result>prod|staging|dev)\",\n \"override\": true\n }\n },\n {\n \"kind\": \"composition\",\n \"settings\": {\n \"result_label\": \"full_env\",\n \"template\": \"{{.Labels.region}}-{{.Labels.environment}}\",\n \"override\": false\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/upsert?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\": 5001,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"settings\": {\n \"source_field\": \"labels.env\",\n \"result_label\": \"environment\",\n \"pattern\": \"(?P<result>prod|staging|dev)\",\n \"override\": true\n }\n },\n {\n \"kind\": \"composition\",\n \"settings\": {\n \"result_label\": \"full_env\",\n \"template\": \"{{.Labels.region}}-{{.Labels.environment}}\",\n \"override\": false\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {}
}{
"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
/
upsert
创建或替换富化规则
curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/upsert?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 5001,
"rules": [
{
"kind": "extraction",
"settings": {
"source_field": "labels.env",
"result_label": "environment",
"pattern": "(?P<result>prod|staging|dev)",
"override": true
}
},
{
"kind": "composition",
"settings": {
"result_label": "full_env",
"template": "{{.Labels.region}}-{{.Labels.environment}}",
"override": false
}
}
]
}
'import requests
url = "https://api.flashcat.cloud/enrichment/upsert?app_key="
payload = {
"integration_id": 5001,
"rules": [
{
"kind": "extraction",
"settings": {
"source_field": "labels.env",
"result_label": "environment",
"pattern": "(?P<result>prod|staging|dev)",
"override": True
}
},
{
"kind": "composition",
"settings": {
"result_label": "full_env",
"template": "{{.Labels.region}}-{{.Labels.environment}}",
"override": False
}
}
]
}
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: 5001,
rules: [
{
kind: 'extraction',
settings: {
source_field: 'labels.env',
result_label: 'environment',
pattern: '(?P<result>prod|staging|dev)',
override: true
}
},
{
kind: 'composition',
settings: {
result_label: 'full_env',
template: '{{.Labels.region}}-{{.Labels.environment}}',
override: false
}
}
]
})
};
fetch('https://api.flashcat.cloud/enrichment/upsert?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/upsert?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' => 5001,
'rules' => [
[
'kind' => 'extraction',
'settings' => [
'source_field' => 'labels.env',
'result_label' => 'environment',
'pattern' => '(?P<result>prod|staging|dev)',
'override' => true
]
],
[
'kind' => 'composition',
'settings' => [
'result_label' => 'full_env',
'template' => '{{.Labels.region}}-{{.Labels.environment}}',
'override' => false
]
]
]
]),
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/upsert?app_key="
payload := strings.NewReader("{\n \"integration_id\": 5001,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"settings\": {\n \"source_field\": \"labels.env\",\n \"result_label\": \"environment\",\n \"pattern\": \"(?P<result>prod|staging|dev)\",\n \"override\": true\n }\n },\n {\n \"kind\": \"composition\",\n \"settings\": {\n \"result_label\": \"full_env\",\n \"template\": \"{{.Labels.region}}-{{.Labels.environment}}\",\n \"override\": false\n }\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/upsert?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 5001,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"settings\": {\n \"source_field\": \"labels.env\",\n \"result_label\": \"environment\",\n \"pattern\": \"(?P<result>prod|staging|dev)\",\n \"override\": true\n }\n },\n {\n \"kind\": \"composition\",\n \"settings\": {\n \"result_label\": \"full_env\",\n \"template\": \"{{.Labels.region}}-{{.Labels.environment}}\",\n \"override\": false\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/upsert?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\": 5001,\n \"rules\": [\n {\n \"kind\": \"extraction\",\n \"settings\": {\n \"source_field\": \"labels.env\",\n \"result_label\": \"environment\",\n \"pattern\": \"(?P<result>prod|staging|dev)\",\n \"override\": true\n }\n },\n {\n \"kind\": \"composition\",\n \"settings\": {\n \"result_label\": \"full_env\",\n \"template\": \"{{.Labels.region}}-{{.Labels.environment}}\",\n \"override\": false\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {}
}{
"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."
}
}限制说明
| 项目 | 说明 |
|---|---|
| 速率限制 | 每个账户 300 次/分钟;20 次/秒 |
| 权限要求 | 协作空间管理(on-call) 或 集成中心管理(on-call) |
使用说明
rules整体替换已存的规则集,传[]可删除全部规则。- 集成必须存在(否则返回
InvalidParameter),且调用方须有权编辑该集成:账户管理员、集成创建者、能编辑其所属协作空间的成员(协作空间内的集成),或集成所属团队的成员;既无团队也不属于协作空间的集成任何成员都可编辑。其他人返回AccessDenied。 - 规则按数组顺序作用于每个进入的告警事件和变更事件,后面的规则能看到前面规则写入的标签。
if条件未全部满足的规则会被跳过;运行时失败的规则(正则未匹配、映射未命中、API 调用失败等)同样跳过,不影响事件本身。 if中的条件键必须是告警或变更事件的键(如title、description、labels.<name>),其他键返回InvalidParameter。- 保存时不校验
schema_id、api_id是否存在;指向不存在或已删除的映射规则 / API 的规则在运行时不生效。mapping_type为api的mapping规则只对告警事件生效。 - 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。
授权
请求体
application/json
此页面对您有帮助吗?