更新时间:2022-12-07 GMT+08:00

API概览

本章节介绍了目前DLI所提供的API列表。

表1 DLI API列表

类型

子类型

说明

权限相关API

-

包括队列赋权、查看队列的使用者、数据赋权、查看数据库的使用者、查看表的使用者、查看表的用户权限和查看赋权对象使用者权限信息。

委托相关API

-

包括获取DLI委托信息和创建DLI委托。

队列相关API(推荐)

-

包括创建队列、删除队列、查询所有队列、修改队列网段、重启/扩容/缩容队列和查询队列详情、创建指定地址连通性测试请求、查询指定地址连通性请求、创建队列定时扩缩容计划、查询队列定时扩缩容计划、批量删除队列定时扩缩容计划、单个删除队列定时扩缩容计划、修改队列定时扩缩容计划。

SQL作业相关API

数据库相关API

包括创建数据库、删除数据库、查看所有数据库和修改数据库用户。

表相关API

包括创建表、删除表、查询所有表、描述表信息、预览表内容、修改表用户和获取分区信息列表。

作业相关API

包括导入数据、导出数据、提交SQL作业、取消作业、查询所有作业、预览作业结果、查询作业状态、查询作业详细信息、检查SQL语法和导出查询结果。

分组资源相关API

-

包括上传分组资源、查询分组资源列表、上传jar类型分组资源、上传pyfile类型分组资源、上传file类型分组资源、查询组内资源包、删除组内资源包和修改组或资源包拥有者。

Flink作业相关API

-

包括OBS授权给DLI服务、新建SQL作业、更新SQL作业、新建Flink自定义作业、更新Flink自定义作业、批量运行作业、查询作业列表、查询作业详情、查询作业执行计划、查询作业监控信息、批量停止作业、删除作业、批量删除作业、导出Flink作业、导入Flink作业、创建IEF消息通道、边缘Flink作业状态上报、边缘Flink作业Action回调、IEF系统事件上报。

Spark作业相关API

批处理相关API

包括创建批处理作业、取消批处理作业、查询批处理作业列表、查询批处理作业详情、查询批处理作业状态和查询批处理作业日志。

Flink作业模板相关API

-

包括新建模板、更新模板、删除模板和查询模板列表。

增强型跨源连接相关API

-

包括创建增强型跨源连接、删除增强型跨源连接、查询增强型跨源连接列表、查询增强型跨源连接、绑定队列、解绑队列、修改主机信息和查询增强型跨源授权信息。

全局变量相关API

-

包括创建全局变量、删除全局变量、修改全局变量和查询所有全局变量。

弹性资源池相关API

-

包括创建弹性资源池、查询所有弹性资源池、删除弹性资源池、修改弹性资源池信息等。

跨源认证相关API

-

包括创建跨源认证、获取跨源认证列表、更新跨源认证、删除跨源认证API。

跨源相关API

-

包括创建跨源连接需要的路由和删除路由的API。

模板相关API

-

包括保存SQL模板、创建作业模板等模板相关API。