查询data - Flashcat API

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Header 参数

Content-Type

string

可选

示例值:

application/json

Body 参数application/json

schema_id

string

schema ID

必需

query

object (Labels)

匹配条件

可选

不设置过滤，否则query必须包含schema中source_labels中所有字段和条件

^[a-zA-Z_][a-zA-Z0-9_]*$

string

(pattern property)

key为任意label名称，值为字符串

可选

label格式需要满足正则^[a-zA-Z_][a-zA-Z0-9_]*$，value的长度不超过512字节

<= 512 字符

orderby

enum<string>

排序依据

可选

枚举值:

created_atupdated_at

search_after_ctx

string

游标分页，不设置为第一页。与p参数二选一

可选

详细解释，请参考关于分页

p

integer

传统分页，不设置从第一页开始，默认值为1，与search_after_ctx参数二选一

可选

基于传统分页时设置，当设置p参数时，p*limit不得超过10000，否则返回参数错误。详细解释，请参考关于分页

默认值:

1

limit

integer

分页条数

可选

当设置p参数时，(p-1)*limit不得超过10000，否则返回参数错误。详细解释，请参考关于分页

>= 0<= 100

默认值:

20

示例

{
  "schema_id": "string",
  "query": {},
  "orderby": "created_at",
  "search_after_ctx": "string",
  "p": 1,
  "limit": 20
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.flashcat.cloud/enrichment/mapping/data/list?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "schema_id": "string",
    "query": {},
    "orderby": "created_at",
    "search_after_ctx": "string",
    "p": 1,
    "limit": 20
}'

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

错误信息

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

数据对象

必需

items

array [object {4}]

数据列表

必需

search_after_ctx

string

可选

游标分页，有此项说明有下一页。详细解释，请参考关于分页

total

integer

可选

匹配条目总数。请注意，total仅在小于1000时精确，请不要使用该值来计算分页是否结束。当总条数大于1000时，系统仅会返回total=1000，代表系统匹配到了1000+数据。请使用hax_next_page来判断是否还有数据未获取。详细解释，请参考关于分页

has_next_page

boolean

可选

是否存在更多数据未获取

示例

{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "data": {
    "items": [
      {
        "key": "string",
        "fields": {},
        "created_at": 0,
        "updated_at": 0
      }
    ],
    "search_after_ctx": "string",
    "total": 0,
    "has_next_page": true
  }
}