观远数据开放平台
返回最新版
返回最新版
当前版本V7.1.0
  1. 数据集
  • 开发指南
    • Token 鉴权
    • 常见概念
    • 常见问题
  • 数据集
    • 使用parquet文件更新数据集
      GET
    • 获取数据集列表
      POST
    • 修改数据集路径
      POST
    • 数据集删除
      POST
    • 搜索数据集列表
      POST
    • 查询特定数据集的数据结构
      POST
    • 批量修改数据集更新方式
      POST
    • 获取指定数据集有使用权限的用户列表
      POST
    • 上传数据集
      POST
    • 获取数据集下载授权Token
      GET
    • 下载数据集数据
      POST
    • 获取数据集数据
      POST
    • 创建数据集
      POST
    • 更新数据集字段注释
      POST
    • 触发数据集读取数据文件并更新
      GET
    • 通过 TaskID 查询数据集更新结果
      GET
    • 修改数据集schema
      POST
    • 更新数据集
      POST
    • 修改数据集字段别名
      POST
    • 修改数据集名称
      POST
    • 数据集预览接口
      POST
    • 提供修改SQL模型结构接口
      POST
    • 获取数据集目录列表的接口，支持指定目录搜索
      POST
    • 批量查询数据集基本信息
      POST
    • 批量查询数据集权限信息
      POST
  • 仪表板
    • 获取页面列表
    • 根据页面名称关键词搜索页面
    • 获取指定页面有读权限的用户列表
    • 以树状结构获取页面列表
    • 以PDF或者图片模式导出仪表板
    • 获取仪表板导出文件
    • 获取页面基本信息
    • 获取页面信息
  • 订阅预警
    • 下载自定义渠道推送文件
    • 启用/关闭订阅
    • 启用/关闭预警
  • 卡片
    • 获取卡片数据
    • 基于数据集创建卡片接口，提供生成随机ID的接口
  • 权限
    • 获取指定用户能访问的页面列表
    • 获取指定用户能访问的数据集列表
    • 修改指定用户与各个页面的访问及归属关系
    • 修改指定用户与各个数据集的访问及归属关系
    • 获取指定用户组能访问的页面列表
    • 获取指定用户组能访问的数据集列表
    • 修改指定用户组与各个页面的访问及归属关系
    • 修改指定用户组与各个数据集的访问及归属关系
    • 通用资源权限授权与解除
  • 资源操作
    • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
    • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
    • 通用资源列表清单
  • 卡片导出
    • 卡片导出接口使用说明
    • public api 卡片导出
    • public api 任务状态轮询
    • public-api 卡片导出文件下载
  • session
    • session创建or更新
    • 查询数据集的session配置
  • 文件夹
    • 创建文件夹目录
    • 修改文件夹目录
    • 删除文件夹接口
    • 文件夹新增授权接口
    • 文件夹删除权限接口
    • 批量查询文件夹权限信息
  • 数据账户
    • 创建数据账户
  • 身份认证
    • 用户登录
    • 通过用户的loginId登录
    • 用户登出
  • 用户管理
    • 用户管理概述
    • 用户
      • 批量创建用户
      • 批量删除用户
      • 批量修改用户属性
      • 批量获取用户是否存在
      • 通过属性值获取用户列表
      • 获取用户列表
      • 通过loginId获取用户信息
      • 修改用户状态
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
      • 添加单个用户组
    • 用户组成员
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 用户关联账号
      • 关联账号配置介绍
      • 配置用户外部关联账号
      • 删除用户的关联账号
      • 查询用户的外部关联账号
  1. 数据集

批量查询数据集基本信息

POST
/public-api/data-source/batchSearchDsInfo
接口简介
由于不同类型的数据集的sql格式可能会有不同，所以当前一并返回所有数据
普通db数据集（MongoDB、sapbw除外）的格式基本一致，sql信息取自 config.tableQuery.query字段
如果发现信息对不上或者需要别的信息，联系产研进行确认

请求参数

Header 参数
X-Auth-Token
string 
个人Token
可选
Body 参数application/json
dsIds
array[string]
数据集id集合
必需
示例
{
    "dsIds": [
        "eb29865680099464e8bb5f9e",
        "f8d0c74b5ef16409d8079f6b"
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/public-api/data-source/batchSearchDsInfo' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dsIds": [
        "eb29865680099464e8bb5f9e",
        "f8d0c74b5ef16409d8079f6b"
    ]
}'

返回响应

🟢200成功
application/json
Body
result
string 
必需
response
array [object {16}] 
必需
dsId
string 
数据集id
必需
name
string 
数据集名称
必需
displayType
string 
数据集类型
必需
description
string 
描述
可选
storageId
string 
存储id
必需
domId
string 
域id
必需
uId
string 
创建人id
必需
parentDirId
string 
父文件夹id
必需
cnId
string 
连接器类型
可选
acId
string 
数据账户id
可选
dataCronInfo
object 
cron表达式
可选
config
object 
配置项
必需
不同类型数据集的格式各不相同
rowCount
string 
行数
必需
colCount
string 
列数
必需
status
string 
数据集状态
必需
dirPath
array [array] 
文件夹路径
必需
error
object 
错误信息
可选
status
number 
错误码
必需
message
string 
信息
必需
detail
object 
详情
必需
示例
{
    "result": "ok",
    "response": [
        {
            "dsId": "eb29865680099464e8bb5f9e",
            "name": "dsName",
            "displayType": "MYSQL",
            "description": "",
            "storageId": "eb29865680099464e8bb5f9e",
            "domId": "demo",
            "uId": "b1766b1ac99bf4679a1bd762",
            "parentDirId": "bbf86c8c533064a34a972bf7",
            "cnId": "mysql",
            "acId": "c73a5244dffce4c41b138ab0",
            "dataCronInfo": {
                "cronType": "DAILY",
                "value": "{\"minute\":\"00\",\"hours\":\"00\"}"
            },
            "config": {
                "tableQuery": {
                    "queryType": "table",
                    "table": "`test`",
                    "query": "select * from `test` ",
                    "hasEscape": true,
                    "isBasicSelectForm": true,
                    "preSql": []
                },
                "storageType": "REAL",
                "sourceType": "GUAN_INDEX",
                "realTimeUpdateSetting": null,
                "primaryKeyColumns": [],
                "guanIndexIncrementalUpdateSetting": {
                    "enabled": false,
                    "query": "",
                    "preClean": {
                        "enabled": false,
                        "rule": ""
                    }
                },
                "dynamicParameters": [],
                "sensitive": null,
                "dataDesensitization": null,
                "enableSchedule": false
            },
            "rowCount": 4,
            "colCount": 16,
            "status": "FINISHED",
            "dirPath": [
                [
                    "j437866b3833d49e8a93d1b1",
                    "根目录"
                ],
                [
                    "bbf86c8c533064a34a972bf7",
                    "tmp"
                ]
            ]
        }
    ]
}
修改于 2025-07-16 03:18:58
上一页
获取数据集目录列表的接口，支持指定目录搜索
下一页
批量查询数据集权限信息