吉客云 - Data Acquisition

请求参数

Body 参数application/json

tableName

string

表名

必需

appKey

string

appKey

必需

appSecret

string

appSecret

必需

method

string

请求方法

必需

version

string

版本

必需

pageNumColum

string

页码列

必需

pageSizeColum

string

每页数量列

必需

bizParam

string

业务参数

必需

json字符串

isPage

boolean

是否分页

必需

true开启分页，false关闭分页

arrayField

string

数组字段

必需

解析响应数据字段,jsonpath结构

pageRule

number

分页规则

必需

isPage为true生效，默认1； 1 正常分页（分页字段为page页码，，page_size 大小），2游标方式（分页字段 cursor页码游标值，第一次拉取，无需入参，count。页面大小，默认值30，限制1-50）

customKey

string | null

自定义业务参数

可选

json数组结构[{"key":"","value":""}]

isTermination

boolean

异常是否终止

必需

默认为false；true 数据获取出现异常则终止，false 跳过异常继续处理

frequency

number | null

限流

可选

限流，自定义限流时长，如不传递则为600毫秒

database

string

用于确定存储数据库

必需

onlyRead

boolean

只读模式

可选

默认false；开启只读模式后，不会进行数据的写入

validKeys

array[string] | null

自定义取数字段

可选

不传递则为默认取全部，传递后只取该集合下key

示例

{
    "accessToken": "46nF0ii",
    "urlSuffix": "James",
    "bizParam": "[{\"biz\":\"1\"}]",
    "isPage": false,
    "arrayField": "$.data.arrays",
    "pageRule": 1,
    "customKey": "[{\"key\":\"k1\",\"value\":\"v1\"}]",
    "isTermination": true,
    "frequency": 600,
    "database": "xxxxx",
    "onlyRead": false,
    "validKeys": [
        "r0W"
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://172.168.28.12:9099/daq/jikeyun' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accessToken": "46nF0ii",
    "urlSuffix": "James",
    "bizParam": "[{\"biz\":\"1\"}]",
    "isPage": false,
    "arrayField": "$.data.arrays",
    "pageRule": 1,
    "customKey": "[{\"key\":\"k1\",\"value\":\"v1\"}]",
    "isTermination": true,
    "frequency": 600,
    "database": "xxxxx",
    "onlyRead": false,
    "validKeys": [
        "r0W"
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

message

string

响应信息

必需

data

object

返回数据

必需

requestTotal

integer

请求到总条数

必需

sqlTotal

integer

生成sql总条数

必需

successSqlTotal

integer

成功写入总条数

必需

traceId

string

traceId

必需

示例

成功示例异常示例

{
	"code":0,
	"data":{
		"requestTotal":2423,
		"sqlTotal":1223,
		"successSqlTotal":2423
	},
	"traceId":"171204534693421128f7fa3c940288d8f3ffd5ef128d9"
}