查询映射数据列表

分页返回指定映射规则的数据行，可按来源标签值进行精确过滤。

POST /enrichment/mapping/data/list

查询映射数据列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/enrichment/mapping/data/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema_id": "665f1a2b3c4d5e6f7a8b9c01",
  "orderby": "updated_at",
  "asc": false,
  "p": 1,
  "limit": 20
}
'

import requests

url = "https://api.flashcat.cloud/enrichment/mapping/data/list?app_key="

payload = {
    "schema_id": "665f1a2b3c4d5e6f7a8b9c01",
    "orderby": "updated_at",
    "asc": False,
    "p": 1,
    "limit": 20
}
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_id: '665f1a2b3c4d5e6f7a8b9c01',
    orderby: 'updated_at',
    asc: false,
    p: 1,
    limit: 20
  })
};

fetch('https://api.flashcat.cloud/enrichment/mapping/data/list?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/data/list?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_id' => '665f1a2b3c4d5e6f7a8b9c01',
    'orderby' => 'updated_at',
    'asc' => false,
    'p' => 1,
    'limit' => 20
  ]),
  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/data/list?app_key="

	payload := strings.NewReader("{\n  \"schema_id\": \"665f1a2b3c4d5e6f7a8b9c01\",\n  \"orderby\": \"updated_at\",\n  \"asc\": false,\n  \"p\": 1,\n  \"limit\": 20\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/data/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"schema_id\": \"665f1a2b3c4d5e6f7a8b9c01\",\n  \"orderby\": \"updated_at\",\n  \"asc\": false,\n  \"p\": 1,\n  \"limit\": 20\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/enrichment/mapping/data/list?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_id\": \"665f1a2b3c4d5e6f7a8b9c01\",\n  \"orderby\": \"updated_at\",\n  \"asc\": false,\n  \"p\": 1,\n  \"limit\": 20\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "key": "server01",
        "fields": {
          "host": "server01",
          "owner": "alice",
          "team": "sre",
          "service": "api"
        },
        "created_at": 1710000000,
        "updated_at": 1710000000
      }
    ],
    "total": 1,
    "has_next_page": false
  }
}

{
  "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） 或 集成中心管理（on-call） 或 映射数据查看（on-call） 或 映射数据管理（on-call）

​

使用说明

• 若提供 query，须包含全部来源标签——不支持部分来源标签查询。
• 支持游标分页（search_after_ctx）或页码分页（p、limit）。limit 默认 20，最大 100。
• 响应中的 search_after_ctx 可用于获取下一页。

授权

app_key · string · query · 必填

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

请求体

application/json

schema_id · string · 必填

映射规则 ID（MongoDB ObjectID 十六进制）。

query · object

按来源标签值精确过滤。若指定 query，须包含全部来源标签。

Show child attributes

orderby · enum<string>

排序字段。

可用选项: created_at, updated_at

asc · boolean

为 true 时升序排列。

p · integer<int64>

页码（从 1 开始），用于页码分页。

limit · integer<int64>

每页数量（1–100，默认 20）。

search_after_ctx · string

用于游标分页的不透明游标令牌。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

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

Show child attributes