Help Center/ Data Lake Insight/ SDK Reference/ Overview
Updated on 2025-12-31 GMT+08:00
View PDF
Share

Overview

Data Lake Insight (DLI) software development kits (SDKs) encapsulate the RESTful APIs provided by DLI to simplify development.

DLI offers support for two types of SDKs: one is the API Explorer SDK, and the other is the SDK developed by DLI (including DLI SDK V1 and DLI SDK V2).

This document describes how to use the SDK developed by DLI.

Table 1 DLI SDK types

SDK

Version

Description

How to Use

API Explorer SDK

V3

The API Explorer SDK is automatically generated from the YAML files defining the APIs, ensuring parameter consistency with the service's own APIs. You can directly call the API functions offered by SDK V3 to submit both DLI SQL and DLI Spark jobs, streamlining the development process.

The SDK you download on the API Explorer page is the API Explorer SDK.

API Explorer SDK (Recommended)

SDK developed by DLI

DLI SDK V2

SDKs developed by DLI based on the general SDK V3, corresponding to the dli-sdk-x-2.x.x version in the DLI SDK installation package.

You can directly call DLI SDK V2 to submit both DLI SQL and DLI Spark jobs, streamlining the development process.

Download the DLI SDK V2 installation package on the DLI management console.

NOTE:

DLI SDK V2 is currently in the limited use phase. To use it, submit a service ticket.

  • Starting May 2024, users who use DLI for the first time can directly use DLI SDK V2 without applying for it.
  • For users who started using DLI before May 2024, to use this function, they must submit a service ticket to apply for it.

Submitting a SQL Job Using an SDK

Submitting a Spark Job Using an SDK

Submitting a Flink SQL Job Using an SDK

Submitting a Flink Jar Job Using an SDK

DLI SDK V1

SDKs developed by DLI, corresponding to the dli-sdk-x-1.x.x version in the DLI SDK installation package.

This version will be deprecated and is not recommended.

The DLI SDK calls APIs using HTTPS, with certificates utilized by the server.

DLI SDK Introduction

DLI SDKs encapsulate the RESTful APIs provided by DLI to simplify development. You can directly call the API functions offered by DLI SDKs to submit both DLI SQL and DLI Spark jobs.

DLI SDKs consist of both the API Explorer SDK and other SDKs developed by DLI.
  • (Recommended) API Explorer SDK: It is automatically generated from the YAML files defining the APIs, ensuring parameter consistency with the service's own APIs.
  • DLI SDK (self-developed): SDKs developed by the DLI team. This manual introduces the usage of DLI's self-developed SDKs.
  • The DLI SDK calls APIs using HTTPS, with certificates utilized by the server.
  • You are advised to also download the .sha256 file from the SDK installation package, as it can be used to verify the integrity of the SDK package.