API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (DataLake/2020-07-10) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Metadata
|
API |
Title |
Description |
| Catalog | Catalog | |
| CreateCatalog | CreateCatalog | Create a Data Catalog for Data Lake. |
| DeleteCatalog | DeleteCatalog | Deletes a data directory. |
| UpdateCatalog | UpdateCatalog | Updates the contents of the Data Catalog. |
| ListCatalogs | ListCatalogs | You can call this operation to query the list of metabase namespaces (catalogs). |
| GetCatalog | GetCatalog | Obtains the details of a data directory. |
| Database | Database | |
| CreateDatabase | CreateDatabase | Create a metadabase in the data lake metadata. |
| DeleteDatabase | DeleteDatabase | Deletes a database in the data lake by name. |
| UpdateDatabase | UpdateDatabase | Update the details of a database in the data lake. |
| GetDatabase | GetDatabase | Obtains the details of a database in a data lake. |
| ListDatabases | ListDatabases | Obtains a list of databases in the data lake and queries them by page. You can match them based on the database name. |
| Table | Table | |
| CreateTable | CreateTable | Add a data table for the data lake. |
| DeleteTable | DeleteTable | Deletes a data table in a data lake by name. |
| DeleteTableColumnStatistics | DeleteTableColumnStatistics | Recycle field statistics for data tables in the data lake. |
| DeleteTableVersion | DeleteTableVersion | Deletes a specified version of a data table in the data lake. |
| UpdateTable | UpdateTable | Update the data table information in the data lake based on the name. |
| UpdateTableColumnStatistics | UpdateTableColumnStatistics | Creates or updates field statistics for a data table. |
| GetTable | GetTable | Get detailed information about the data tables in the data lake. |
| GetTableColumnStatistics | GetTableColumnStatistics | You can call this operation to obtain statistics about a specified field in a data table in a data lake. |
| GetTableVersion | GetTableVersion | Gets a specified version of a data table in the data lake. |
| ListTableNames | ListTableNames | This function is used only to query the names of data tables in Data Lake. |
| ListTables | ListTables | You can call this operation to obtain a list of data tables in the data lake. |
| ListTableVersions | ListTableVersions | Queries the list of specified versions of data tables in a data lake by page. |
| GetTableProfile | GetTableProfile | Obtains the details of a table data profile. |
| RenameTable | RenameTable | is used only to update the name of a data table in the data lake. |
| BatchGetTables | BatchGetTables | Obtain detailed information about data tables in the data lake in batches. |
| BatchCreateTables | BatchCreateTables | Add data tables to a data lake at a time. |
| BatchDeleteTables | BatchDeleteTables | Deletes multiple data tables in a data lake by name. |
| BatchDeleteTableVersions | BatchDeleteTableVersions | Deletes a specified version of a data table in a data lake at a time. |
| BatchUpdateTables | BatchUpdateTables | Update the details of data tables in the data lake in batches. |
| Partition | Partition | |
| CreatePartition | CreatePartition | Add a partition to the data table of the data lake. |
| DeletePartition | DeletePartition | Deletes a specified partition from a data table in the data lake. |
| DeletePartitionColumnStatistics | DeletePartitionColumnStatistics | Reclaim the field statistics of data table partitions in the data lake. |
| UpdatePartitionColumnStatistics | UpdatePartitionColumnStatistics | Creates or updates the field statistics of a data table partition. |
| GetPartition | GetPartition | Get details about the database partitions in the data lake. |
| GetPartitionColumnStatistics | GetPartitionColumnStatistics | Obtains the statistics of a specified field for a data partition in a data lake. |
| ListPartitionNames | ListPartitionNames | You can call this operation to obtain a list of partition names of data tables in a data lake. This method is usually used for multi-level partitioning. |
| ListPartitions | ListPartitions | Obtains a list of database partition details in the data lake. |
| ListPartitionsByFilter | ListPartitionsByFilter | Obtain the list of data table partitions in the data lake and query them by filter condition. |
| BatchCreatePartitions | BatchCreatePartitions | Add multiple partitions to a data table in a data lake at a time. |
| BatchDeletePartitions | BatchDeletePartitions | Deletes multiple partitions of a data table in the data lake. |
| BatchGetPartitionColumnStatistics | BatchGetPartitionColumnStatistics | Obtains the field statistics of data table partitions in a data lake at a time. |
| BatchGetPartitions | BatchGetPartitions | Obtains the details of database partitions in a data lake in batches. |
| BatchUpdatePartitions | BatchUpdatePartitions | Batch update multiple partitions for a data table in a data lake. |
| RenamePartition | RenamePartition | Update the partition name of the data table in the data lake. |
| Function | Function | |
| CreateFunction | CreateFunction | Added user-defined functions for databases in the data lake. |
| DeleteFunction | DeleteFunction | Deletes a user-defined function for a database in the data lake by name. |
| UpdateFunction | UpdateFunction | Updates the user-defined function information for a database in the data lake by name. |
| ListFunctionNames | ListFunctionNames | Paged query to obtain the list of function names of the database. |
| ListFunctions | ListFunctions | Obtains a list of user-defined functions for databases in the data lake in bulk. |
| GetFunction | GetFunction | Obtain the user-defined function of the database in the data lake based on the function name. |
| Lock | Lock | |
| CreateLock | CreateLock | Creates a specified metadata lock. |
| GetLock | GetLock | Queries the specified metadata lock. |
| AbortLock | AbortLock | Aborts the specified metadata lock. |
| RefreshLock | RefreshLock | Refreshes the specified metadata lock. |
| UnLock | UnLock | Unlocks the specified metadata lock. |
| Metadata Migration | Metadata Migration | |
| StopMigrationWorkflow | StopMigrationWorkflow | Stop the metadata migration task. |
| RunMigrationWorkflow | RunMigrationWorkflow | Runs a metadata migration task. |
| GetAsyncTaskStatus | GetAsyncTaskStatus | Used in metadata-related asynchronous APIs to check the status of asynchronous execution tasks. |
| Search | Search | Metadata retrieval. |
Permissions
|
API |
Title |
Description |
| CreateRole | CreateRole | In the Data Lake Permissions section, add a role. |
| GrantRoleToUsers | GrantRoleToUsers | Grant a Data Lake role to multiple users. |
| GrantRolesToUser | GrantRolesToUser | Grant multiple roles to a single user. |
| GrantPermissions | GrantPermissions | Grant the operation permissions on resources to the User /Data Lake role. |
| BatchGrantPermissions | BatchGrantPermissions | Grant the operation permissions on resources to a user or a data lake role at a time. |
| DeleteRole | DeleteRole | Delete a role from Data Lake Permissions. |
| RevokeRoleFromUsers | RevokeRoleFromUsers | Removes multiple users from a single data lake role. |
| RevokeRolesFromUser | RevokeRolesFromUser | Removes multiple roles from a single user. |
| RevokePermissions | RevokePermissions | Cancels the operation permissions on resources granted to a User /Data Lake role. |
| BatchRevokePermissions | BatchRevokePermissions | You can call this operation to revoke permissions on resources from a user or data lake role at a time. |
| UpdateRole | UpdateRole | Updates a role that has the data lake permissions. |
| UpdateRoleUsers | UpdateRoleUsers | Update the user in the role to include ram user/ram role. |
| UpdatePermissions | UpdatePermissions | Update the permissions of the User /Data Lake role. |
| UpdateCatalogSettings | UpdateCatalogSettings | To update the configurations of Data Lake Catalog, you must assume the admin role or more. |
| GetRole | GetRole | Obtain the role in Data Lake Permissions based on the role name. |
| ListRoles | ListRoles | You can query the list of data lake roles. |
| ListRoleUsers | ListRoleUsers | Gets the list of users for a single role. |
| ListUserRoles | ListUserRoles | Obtains the list of data lake roles for a single user. |
| ListPermissions | ListPermissions | Queries permissions. |
| CheckPermissions | CheckPermissions | Verify user permissions. |
| GetCatalogSettings | GetCatalogSettings | To obtain the configurations of Data Lake Catalog, you must assume the admin role or above. |
Data exploration
|
API |
Title |
Description |
| GetQueryResult | GetQueryResult | Obtains the results of a data exploration query. |
| SubmitQuery | SubmitQuery | Submit an SQL query task. |
| CancelQuery | CancelQuery | Cancel a query request. |
Universal Services
|
API |
Title |
Description |
| GetRegionStatus | GetRegionStatus | You can Data Lake Formation the activation status of the service in the specified region. |
| GetServiceStatus | GetServiceStatus | Obtains the service activation status of a Data Lake Formation user. |
| DescribeRegions | DescribeRegions | Obtains the list of open regions. |
Other
|
API |
Title |
Description |
| SearchAcrossCatalog | SearchAcrossCatalog | Search across catalogs for content such as libraries, tables, and fields. |
| RegisterLocation | RegisterLocation | Register the OSS path to be managed by DLF. |
| DeregisterLocation | DeregisterLocation | Cancel Location registration. |
| UpdateRegisteredLocation | UpdateRegisteredLocation | Edit a Registered Location. |
| ListPartitionsByExpr | ListPartitionsByExpr | Obtains a list of data table partitions in the data lake and queries them by condition. |
| GetDatabaseProfile | GetDatabaseProfile | Gets the details of the database data profile. |
| GetLifecycleRule | GetLifecycleRule | Obtains the lifecycle rules of a database and table. |
| ListPartitionsProfile | ListPartitionsProfile | Obtains the details of a partition data profile. |