Updated on 2023-03-20 GMT+08:00


This section describes the APIs provided by DLI.

Table 1 DLI APIs




Permission-related APIs


You can assign permissions to queues, view queue users, assign data permissions, view database users, view table users, view table user permissions, and view the permissions of authorized users.

Agency-related APIs


Obtain the DLI agency information and create a DLI agency.

Queue-related APIs (Recommended)


You can create queues, delete queues, query all queues, modify the CIDR block of a queue, restart, scale out, or scale in a queue, query queue details, create a request for testing the connectivity of a specified address, query the connectivity of a specified address, create a scheduled queue scaling plan, query a scheduled queue scaling plan, delete scheduled queue scaling plans in batches, and delete or modify a scheduled queue scaling plan.

APIs Related to SQL Jobs

Database-related APIs

You can create a database, delete a database, view all databases, and modify database users.

Table-related APIs

You can create, delete, and query tables, describe table information, preview table content, modify table users, and obtain the partition information list.

Job-related APIs

You can import and export data, submit SQL jobs, cancel jobs, query all jobs, preview job results, query job status, query job details, check SQL syntax, and export query results.

Package Group-related APIs


You can upload a group resource, query the group resource list, upload a group resource in JAR format, upload a PyFile group resource, upload a File type group resource, query a resource package in a group, delete a resource package in a group, and change the owner of a group or resource package.

APIs Related to Flink Jobs


You can authorize DLI to OBS, create and update SQL jobs and user-defined Flink jobs, run jobs in batches, query the job list, job details, job execution plans, and job monitoring information. You can also stop jobs in batches, delete and batch delete jobs, export and import Flink jobs, create static flow diagrams for Flink SQL jobs, create IEF message channels, report Flink job status and callback Flink job actions at the edge, and report IEF system events.

APIs related to Spark jobs

Batch Processing-related APIs

Creating batch jobs, cancel batch jobs, querying batch job lists, querying batch job details, querying batch job status, and querying batch job logs.

APIs Related to Flink Job Templates


You can create, update, and delete a template, and query the template list.

APIs Related to Enhanced Datasource Connections


You can create and delete enhanced datasource connections, query the enhanced datasource connection list as well as the connections, bind and unbind queues, modify host information, and query enhanced datasource connection permissions.

APIs Related to Global Variables


You can create, delete, modify, and query global variables.