API description
DLF provides two APIs for different integration scenarios:
| API | Protocol | Network | Use when |
|---|---|---|---|
| API reference | Alibaba Cloud OpenAPI (ROA) | Internet | Managing the data catalog, users, roles, and permissions; querying storage metadata for data governance |
| Metadata API | Apache Paimon REST | VPC (high-speed); Internet (Paimon 1.4+) | Performing database and table operations in the data catalog, including rich features for lake tables |
API reference
The API reference is an Alibaba Cloud OpenAPI that uses the ROA (Resource-Oriented Architecture) signature style and supports access over the Internet.
Use this API to:
Manage the data catalog, users, roles, and permissions.
Query and manage databases and tables in the data catalog.
Query storage overviews for statistical analyses, metadata, and storage information to guide data governance and optimization.
Metadata API
The Metadata API is compatible with the Apache Paimon REST protocol and supports high-speed access within a Virtual Private Cloud (VPC). Starting from Paimon 1.4, it also supports public network access through OpenAPI adaptation.
Use this API to:
Perform database and table operations in the data catalog, including rich features for lake tables.
Use a standard, open source interface from Paimon.
The Metadata API has lightweight SDK dependencies—it includes only Paimon-related classes. This keeps your dependency tree clean and prevents conflicts with existing libraries in your project.