API standards and multilingual preset SDKs
The OpenAPI of this product (DataLake/2020-07-10) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Metadata
|
API |
Title |
Description |
| Catalog | Catalog | |
| CreateCatalog | CreateCatalog | Creates a catalog. |
| DeleteCatalog | DeleteCatalog | Deletes a catalog. |
| UpdateCatalog | UpdateCatalog | Updates a catalog. |
| ListCatalogs | ListCatalogs | Retrieve catalogs. |
| GetCatalog | GetCatalog | Retrieves the details of a catalog. |
| Database | Database | |
| CreateDatabase | CreateDatabase | Creates a metadatabase in the metadata of a data lake. |
| DeleteDatabase | DeleteDatabase | Deletes a database from a catalog. |
| UpdateDatabase | UpdateDatabase | Updates the details of a database in a data lake. |
| GetDatabase | GetDatabase | Retrieves the details of a specific database in a data lake. |
| ListDatabases | ListDatabases | Retrieves a paginated list of databases in a data lake. You can match databases by name. |
| Table | Table | |
| CreateTable | CreateTable | Creates a table in a data lake. |
| DeleteTable | DeleteTable | Deletes a data table from a data lake. |
| DeleteTableColumnStatistics | DeleteTableColumnStatistics | Deletes the column statistics of a table in a data lake. |
| DeleteTableVersion | DeleteTableVersion | Deletes a specified version of a table in the data lake. |
| UpdateTable | UpdateTable | Updates the information of a data table in a data lake. |
| UpdateTableColumnStatistics | UpdateTableColumnStatistics | Creates or updates the column statistics for a data table. |
| GetTable | GetTable | Retrieves the details of a table in a data lake. |
| GetTableColumnStatistics | GetTableColumnStatistics | Retrieves statistics for specified columns in a data lake table. |
| GetTableVersion | GetTableVersion | Retrieves a specific version of a table. |
| ListTableNames | ListTableNames | Lists the names of tables in a data lake. |
| ListTables | ListTables | Retrieves a list of data tables in a data lake. |
| ListTableVersions | ListTableVersions | Performs the versions of a table. |
| GetTableProfile | GetTableProfile | Retrieves the details of a table's data profile. |
| RenameTable | RenameTable | Updates the name of a data table in a data lake. |
| BatchGetTables | BatchGetTables | Retrieves details for multiple tables in a data lake. |
| BatchCreateTables | BatchCreateTables | Creates multiple tables in a data lake. |
| BatchDeleteTables | BatchDeleteTables | Deletes multiple tables in a data lake by name. |
| BatchDeleteTableVersions | BatchDeleteTableVersions | Deletes specified versions of a data lake table in a batch. |
| BatchUpdateTables | BatchUpdateTables | Batch updates the details of tables in a data lake. |
| Partition | Partition | |
| CreatePartition | CreatePartition | Adds a partition to a data table in a data lake. |
| DeletePartition | DeletePartition | Deletes a specified partition from a table in a data lake. |
| DeletePartitionColumnStatistics | DeletePartitionColumnStatistics | Deletes the column statistics of a table partition in a data lake. |
| UpdatePartitionColumnStatistics | UpdatePartitionColumnStatistics | Creates or updates the column statistics for a data table partition. |
| GetPartition | GetPartition | Retrieves the details of a database partition in a data lake. |
| GetPartitionColumnStatistics | GetPartitionColumnStatistics | Retrieves statistics for specified columns in a data partition of a data lake. |
| ListPartitionNames | ListPartitionNames | Retrieves a list of partition names for a table in a data lake. This operation is typically used for tables with multiple partition levels. |
| ListPartitions | ListPartitions | Lists the details of database partitions in a data lake. |
| ListPartitionsByFilter | ListPartitionsByFilter | Retrieves a list of partitions for a data table in a data lake based on a filter condition. |
| BatchCreatePartitions | BatchCreatePartitions | Creates multiple partitions for a data lake table in a batch. |
| BatchDeletePartitions | BatchDeletePartitions | Deletes specified partitions from a data lake table. |
| BatchGetPartitionColumnStatistics | BatchGetPartitionColumnStatistics | Retrieves the column statistics of multiple partitions in a data lake table. |
| BatchGetPartitions | BatchGetPartitions | Retrieves the details of multiple partitions in a data lake database. |
| BatchUpdatePartitions | BatchUpdatePartitions | Performs a batch update on multiple partitions for a table in a data lake. |
| RenamePartition | RenamePartition | Renames a partition in a data lake table. |
| Function | Function | |
| CreateFunction | CreateFunction | Creates a user-defined function in a database within a data lake. |
| DeleteFunction | DeleteFunction | Deletes a user-defined function from a database in the data lake by name. |
| UpdateFunction | UpdateFunction | Updates a user-defined function in a database of a data lake. |
| ListFunctionNames | ListFunctionNames | Performs a paged query to retrieve a list of function names from a database. |
| ListFunctions | ListFunctions | Lists the user-defined functions from a database in a data lake. |
| GetFunction | GetFunction | Retrieves a user-defined function from a database in a data lake. |
| Lock | Lock | |
| CreateLock | CreateLock | Creates a metadata lock. |
| GetLock | GetLock | Queries a specified metadata lock. |
| AbortLock | AbortLock | Aborts the specified metadata lock. |
| RefreshLock | RefreshLock | Refreshes the specified metadata lock. |
| UnLock | UnLock | Releases the specified metadata lock. |
| Metadata migration | Metadata migration | |
| StopMigrationWorkflow | StopMigrationWorkflow | Stops a metadata migration task. |
| RunMigrationWorkflow | RunMigrationWorkflow | Runs a migration workflow. |
| GetAsyncTaskStatus | GetAsyncTaskStatus | Queries the status of an asynchronous task. |
| Search | Search | Retrieves metadata. |
Permission
|
API |
Title |
Description |
| CreateRole | CreateRole | Creates a DLF role. |
| GrantRoleToUsers | GrantRoleToUsers | Grants a DLF role to multiple users. |
| GrantRolesToUser | GrantRolesToUser | Grants multiple roles to a user. |
| GrantPermissions | GrantPermissions | Grants permissions on resources to DLF users and roles. |
| BatchGrantPermissions | BatchGrantPermissions | Grants permissions on resources to DLF users or roles in batches. |
| DeleteRole | DeleteRole | Deletes a DLF role. |
| RevokeRoleFromUsers | RevokeRoleFromUsers | Revokes a DLF role from multiple users. |
| RevokeRolesFromUser | RevokeRolesFromUser | Removes multiple roles from a single user. |
| RevokePermissions | RevokePermissions | Revokes permissions on resources from a DLF user or role. |
| BatchRevokePermissions | BatchRevokePermissions | Revokes one or more permissions on resources from DLF users and roles. |
| UpdateRoleUsers | UpdateRoleUsers | Updates users for a DLF role. |
| UpdatePermissions | UpdatePermissions | Updates the permissions of a user or a DLF role. |
| UpdateCatalogSettings | UpdateCatalogSettings | Updates the configuration of a catalog. This operation requires the admin role or a higher role. |
| GetRole | GetRole | Retrieves a DLF role by its name. |
| ListRoles | ListRoles | Retrieves DLF roles. |
| ListRoleUsers | ListRoleUsers | Lists the users for a specific role. |
| ListUserRoles | ListUserRoles | Retrieves the DLF roles assigned to a specific user. |
| CheckPermissions | CheckPermissions | Checks user permissions. |
| GetCatalogSettings | GetCatalogSettings | Retrieves the configuration of a catalog. This operation requires the admin role or a higher role. |
Data exploration
|
API |
Title |
Description |
| GetQueryResult | GetQueryResult | Retrieves query results. |
| SubmitQuery | SubmitQuery | Submits an SQL query. |
| CancelQuery | CancelQuery | Cancels a query. |
Common services
|
API |
Title |
Description |
| GetRegionStatus | GetRegionStatus | Retrieves the DLF activation status in a region. |
| GetServiceStatus | GetServiceStatus | Retrieves the DLF activation status for a user. |
| DescribeRegions | DescribeRegions | Retrieves a list of available regions. |
Others
|
API |
Title |
Description |
| SearchAcrossCatalog | SearchAcrossCatalog | Searches for databases, tables, and columns across catalogs. |
| RegisterLocation | RegisterLocation | Registers an Object Storage Service (OSS) path to be managed by Data Lake Formation (DLF). |
| DeregisterLocation | DeregisterLocation | Deregisters a location. |
| UpdateRegisteredLocation | UpdateRegisteredLocation | Updates a registered location. |
| ListPartitionsByExpr | ListPartitionsByExpr | Lists partitions of a table based on a conditional query. |
| GetDatabaseProfile | GetDatabaseProfile | Retrieves the database profile. |
| GetLifecycleRule | GetLifecycleRule | Retrieves the lifecycle rule of a table. |
| ListPartitionsProfile | ListPartitionsProfile | Obtains the details of a partition data profile. |
| ListPermissions | ListPermissions | Queries permissions. |
| UpdateRole | UpdateRole | Updates a role that has the data lake permissions. |