观远数据开放平台
8.4.0
  • 8.4.0
  • 8.3.0
  • 8.2.0
  • 8.1.0
  • 7.4.0
  • 7.3.0
首页官网社区英文版
文档
  • 帮助中心
  • 观远学堂
首页官网社区英文版
文档
  • 帮助中心
  • 观远学堂
8.4.0
  • 8.4.0
  • 8.3.0
  • 8.2.0
  • 8.1.0
  • 7.4.0
  • 7.3.0
  1. 数据集
  • 用户
    • 批量创建用户
      POST
    • 批量删除用户
      POST
    • 批量修改用户属性
      POST
    • 批量获取用户是否存在
      POST
    • 通过属性值获取用户列表
      POST
    • 获取用户列表
      POST
    • 通过loginId获取用户信息
      POST
    • 修改用户状态
      POST
  • 开发指南
    • Token 鉴权
    • 常见概念
  • 数据集
    • 清空数据集数据
      GET
    • 数据集删除_V2
      POST
    • 使用parquet文件更新数据集
      GET
    • 获取数据集列表
      POST
    • 修改数据集路径
      POST
    • 数据集删除
      POST
    • 搜索数据集列表
      POST
    • 查询特定数据集的数据结构
      POST
    • 批量修改数据集更新方式
      POST
    • 获取指定数据集有使用权限的用户列表
      POST
    • 上传数据集
      POST
    • 获取数据集下载授权Token
      GET
    • 下载数据集数据
      POST
    • 获取数据集数据
      POST
    • 创建数据集
      POST
    • 更新数据集字段注释
      POST
    • 触发数据集读取数据文件并更新
      GET
    • 通过 TaskID 查询数据集更新结果
      GET
    • 修改数据集schema
      POST
    • 更新数据集
      POST
    • 修改数据集字段别名
      POST
    • 修改数据集名称
      POST
    • 提供修改SQL模型结构接口
      POST
    • 获取数据集目录列表的接口,支持指定目录搜索
      POST
    • 批量查询数据集基本信息
      POST
    • 批量查询数据集权限信息
      POST
  • 仪表板
    • 获取页面列表
    • 根据页面名称关键词搜索页面
    • 获取指定页面有读权限的用户列表
    • 以树状结构获取页面列表
    • 以PDF或者图片模式导出仪表板
    • 获取仪表板导出文件
    • 获取页面基本信息
    • 获取页面信息
    • 获取仪表板智能洞察
    • 删除仪表板
  • 卡片
    • 获取卡片数据
    • 基于数据集创建卡片接口,提供生成随机ID的接口
    • 获取卡片智能洞察
    • 获取卡片数据_V2
  • 订阅预警
    • 查询订阅列表
    • 查询预警列表
    • 通知发送历史查询记录
    • 下载自定义渠道推送文件
    • 启用/关闭订阅
    • 启用/关闭预警
  • 权限
    • 获取指定用户能访问的页面列表
    • 获取指定用户能访问的数据集列表
    • 修改指定用户与各个页面的访问及归属关系
    • 修改指定用户与各个数据集的访问及归属关系
    • 获取指定用户组能访问的页面列表
    • 获取指定用户组能访问的数据集列表
    • 修改指定用户组与各个页面的访问及归属关系
    • 修改指定用户组与各个数据集的访问及归属关系
    • 通用资源权限授权与解除
    • 对指定用户或用户组进行资源授权
    • 取消指定用户或用户组的资源授权
  • 资源操作
    • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
    • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
    • 通用资源列表清单
  • 卡片导出
    • 卡片导出接口使用说明
    • public api 卡片导出
    • public api 任务状态轮询
    • public-api 卡片导出文件下载
  • session
    • session创建or更新
    • 查询数据集的session配置
  • 文件夹
    • 创建文件夹目录
    • 修改文件夹目录
    • 删除文件夹接口
    • 文件夹新增授权接口
    • 文件夹删除权限接口
    • 批量查询文件夹权限信息
  • 数据账户
    • 创建数据账户
  • 身份认证
    • 用户登录
    • 通过用户的loginId登录
    • 用户登出
  • 用户管理
    • 用户管理概述
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
      • 添加单个用户组
      • 删除用户组V2接口
    • 用户组成员
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 用户关联账号
      • 关联账号配置介绍
      • 配置用户外部关联账号
      • 删除用户的关联账号
      • 查询用户的外部关联账号
  • 系统相关
    • 获取监控信息
  • 指标中心
    • 获取指标主题
    • 获取指标主题下的文件夹列表
    • 获取指定主题和文件夹下的指标列表
    • 获取指标详情
    • 获取指标数据
  • 血缘
    • 查询资源血缘
    • 查询字段血缘
  • 洞察agent
    • 创建洞察Agent任务
    • 查询对话详情
  1. 数据集

