Updated on 2025-09-16 GMT+08:00

Before You Start

Welcome to Data Lake Insight API Reference.

Data Lake Insight (DLI) is a serverless data processing and analysis service fully compatible with Apache Spark, Apache Flink, and HetuEngine ecosystems. It requires no server management and is ready for immediate use. DLI supports multiple querying methods including standard SQL, Spark SQL, and Flink SQL, with compatibility with mainstream data formats. DLI supports SQL statements and Spark applications for heterogeneous data sources, including CloudTable, RDS, GaussDB(DWS), CSS, OBS, custom databases on ECSs, and offline databases.

You can use the APIs provided in this document to perform various operations on DLI, including managing queues, running SQL jobs, running Flink jobs, running Spark jobs, and setting up datasource connections. For a full list of supported operations, refer to Overview.

Before calling DLI APIs, make sure you fully understand the relevant concepts of DLI. For details, see Data Lake Insight Service Overview.

API Calling

DLI provides representational state transfer (RESTful) APIs, allowing you to call them using HTTPS. For detailed calling methods, see Calling APIs.

Unless otherwise specified, DLI APIs are typically synchronous operations, where is_success in the response message indicates whether the request was successfully executed.

If the API is an asynchronous operation, you can execute Querying Job Status API based on the job_id in the response message to determine if the asynchronous operation API was successfully executed.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

Notes and Constraints

  • The number of resources that you can create is determined by your quota. To view service quotas or increase them, see How Do I Apply for a Higher Quota?
  • For detailed constraints, see the constraints described in specific APIs.

Basic Concepts

  • Account

    An account is created when registering with Huawei Cloud. The account has full access permissions for all its resources and services, enabling it to reset user passwords and grant user permissions. The account serves as the billing entity. To ensure account security, create Identity and Access Management (IAM) users and grant them permissions for routine management.

  • User

    An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).

    An IAM user can view the project ID on the My Credentials page of the console. The account name, username, and password will be required for API authentication.

  • Region

    Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified as common regions and dedicated regions. A common region provides common cloud services that should be made available to all tenants. A dedicated region provides services of a specific type or only for specific tenants.

    For details, see Region and AZ.

  • Availability zone (AZ)

    An AZ consists of one or more physical data centers with independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, networking, storage, and other resources are logically partitioned into multiple clusters. Multiple AZs within a region are connected using high-speed fiber optics to support highly available systems across AZs.

  • Project

    A Huawei Cloud region corresponds to a project by default. This project is predefined by the system to isolate resources (including compute, storage, and networking resources) across physical regions. You can grant permissions to users to access all resources in a specific project. For more refined access control, you can create subprojects under the default project of a region, purchase resources within these subprojects, and grant permissions at the subproject level. This ensures that users can only access resources within specific subprojects, thereby achieving more precise resource permission management.

    Figure 1 Project isolating model

    To view a project ID, go to the My Credentials page.

  • Enterprise project

    Enterprise projects group and logically isolate resources. An enterprise project can contain resources from different regions, and resources can be transferred between enterprise projects.

    For details about how to obtain enterprise project IDs and features, see Enterprise Management Service User Guide.