跳转到主要内容
POST
查询映射数据列表

限制说明

使用说明

  • 映射规则必须存在且未被删除,否则返回 InvalidParameter。
  • query 按来源标签值精确过滤。不属于来源标签的键会被丢弃;只要还剩下键,就必须给出全部来源标签,否则返回 InvalidParameter。
  • 页码分页(p、limit)最多取到第 10,000 行(p * limit <= 10000),更靠后的数据请用 search_after_ctx 游标翻页。
  • total 最多统计 1,000 条匹配行;used_cnt 是该映射规则的实际总行数。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json
schema_id
string
必填

映射规则 ID(MongoDB ObjectID 十六进制)。

query
object

按来源标签值精确过滤。不属于来源标签的键会被静默忽略;一旦指定,必须包含全部来源标签。

orderby
enum<string>

排序字段,默认 updated_at。

可用选项:
created_at,
updated_at
asc
boolean
默认值:false

为 true 时正序;默认 false(最新的在前)。

p
integer<int64> | null

页码(从 1 开始),用于页码分页;省略、null 或 0 时默认为 1。设置 search_after_ctx 时忽略该参数。页码分页最多可取 10,000 行(p * limit <= 10000)。

必填范围: x >= 0
limit
integer<int64> | null

每页数量(0–100);省略、null 或 0 时默认为 20。

必填范围: 0 <= x <= 100
search_after_ctx
string | null

游标分页使用的不透明游标——传入上一次响应中的 search_after_ctx。须为 MongoDB ObjectID 十六进制字符串;设置后忽略 p。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。