数据集删除_V2

POST
/public-api/v2/data-source/{dsId}/delete
通过数据集 ID 删除指定数据集。V2 与原数据集删除接口共用删除处理逻辑;V2 支持 OAuth2 应用授权和集成 Token,并通过 X-Public-User-Id 指定操作用户。

鉴权与操作用户#

选择一种鉴权方式;两种方式均须传入 X-Public-User-Id:
方式凭证要求
OAuth2 应用授权Authorization: Bearer <access_token>应用获得 legacy-public-api:full-access scope,凭证和应用有效,并满足许可、IP 白名单等授权要求。
集成 TokenX-Public-Token: <集成Token>使用统一账户集成 Token,并满足该 Token 的校验要求。
X-Public-User-Id 传 Token 所属租户内的用户 loginId(登录账号),不是内部 uId;用户必须存在且启用,并具有数据集操作功能权限及目标数据集的管理权限。应用授权不会替代用户的资源权限校验。

OAuth2 获取 Token#

使用已创建应用凭证的 client_id 和 client_secret,通过 HTTP Basic 认证申请 Token,授权类型为 client_credentials。TOKEN_ENDPOINT 使用应用凭证返回的 tokenEndpoint;默认对外地址为 https://<BI域名>/backend/oauth2/token,以目标环境配置为准。
读取响应中的 access_token,有效期以 expires_in 为准。这里需要 OAuth2 应用访问令牌,不是登录会话 Token 或个人访问 Token(PAT)。

OAuth2 删除示例#

BI_BASE_URL 为 BI 服务对外 API 地址前缀;例如网关统一使用 /backend 时填写 https://<BI域名>/backend。

集成 Token 删除示例#

请求参数#

dsId:必填,待删除数据集的 ID,放在 URL 路径中。
无需请求体,也无需 Query 参数;不支持 force 参数。

删除规则#

操作用户必须存在、启用,并具有数据集操作功能权限及目标数据集的管理权限。
删除前检查资源依赖。例如数据集被卡片(包括草稿卡片)、ETL、数据融合、SparkView 或层级树等资源使用时,接口可能返回依赖错误;需先解除相关依赖。
本接口删除数据集资源;如只需清空数据,请使用清空数据集数据接口。

返回结果#

成功时返回:
{
  "result": "ok",
  "response": "DataSource deleted"
}

常见错误#

情况响应判断
操作用户不存在或停用、数据集不存在、无管理权限、存在阻止删除的依赖通常 HTTP 200,result=fail,读取对象 error 中的业务错误码及消息。
集成 Token 缺失或无效通常 HTTP 403,返回 result/response/error 包络。
OAuth2 Token 无效、过期或未通过认证HTTP 401,error 为字符串,具体原因见 message。
OAuth2 scope 不足或应用授权校验失败HTTP 403,error 为字符串,例如 insufficient_scope,具体原因见 message。
OAuth2 应用调用超过限制HTTP 429,读取顶层 error、message、status。
OAuth2 鉴权错误与业务错误的结构不同,不能只检查 result 判断所有失败响应。

请求参数

Path 参数

Header 参数

请求示例代码

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/v2/data-source/<DATASET_ID>/delete' \
--header 'X-Public-User-Id: operator@example.com'

返回响应

🟢200业务处理结果
application/json
成功或业务失败;HTTP 200 时须继续检查 result。
Body

示例
{
    "result": "ok",
    "response": "DataSource deleted"
}
🟠401OAuth2 认证失败
🟠403鉴权或授权失败
🟠429OAuth2 应用调用受限
修改于 2026-11-03 03:04:35
上一页
清空数据集数据
下一页
使用parquet文件更新数据集