API列表
更新时间：2024-12-24
API列表
EDAP提供符合RESTful API规范的自研接口，目前已覆盖数据开发（作业开发、作业运维），其他模块接口逐步开放中。
数据开发接口
数据开发接口说明
| 类型 | API名称 | API功能 | 描述 | 调用频率限制 |
|---|---|---|---|---|
| 作业开发 | ImportWorbenchItem | 作业批量导入 | 根据category批量导入工作台草稿，仅支持若干文件夹与json文件压缩的zip | 5次/min |
| ExportWorbenchItem | 作业批量导出 | 根据categroy批量导出工作台草稿，导出为一个zip压缩文件 | 5次/min | |
| CreateExecution | 创建实例 | 创建临时执行作业实例 | 10次/min | |
| RerunExecution | 重跑实例 | 重跑临时执行实例 | 10次/min | |
| GetExecutionStatus | 获取实例状态 | 获取执行实例状态信息 | 10次/min | |
| GetExecutionLog | 获取作业实例日志 | 获取临时作业执行实例日志。 | 10次/min | |
| GetJobExecutionLog | 获取作业组实例节点日志 | 获取临时执行作业组实例的作业节点日志。 | 10次/min | |
| GetExecutionJobOutput | 获取作业组脚本运行结果 | 获取作业组中脚本作业运行的数据结果（仅对含有数据结果的脚本作业类型生效） | 10次/min | |
| 任务运维 | DeployJobgroup | 发布最新版作业组 | 上线已发布的最高版本作业组 | 5次/min |
| ListJobgroup | 获取作业组列表 | 获取作业组列表 | 50次/min | |
| DeleteJobgroup | 删除作业组 | 删除作业组 | 10次/min | |
| KillJobgroupExecution | 停止作业组实例 | 停止正在执行的作业组实例 | 10次/min |
元数据接口
元数据开发接口说明
| 类型 | API名称 | API功能 | 描述 | 调用频率限制 |
|---|---|---|---|---|
| 库 | ListDatabases | 获取数据库信息列表 | 获取数据库信息列表 | 无 |
| ListDatabaseNames | 获取数据库名称列表 | 获取数据库名称列表 | 无 | |
| GetDatabase | 获取指定数据库信息 | 获取指定数据库信息 | 无 | |
| CreateDatabase | 新增数据库信息 | 新增数据库信息 | 无 | |
| UpdateDatabase | 更新数据库信息 | 更新数据库信息 | 无 | |
| DeleteDatabase | 删除指定数据库 | 删除数据库，仅允许删除没有表的数据库。 | 无 | |
| 表 | ListTables | 获取表信息列表 | 获取表信息列表 | 无 |
| ListTableNames | 获取表名称列表 | 获取表名称列表 | 无 | |
| GetTable | 获取表信息 | 获取表信息 | 无 | |
| CreateTable | 创建表信息 | 创建表信息 | 无 | |
| UpdateTable | 更新表信息 | 更新表信息 | 无 | |
| DeleteTable | 删除表信息 | 删除表信息 | 无 | |
| ListTableVersions | 获取表版本信息列表 | 获取表版本信息列表，表版本从1开始叠加，最大1000个版本，超过1000个版本，滚动删除历史版本信息 | 无 | |
| GetTableByVersion | 获取指定版本的表信息 | 获取指定版本的表信息 | 无 | |
| 分区 | ListPartitions | 获取表分区列表信息 | 获取表分区列表信息 | 无 |
| ListPartitionNames | 获取表分区名称列表 | 获取表分区名称列表 | 无 | |
| BatchGetPartition | 批量获取表指定分区信息 | 批量获取表指定分区信息 | 无 | |
| BatchCreatePartition | 批量新增分区信息 | 批量新增分区信息 | 无 | |
| BacthAlterPartition | 批量更新表分区 | 批量更新表分区 | 无 | |
| BatchDeletePartition | 批量删除表分区 | 批量删除表分区 | 无 | |
| RenamePartition | 重命名表分区 | 重命名表分区 | 无 | |
| 函数 | ListFunctions | 获取函数信息列表 | 获取函数信息列表 | 无 |
| GetFunction | 获取函数详情 | 获取函数详情 | 无 | |
| CreateFunction | 创建函数信息 | 在指定数据库下创建函数，库下唯一，不能创建同名函数 | 无 | |
| UpdateFunction | 更新函数信息 | 更新函数信息, 除绑定的数据库和函数名不能更新，其余数据字段都可更新 | 无 | |
| DeleteFunction | 删除函数信息 | 删除函数信息 | 无 | |
| 统计信息 | SetStatistics | 更新表字段/分区统计信息 | 更新表字段/分区统计信息 | 无 |
| GetStatistics | 获取字段/分区统计信息 | 获取字段/分区统计信息 | 无 | |
| DeleteStatistics | 删除字段/分区统计信息 | 删除字段/分区统计信息 | 无 | |
| 数据湖存储 | ListLocations | 获取数据湖存储信息列表 | 获取数据湖存储信息列表 | 无 |
| GetLocations | 获取数据湖存储信息 | 获取数据湖存储信息 | 无 | |
| CreateLocation | 创建数据湖存储信息 | 创建数据湖存储信息 | 无 | |
| UpdateLocation | 更新数据湖存储信息 | 更新数据湖存储信息 | 无 | |
| DeleteLocation | 删除数据湖存储信息 | 删除数据湖存储信息 | 无 |