跳转到主要内容
POST
/
enrichment
/
mapping
/
schema
/
create
创建映射规则
curl --request POST \
  --url 'https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema_name": "CMDB 查询",
  "description": "用 CMDB 数据富化告警",
  "source_labels": [
    "host"
  ],
  "result_labels": [
    "owner",
    "team",
    "service"
  ]
}
'
import requests

url = "https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key="

payload = {
    "schema_name": "CMDB 查询",
    "description": "用 CMDB 数据富化告警",
    "source_labels": ["host"],
    "result_labels": ["owner", "team", "service"]
}
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({
    schema_name: 'CMDB 查询',
    description: '用 CMDB 数据富化告警',
    source_labels: ['host'],
    result_labels: ['owner', 'team', 'service']
  })
};

fetch('https://api.flashcat.cloud/enrichment/mapping/schema/create?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/mapping/schema/create?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([
    'schema_name' => 'CMDB 查询',
    'description' => '用 CMDB 数据富化告警',
    'source_labels' => [
        'host'
    ],
    'result_labels' => [
        'owner',
        'team',
        'service'
    ]
  ]),
  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/mapping/schema/create?app_key="

	payload := strings.NewReader("{\n  \"schema_name\": \"CMDB 查询\",\n  \"description\": \"用 CMDB 数据富化告警\",\n  \"source_labels\": [\n    \"host\"\n  ],\n  \"result_labels\": [\n    \"owner\",\n    \"team\",\n    \"service\"\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/mapping/schema/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"schema_name\": \"CMDB 查询\",\n  \"description\": \"用 CMDB 数据富化告警\",\n  \"source_labels\": [\n    \"host\"\n  ],\n  \"result_labels\": [\n    \"owner\",\n    \"team\",\n    \"service\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/enrichment/mapping/schema/create?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  \"schema_name\": \"CMDB 查询\",\n  \"description\": \"用 CMDB 数据富化告警\",\n  \"source_labels\": [\n    \"host\"\n  ],\n  \"result_labels\": [\n    \"owner\",\n    \"team\",\n    \"service\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "schema_id": "665f1a2b3c4d5e6f7a8b9c01",
    "schema_name": "CMDB 查询"
  }
}
{
  "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": "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）

​
使用说明

  • 映射规则名称在账户内唯一。
  • source_labels（1–3 个）为查找键，result_labels（1–10 个）为匹配后写入的标签。
  • 标签名须符合 ^[a-z][a-z0-9_]{0,39}$（小写）。
  • source_labels 与 result_labels 不得重叠。
  • 账户最多可创建 20 个映射规则。
  • 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。

授权

​
app_key
string
query
必填

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

请求体

application/json
​
schema_name
string
必填

唯一的映射规则名称（最多 39 个字符）。

Maximum string length: 39
​
source_labels
string[]
必填

查找键标签名（1–3 个），不得与 result_labels 重叠。

Maximum array length: 3
​
result_labels
string[]
必填

输出标签名（1–10 个），不得与 source_labels 重叠。

Maximum array length: 10
​
description
string

可选描述（最多 500 个字符）。

Maximum string length: 500
​
team_id
integer<int64>

所属团队 ID，0 表示无团队。

响应

成功

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
必填

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