API标准及多语言预置SDK
本产品（Dms/2025-04-14）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
Airflow
|
API |
标题 |
API概述 |
| CreateAirflowLoginToken | 获取Airflow登录凭证 | 通过该API可获取Airflow登录凭证，使用此登录凭证可以登录DMS托管Airflow。 |
| CreateAirflow | 创建Airflow实例 | 在工作空间下创建Airflow实例。 |
| UpdateAirflow | 更新Airflow实例信息 | 更新Airflow实例信息。 |
| GetAirflow | 获取Airflow实例详情 | 查询Airflow实例详情。 |
| ListAirflows | 获取工作空间的Airflow实例列表 | 获取工作空间的Airflow实例列表。 |
| DeleteAirflow | 删除Airflow实例 | 删除Airflow实例。 |
其他
|
API |
标题 |
API概述 |
| GetNotebookAndSubmitTask | 提交Notebook调度任务 | 调度运行Notebook文件。 |
| GetNotebookTaskStatus | 获取Notebook调度任务执行状态 | 查看Notebook任务运行结果。 |
| AddDataAgentMemory | 添加 DataAgent 记忆 | AddDataAgentMemory 添加 DataAgent 记忆 |
| AddUserToDataAgentWorkspace | 为协作空间添加成员 | 将用户添加到指定的工作空间中 |
| CheckDataAgentMemoryConfig | 查看DataAgent记忆生成/使用配置 | CheckDataAgentMemoryConfig - 查看DataAgent记忆生成/使用配置 |
| ConfigAirflow | 更新Airflow实例的自定义配置 | 更新Airflow实例的自定义配置 |
| ConfigDataAgentMemory | 配置DataAgent生成/使用记忆 | ConfigDataAgentMemory 配置DataAgent生成/使用记忆 |
| CreateAgent | 创建数据网关 Agent 身份 | 创建数据网关 Agent 身份 |
| CreateCustomAgent | 创建自定义Agent | 在个人空间、工作空间中创建自定义Agent |
| CreateDataAgentAccuracyTest | 创建准确率测试实例 | 创建准确率自测实例 |
| CreateDataAgentFeedback | 创建 DataAgent 反馈 | 创建 DataAgent 反馈 |
| CreateDataAgentKnowledgeBase | 创建DataAgent知识库 | 创建DataAgent知识库。知识库的创建人拥有有读写操作权限，空间内的其他成员拥有使用权限。 |
| CreateDataAgentSession | 创建DataAgent会话 | 创建DataAgent会话 |
| CreateDataAgentSkillMeta | 创建注册DataAgent技能 | CreateDataAgentSkillMeta 创建注册DataAgent技能 |
| CreateDataAgentTheme | 创建DataAgent主题 | CreateDataAgentTheme |
| CreateDataAgentWorkspace | 创建协作空间 | 创建DataAgent协作空间 |
| CreateOneMetaSqlTemplate | 创建SQL模版 | 创建sql模版 |
| DeleteCustomAgent | 删除自定义Agent | 在个人空间、工作空间中删除自定义Agent 注意：只有新建、已下线状态的自定义Agent才可以删除 |
| DeleteDataAgent | 释放DataAgent席位 | 释放DataAgent席位 |
| DeleteDataAgentAccuracyTest | 删除准确率测试项 | 删除准确率测试配置项 |
| DeleteDataAgentKnowledgeBase | 删除DataAgent知识库 | 删除DataAgent知识库。 |
| DeleteDataAgentMcp | 删除 Data Agent MCP 服务 | 删除指定工作空间中的 MCP Server |
| DeleteDataAgentMemory | 删除DataAgent记忆 | DeleteDataAgentMemory 删除DataAgent记忆 |
| DeleteDataAgentSkillMeta | 删除DataAgent技能 | DeleteDataAgentSkillMeta 删除DataAgent技能 |
| DeleteDataAgentWorkspace | 删除协作空间 | 删除DataAgent协作空间 |
| DeleteDocument | 删除文档 | 删除文档 |
| DeleteDocumentChunks | 删除知识块 | 删除知识块 |
| DeleteFileUpload | 删除上传文件 | DeleteFileUpload |
| DeleteOneMetaOssieModel | 删除语义模型 | 删除onemeta3.0的Ossie模型 |
| DeleteOneMetaSqlTemplate | 删除SQL模版 | 删除onemeta3.0的知识库 |
| DeleteWorkspaceCode | 删除工作空间的代码及目录 | 删除工作空间代码以及目录 |
| DescribeCustomAgent | 获取自定义Agent详细描述 | DescribeCustomAgent 根据自定义Agent ID获取详情描述信息 |
| DescribeDataAgentMetrics | 查询DataAgent指标 | 查询DataAgent指标 |
| DescribeDataAgentSession | 获取DataAgent会话描述 | 获取DataAgent会话描述信息 |
| DescribeDataAgentTheme | 查询 DataAgent 主题详情 | 调用 DescribeDataAgentTheme 接口查询单个 DataAgent 主题的详细信息，包括主题名称、阶段、来源、应用场景、描述和创建修改时间等。 |
| DescribeDocument | 查看文档详细信息 | 查看文档详细信息 |
| DescribeFileUploadSignature | 获取文件上传签名信息 | DescribeFileUploadSignature |
| DescribeKnowledgeBaseStats | 获取知识库的统计信息 | 获取知识库的统计信息 |
| DescribeKnowledgeBaseUploadSignature | 获取知识库上传文档的签名 | 获取知识库上传文档的签名 |
| DescribeSkillFileUploadSignature | 获取技能文件上传签名信息 | DescribeSkillFileUploadSignature 获取技能文件上传签名信息 |
| FileUploadCallback | 文件上传后回调 | FileUploadCallback |
| GetChatContent | 获取聊天内容 | 通过指定会话ID和AgentId，从特定检查点开始获取聊天内容。 |
| GetDataAgentMcp | 查询 Data Agent MCP 服务详情 | 根据 MCP Server ID 查询其所属工作空间、网络、连接方式和运行状态等信息。 |
| GetDataAgentSubAccountInfo | 获取主账号下的子账号信息 | 获取主账号下的子账号信息 |
| GetDataAgentTaskModelUsage | 查询DataAgent任务的模型用量信息 | 查询指定时间范围内DataAgent分析任务的模型用量汇总，包括使用的模型数、调用总次数、消耗的Token总量以及峰值TPM。 |
| GetDataAgentTaskModelUsageMetrics | 查询DataAgent分析任务模型用量时序指标 | 查询指定时间范围内DataAgent分析任务模型用量的TPM时序指标，按分钟粒度返回各时间点的Token消耗量。 |
| GetDataAgentThemeUploadSignature | 获取 DataAgent 主题上传签名 | 调用 GetDataAgentThemeUploadSignature 接口获取 DataAgent 主题文件上传所需的 OSS 直传凭证。获取凭证后，请通过 PostObject 方式将主题文件直传至 OSS，上传完成后携带返回的 ThemeId 调用 CreateDataAgentTheme 接口完成主题创建。 您可以参考 https://help.aliyun.com/zh/oss/user-guide/client-direct-transmission/ 文档完成主题上传。 |
| GetDataAgentWorkspaceInfo | 获取协作空间详细信息 | 获取协作空间详细信息 |
| GetListMcpServerToolsResult | 查询 MCP Server 工具检测结果 | 根据启动检测时返回的 Session ID 查询 MCP Server 连通性和工具列表结果。 |
| GetOneMetaOssieModel | 获取语义模型 | 获取onemeta3.0的Ossie模型 |
| GetSqlConsoleOperationLog | 查询SQL窗口操作日志 | 查询SQL窗口操作日志 |
| GetWorkspaceCode | 读取工作空间文件内容 | 读取工作空间的代码文件内容，返回文件的内容，mtime（在header中） |
| GetWorkspaceCodePublishSetting | 获取工作空间部署配置 | 获取工作空间的部署配置 |
| GetWorkspaceQuota | 获取工作空间配额 | 获取工作空间配额 |
| ImportOneMetaOssieModel | 导入语义模型 | 创建sql模版 |
| InitWorkspaceSystemMcpServer | 初始化工作空间系统 MCP 服务 | 为指定 Data Agent 工作空间安装全部当前可用的系统 MCP 服务。 |
| InstallDataAgentMcp | 导入MCP到DataAgent | InstallDataAgentMcp |
| ListAirflowVersions | 获取可用的Airflow版本列表 | 获取可用的Airflow版本列表 |
| ListCustomAgent | 获取自定义Agent列表 | ListCustomAgent 获取个人空间、工作空间中所有自定义Agent列表 |
| ListDataAgentAccuracyTestInstances | 列出准确率自测配置项 | 列出满足条件的准确率测试配置项 |
| ListDataAgentAccuracyTestResults | 获取自测任务的执行结果 | 获取自测任务的执行结果 |
| ListDataAgentAccuracyTestTasks | 列出准确率测试任务 | 分页查询自测任务运行状态 |
| ListDataAgentMcp | 查询 Data Agent MCP 服务列表 | 分页查询指定工作空间中的 MCP Server，可按名称、就绪状态和服务类型筛选。 |
| ListDataAgentMemory | 获取DataAgent记忆列表 | ListDataAgentMemory 获取DataAgent记忆列表（子账号粒度最多50条记忆） |
| ListDataAgentSession | 获取DataAgent会话列表 | 获取Data Agent历史会话描述列表。 |
| ListDataAgentSkillMeta | 获取DataAgent技能列表 | ListDataAgentSkillMeta 获取DataAgent技能列表 |
| ListDataAgentTheme | 获取 DataAgent 主题列表 | 调用 ListDataAgentTheme 接口分页查询 DataAgent 主题列表，支持按主题阶段、来源和应用场景过滤。 |
| ListDataAgentWorkspace | 获取主账号下的协作空间 | 获取主账号下的协作空间（分页） |
| ListDataAgentWorkspaceMember | 获取工作空间的成员信息 | 获取空间所有成员 |
| ListDataCenterDatabase | 获取数据中心用户上传的文件列表 | 获取数据中心用户上传的文件列表，仅支持文件类型，不支持数据库类型 |
| ListDataCenterTable | 获取数据中心用户上传的表列表 | 获取数据中心用户上传的表列表，仅支持文件类型，不支持数据库类型 |
| ListDocumentChunks | 查询知识块列表 | 查询知识块列表 |
| ListDocuments | 查询文档列表 | 查询知识库中的文档列表 |
| ListFileUpload | 获取文件上传的列表 | ListFileUpload |
| ListKnowledgeBases | 获取知识库的列表 | 分页查询知识库的列表 |
| ListOneMetaOssieModels | 批量获取语义模型 | 获取ossie模型列表 |
| ListOneMetaSqlTemplates | 批量获取SQL模版 | 获取sql模版 |
| ListWorkspaceCode | 列出工作空间里的代码文件 | 列出工作空间目录下的code文件 |
| ModifyCustomAgent | 修改自定义Agent | 在个人空间、工作空间中修改自定义Agent |
| ModifyDataAgentMcp | 修改 MCP 配置信息 | ModifyDataAgentMcp |
| ModifyDataAgentTheme | 修改 DataAgent 主题 | 调用 ModifyDataAgentTheme 接口修改 DataAgent 主题的用户展示名和描述。参数值传 null 表示不修改对应字段，传空字符串表示清空。 |
| OperateCustomAgent | 操作自定义Agent | 在个人空间、工作空间中操作自定义Agent |
| RedeployAirflow | 重新部署Airflow实例 | 重新部署Airflow实例 |
| RemoveUserToDataAgentWorkspace | 从空间中移除用户 | 从空间中移除用户 |
| RetrieveKnowledgeBase | 检索知识库 | 检索知识库 |
| SaveWorkspaceCode | 保存工作空间代码（新建、编辑） | 保存工作空间代码，如果文件不存在则自动新建 |
| SendChatMessage | 发送聊天消息 | 向指定会话发送用户消息或取消会话。 |
| SetWorkspaceCodePublishSetting | 设置工作空间的代码发布配置 | 设置工作空间代码部署配置。这是个异步接口，请求返回一个key，请根据key查询 WorkspaceActionStatus接口获取状态 |
| SetWorkspaceQuota | 设置工作空间配额 | 设置工作空间配额 |
| StartDataAgentAccuracyTestTask | 启动自测任务 | 发起准确率自测任务 |
| StartListMcpServerTools | 启动 MCP Server 工具连通性检测 | 异步启动 MCP Server 连通性和工具列表检测，首次调用会提示需要等待一分钟拉起资源，后再次调用将返回用于轮询结果的临时 Session ID。 |
| StopDataAgentAccuracyTestTask | 停止准确率测试任务 | 停止准确率自测任务 |
| UpdateDataAgentAccuracyTest | 更新准确率测试项 | 更新准确率测试项内容 |
| UpdateDataAgentMemory | 更新DataAgent记忆 | UpdateDataAgentMemory 更新DataAgent记忆 |
| UpdateDataAgentSpaceInfo | 更新空间的信息 | 更新空间的信息 |
| UpdateDataAgentWorkspaceMemberRole | 调整空间成员的角色 | 调整空间成员的角色 |
| UpdateDocument | 更新文档 | 更新文档的描述信息 |
| UpdateKnowledgeBase | 更新知识库 | 更新知识库 |
| UpdateOneMetaOssieModel | 更新语义模型 | 更新sql模版 |
| UpdateOneMetaSqlTemplate | 更新SQL模版 | 更新sql模版 |
| UploadDocument | 上传文档 | 上传文档到知识库 |
| UpsertDocumentChunks | 更新知识块 | 更新知识块 |
| WorkspaceActionLog | 异步任务日志查看 | 工作空间异步操作日志查询接口 |
| WorkspaceActionStatus | 异步任务状态查看 | 工作空间异步操作状态查询接口，比如部署代码接口返回一个key，根据这个key来查这个status接口，即可获取到状态 |
| WorkspaceCodePublish | 工作空间代码部署 | 工作空间代码部署接口。这是个异步接口，请求返回一个key，请根据key查询 WorkspaceActionStatus接口获取状态 |
该文章对您有帮助吗？