数据集预览接口 - 观远数据开放平台

请求参数

Path 参数

dsId

string

数据集id

必需

Header 参数

X-Auth-Token

string

个人token

可选

Body 参数application/json

offset

integer

偏移量

必需

默认值0

limit

integer

行数限制

必需

默认5w，且最大不超过5w

filter

object

行筛选条件

必需

combineType

string

关联条件

必需

可选值：AND：表示所有条件都满足OR：任一条件满足

conditions

array [object {3}]

必需

示例

{
  "offset": 0,
  "limit": 1000,
  "filter": {
    "combineType": "AND",
    "conditions": [
      {
        "not": false,
        "type": "condition",
        "value": {
          "name": "id",
          "filterType": "GT",
          "filterValue": ["1"]
        }
      }
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/public-api/data-source//data' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "offset": 0,
  "limit": 1000,
  "filter": {
    "combineType": "AND",
    "conditions": [
      {
        "not": false,
        "type": "condition",
        "value": {
          "name": "id",
          "filterType": "GT",
          "filterValue": ["1"]
        }
      }
    ]
  }
}'

返回响应

🟢200成功

application/json

Body

result

string

状态

必需

response

object

响应结果

必需

dsId

string

数据集id

必需

name

string

数据集名称

必需

displayType

string

数据集类型

必需

storageId

string

数据存储id

必需

默认与dsId一致

domId

string

域id

必需

uId

string

创建人id

必需

parentDirId

string

父文件夹id

必需

cnId

string

连接器类型

可选

与关联的数据账户的一致

acId

string

数据账户id

可选

rowCount

integer

行数

必需

colCount

integer

列数

必需

status

string

数据集状态

必需

columns

array [object {8}]

字段信息

必需

ctime

string

创建时间

必需

utime

string

修改时间

必需

version

integer

版本号

必需

preview

array [array]

data 信息

必需

，顺序按照columns里的字段顺序排列

示例

{
    "result": "ok",
    "response": {
        "dsId": "f8002e3f5801743cc930e551",
        "name": "测试excel",
        "displayType": "MYSQL",
        "storageId": "f8002e3f5801743cc930e551",
        "domId": "demo",
        "uId": "b1766b1ac99bf4679a1bd762",
        "parentDirId": "bbf86c8c533064a34a972bf7",
        "cnId": "mysql",
        "acId": "c73a5244dffce4c41b138ab0",
        "rowCount": 1,
        "colCount": 2,
        "status": "FINISHED",
        "columns": [// 字段信息
            {
                "name": "id",
                "fdType": "INT",
                "dsId": "f8002e3f5801743cc930e551",
                "fdId": "k4936dfe957a0406c9379040",
                "metaType": "METRIC",
                "seqNo": 0,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "value",
                "fdType": "STRING",
                "dsId": "f8002e3f5801743cc930e551",
                "fdId": "k13d0bcc0fb61465ca9bbd9e",
                "metaType": "DIM",
                "seqNo": 1,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            }
        ],
        "ctime": "2024-03-18 11:30:36+0800",
        "utime": "2024-03-19 19:10:27+0800",
        "version": 4,
        "cardCount": 0,
        "preview": [ // data 信息，顺序按照columns里的字段顺序排列
            [
                "1",
                "xxx"
            ]
        ]
    }
}