API概览

本产品(Dms/2025-04-14)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

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概述

ListDataLakeDatabase 获取数据湖的数据库列表 调用此API可以获取数据湖的数据库列表。
GetDataLakeDatabase 获取数据湖的数据库信息 调用此API可以获取数据湖中的数据库信息。
ListDataLakeCatalog 获取数据湖的数据目录列表 调用此API可以获取数据湖的数据目录列表。
GetDataLakeCatalog 获取数据湖的数据目录 调用此API可以获取数据湖的数据目录。
ListDataLakeTablebaseInfo 获取数据湖中表的基本信息 调用此API可以获取数据湖中表的基本信息。
GetDataLakeTable 获取数据湖的表信息 调用此API可以获取数据湖的表信息。
BatchCreateDataLakePartitions 批量新建湖仓表分区 调用此API可批量新建湖仓表分区。
UpdateDataLakeTable 更新湖仓表信息 调用此API可更新湖仓表信息。
UpdateDataLakePartition 更新湖仓表分区信息 调用此API可更新湖仓表分区信息。
UpdateDataLakeDatabase 更新湖仓数据库信息 调用此API可更新湖仓数据库信息。
ListDataLakeTableName 获取数据湖表名列表 调用此API可获取数据湖表名列表。
ListDataLakeTable 获取数据湖表列表 调用此API可获取数据湖表列表。
ListDataLakePartitionName 获取数据湖表分区名列表 调用此API可获取数据湖表分区名列表。
ListDataLakePartitionByFilter 根据筛选条件获取数据湖表分区列表 调用此API可根据筛选条件获取数据湖表分区列表。
ListDataLakePartition 获取数据湖表分区列表 调用此API可获取数据湖表分区列表。
GetDataLakePartition 获取湖仓表分区详情 调用此API可获取湖仓表分区详情。
DeleteDataLakeTable 删除湖仓表 调用此API可删除湖仓表。
DeleteDataLakePartition 删除湖仓表分区 调用此API可删除湖仓表分区。
DeleteDataLakeDatabase 删除湖仓数据库 调用此API可删除湖仓数据库。
CreateDataLakeTable 新建湖仓表 调用此API可新建湖仓表。
CreateDataLakePartition 创建湖仓表分区 调用此API可新建湖仓表分区。
CreateDataLakeDatabase 创建湖仓数据库 调用此API可新建湖仓数据库。
BatchUpdateDataLakePartitions 批量更新湖仓表分区 调用此API可批量更新湖仓表分区信息。
BatchDeleteDataLakePartitions 批量删除湖仓表分区 调用此API可批量删除湖仓表分区。
CreateDataLakeFunction 新建数据湖自定义函数 调用此API可以新建湖仓自定义函数。
GetDataLakeFunction 获取湖仓自定义函数的详细信息 调用此API可获取湖仓自定义函数的详细信息。
UpdateDataLakeFunction 更新湖仓自定义函数 调用此API可更新湖仓自定义函数。
DeleteDataLakeFunction 删除湖仓自定义函数 调用此API可删除湖仓自定义函数。
ListDataLakeFunction 获取数据湖函数列表 调用此API可获取数据湖函数列表。
ListDataLakeFunctionName 获取数据湖函数名称列表 调用此API可获取数据湖函数名称列表。

其他

API

标题

API概述

GetNotebookAndSubmitTask 提交Notebook调度任务 调度运行Notebook文件。
GetNotebookTaskStatus 获取Notebook调度任务执行状态 查看Notebook任务运行结果。