Updated on 2025-02-14 GMT+08:00

API Overview

Table 1 API Overview

Operation

API Type

Description

Console

Instance Management

Instance management APIs, which allow you to create, delete, edit, and query LakeFormation instances.

With these APIs, you can create instances and obtain information about the created instances.

Job Management

Task management APIs, which allow you to create tasks and list task information.

With these APIs, you can create and manage tasks.

Service Authorization Management

Agreement authorization management APIs, which allow you to authorize agreements, and query system and authorized agreements.

Before using LakeFormation, you need to understand and accept related agreements and authorization.

OBS Management

OBS bucket management APIs, which allow you to query OBS buckets and objects.

With these APIs, you can obtain the OBS information needed for configuring the storage path of metadata.

Access Management

Service access management APIs, which allow you to obtain access information and apply for access.

Once the service is activated and the instances are set up, LakeFormation can offer metadata management features to other services. However, these services need to connect to LakeFormation through this API before they can access the metadata management features that LakeFormation provides.

Specification Management

Specification management APIs, including APIs for querying the specification list.

Quota Management Service

Quota management APIs, including APIs for querying user quota information.

Tag Management Service

Tag management APIs, including APIs for querying resource tag sets and updating tags in batches.

Agency Management

Agency management APIs, including creating, querying, and deleting agencies.

LakeCat

Function Management

Function management APIs, which allow you to create and delete functions.

With these APIs, you can create functions and obtain information about the created functions.

Catalog Management

Catalog management APIs.

With these APIs, you can create and delete catalogs.

Database Management

Database management APIs.

With these APIs, you can create and delete databases.

Table Management

Table management APIs.

With these APIs, you can create and delete tables.

Data Table Statistics

Table statistics APIs.

With these APIs, you can obtain the column statistics of a table and delete the statistics of a specified column.

Zone-based Management

Partition management APIs.

With these APIs, you can create and delete partitions.

Partition Statistics

Partition statistics APIs.

With these APIs, you can obtain and delete partition column statistics.

Authorization Management

Authorization management APIs.

With these APIs, you can query authorization policies and perform batch authorization.

User Group Management

User group management APIs.

With these APIs, you can obtain information such as user groups of a tenant.

Metadata Statistics

Metadata statistics collection APIs, including the metadata quantity statistics APIs.

Role Management

Role management APIs, including the APIs for creating, obtaining, modifying, and deleting roles.

Credential Management

Credential management APIs, including the APIs for obtaining temporary keys and security tokens.

Configuration Management

Configuration management APIs, including the APIs for obtaining tenant plane configurations visible to all users.

User

User management APIs, including obtaining the user list, granting multiple roles to a user, removing one or more roles from a user, updating roles in a user, and querying the role list of a user.