创建数据集

POST

/public-api/data-source/create-from-account

接口简介

注意：当数据集类型为 Guan-Index 时，primaryKeyColumns不填为不去重，填写参数格式为：[“column1”, “column2”]，column 代表去重列名。

请求参数

Body 参数application/json

token

string

应用Token

必需

在观远平台管理员设置-系统集成-统一账户集成中获得

acId

string

数据账户ID

必需

name

string

数据集名称

必需

parentDirId

string

目录ID

可选

创建的数据集将放在此目录下。
当不传时，数据集默认放在根目录下。具体值可以在浏览器访问目录后在地址栏中获取。

cron

object

更新设置

可选

若不传则默认为手动更新。
按月更新：每月6,7号的凌晨3点更新"cron": { "cronType": "MONTHLY", "value": "{"minute":"00","hours":"03","dom":"6,7"}"}

cronType

enum<string>

定时更新类型

必需

枚举值:

defaultDAILYWEEKLYMONTHLY

默认值:

default

value

string

定时更新配置json字符串

必需

tableQuery

object

生成数据集所使用的SQL语句

必需

queryType

string

必需

SQL查询类型，本接口固定传参为“query”

table

string

必需

数据集所使用表的表名

query

string

必需

创建数据集所使用的SQL语句

sourceType

enum<string>

数据集类型

必需

枚举值:

DIRECT_CONNECT_DATABASEGUAN_INDEX

realTimeUpdateSetting

object | null

实时卡片数据设置

必需

enabled

boolean

是否开启支持实时卡片数据

必需

interval

integer

目前固定为600

必需

disableCache

boolean

是否开启缓存

必需

primaryKeyColumns

array[string]

去重主键

可选

填写参数格式为：["column1", "column2"]

guanIndexIncrementalUpdateSetting

object

增量更新设置

可选

enabled

boolean

是否开启增量更新

必需

query

string

增量更新所使用的SQL语句

必需

示例

{
    "token": "string",
    "acId": "string",
    "name": "string",
    "parentDirId": "string",
    "cron": {
        "cronType": "default",
        "value": "string"
    },
    "tableQuery": {
        "queryType": "string",
        "table": "string",
        "query": "string"
    },
    "sourceType": "DIRECT_CONNECT_DATABASE",
    "realTimeUpdateSetting": {
        "enabled": true,
        "interval": 0,
        "disableCache": true
    },
    "primaryKeyColumns": [
        "string"
    ],
    "guanIndexIncrementalUpdateSetting": {
        "enabled": true,
        "query": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/data-source/create-from-account' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "acId": "string",
    "name": "string",
    "parentDirId": "string",
    "cron": {
        "cronType": "default",
        "value": "string"
    },
    "tableQuery": {
        "queryType": "string",
        "table": "string",
        "query": "string"
    },
    "sourceType": "DIRECT_CONNECT_DATABASE",
    "realTimeUpdateSetting": {
        "enabled": true,
        "interval": 0,
        "disableCache": true
    },
    "primaryKeyColumns": [
        "string"
    ],
    "guanIndexIncrementalUpdateSetting": {
        "enabled": true,
        "query": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

result

string

必需

response

object

必需

taskId

string

必需

status

string

必需

result

string

必需

dsId

string

必需

示例

{
    "result": "ok",
    "response": {
        "taskId": "1b6e0ab0-8798-11ef-894c-b1b9ab6ee927",
        "status": "已提交",
        "result": "处理中",
        "dsId": "e5063f6ac9fff44d1a385b9e"
    }
}

🔴500服务器错误

修改于 2025-07-16 03:18:58

获取数据集数据

更新数据集字段注释