简介

概述

大数据智能体工作台 DataBuddy 是腾讯云推出的 Agent 原生（Agent-Native）、全托管的 Data + AI 一体化数据智能平台。DataBuddy 融合数据计算与 AI 智能体能力，通过统一元数据与语义层，为企业提供从数据接入、数据工程、数据科学、数据分析到数据治理的端到端全链路能力，让大数据平台从“人操作工具”进化为“AI 工作、人把关”。

本章节介绍的腾讯云 DataBuddy API 接口均为 API 3.0 接口。

您可以调用 API 对腾讯云 DataBuddy 进行操作，例如创建与管理工作空间、创建与变配计算资源、管理数据源连接、提交与查询 SQL 任务、创建与运行工作流、查询任务运行实例与运行状态、管理数据目录中的 Catalog/Schema/表/Volume 等资产、注册与部署模型服务、查询数据质量与治理结果等，从而将 DataBuddy 的能力集成到您自有的调度系统、运维平台或业务应用中。

术语表

腾讯云 DataBuddy API 接口的常见术语请参见下表：

使用限制

调用腾讯云 DataBuddy API 时，请注意以下限制：

通用限制

• 鉴权与权限：调用 API 需使用腾讯云访问密钥（SecretId/SecretKey）进行签名，并确保调用账号（主账号或子账号）已获得对应的 CAM 策略授权及 DataBuddy 工作空间内的成员角色权限。接口一律按调用者的真实身份进行权限校验，不支持越权访问其他账号或未授权工作空间下的资源。
• 密钥管理：访问密钥仅通过环境变量或密钥管理服务读取，请勿硬编码在代码、配置文件或前端页面中；
• 地域限制：API 通过公共参数 Region 指定地域，仅支持当前账号已开通 DataBuddy 服务的地域。跨地域资源不可互相操作，工作空间的地域在创建后不可修改。
• 调用频率：接口存在调用频率限制，超出后会返回请求频率超限的错误码。建议对轮询类接口（如查询任务运行状态）采用退避重试策略，避免高频空转。
• 分页限制：列表类接口通过 Offset、Limit 分页返回，单次返回条数存在上限。请通过循环分页获取完整数据，不要依赖单次全量返回。

API 快速入门

您可以使用 API Explorer 工具在线调用 API。

本文以创建工作流并查看工作流信息 为例，通过 API Explorer 工具调用 API 接口的步骤如下：

1. 进入 API Explorer 工具页面，在左侧产品列表中选择大数据智能体工作台 DataBuddy 。
2. 调用 ListWorkspaces，查询当前地域下的工作空间列表，获取目标工作空间的 WorkspaceId。后续所有工作流接口均需传入该参数。
3. 调用 CreateWorkflow，在指定工作空间下创建工作流。必填参数为 WorkspaceId 与 BaseInfo（其中 WorkflowName 必填，且在工作空间内唯一）；如需定时调度，可通过 Trigger 配置 Cron 表达式。接口返回新建工作流的 WorkflowId。
4. 调用 ListWorkflows，分页查询工作空间下的工作流列表，确认新建的工作流已生效。支持通过 WorkflowNameKeyword 按名称模糊搜索，并通过 PageNumber、PageSize 分页。
5. 调用 GetWorkflow，传入 WorkspaceId 与 WorkflowId，查看该工作流的完整定义（基本信息、任务节点、调度、告警、参数、标签等）。
6. 完成上述步骤后，您可以继续调用 RunWorkflow 运行工作流，并通过 ListWorkflowRuns、GetWorkflowRun 查询运行记录与运行状态。

请求示例

创建工作流：

{
  "WorkspaceId": "ws-xxxxxxxx",
  "BaseInfo": {
    "WorkflowName": "daily_etl_pipeline",
    "Description": "每日 ETL 主流程"
  },
  "Trigger": [
    {
      "Type": "CRON",
      "CronExpression": "0 0 2 * * ?"
    }
  ]
}

返回结果：

{
  "Response": {
    "Data": {
      "WorkflowId": "wf-xxxxxxxx"
    },
    "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

相关接口

工作流全生命周期涉及的接口如下：