API overview
Updated at:
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 data catalog. |
| DeleteCatalog | DeleteCatalog | Deletes a data catalog. |
| UpdateCatalog | UpdateCatalog | Updates a data catalog. |
| ListCatalogs | ListCatalogs | Lists catalogs. |
| GetCatalog | GetCatalog | Gets the details of a data catalog. |
| Database | Database | |
| CreateDatabase | CreateDatabase | Creates a database in the data lake. |
| DeleteDatabase | DeleteDatabase | Deletes a database in the data lake by name. |
| UpdateDatabase | UpdateDatabase | Updates a database in the data lake. |
| GetDatabase | GetDatabase | Gets the details of a database. |
| ListDatabases | ListDatabases | Lists databases with pagination and name filtering. |
| Table | Table | |
| CreateTable | CreateTable | Creates a table in the data lake. |
| DeleteTable | DeleteTable | Deletes a data table in a data lake by name. |
| DeleteTableColumnStatistics | DeleteTableColumnStatistics | Deletes column statistics of a table. |
| DeleteTableVersion | DeleteTableVersion | Deletes a specified version of a data table in the data lake. |
| UpdateTable | UpdateTable | Updates a table by name. |
| UpdateTableColumnStatistics | UpdateTableColumnStatistics | Creates or updates field statistics for a data table. |
| GetTable | GetTable | Gets the details of a table. |
| GetTableColumnStatistics | GetTableColumnStatistics | Gets column statistics of a table. |
| GetTableVersion | GetTableVersion | Gets a specified version of a data table in the data lake. |
| ListTableNames | ListTableNames | Lists table names in the data lake. |
| ListTables | ListTables | Lists tables in the data lake. |
| ListTableVersions | ListTableVersions | Lists table versions with pagination. |
| GetTableProfile | GetTableProfile | Gets a table data profile. |
| RenameTable | RenameTable | Renames a table in the data lake. |
| BatchGetTables | BatchGetTables | Gets multiple tables in a batch. |
| BatchCreateTables | BatchCreateTables | Creates multiple tables in a batch. |
| BatchDeleteTables | BatchDeleteTables | Deletes multiple data tables in a data lake by name. |
| BatchDeleteTableVersions | BatchDeleteTableVersions | Deletes multiple table versions in a batch. |
| BatchUpdateTables | BatchUpdateTables | Updates multiple tables in a batch. |
| Partition | Partition | |
| CreatePartition | CreatePartition | Creates a partition for a table. |
| DeletePartition | DeletePartition | Deletes a specified partition from a data table in the data lake. |
| DeletePartitionColumnStatistics | DeletePartitionColumnStatistics | Deletes column statistics of a partition. |
| UpdatePartitionColumnStatistics | UpdatePartitionColumnStatistics | Creates or updates the field statistics of a data table partition. |
| GetPartition | GetPartition | Gets the details of a partition. |
| GetPartitionColumnStatistics | GetPartitionColumnStatistics | Gets column statistics of a partition. |
| ListPartitionNames | ListPartitionNames | Lists partition names. Commonly used for multi-level partitioning. |
| ListPartitions | ListPartitions | Lists partitions with details. |
| ListPartitionsByFilter | ListPartitionsByFilter | Lists partitions that match a filter condition. |
| BatchCreatePartitions | BatchCreatePartitions | Creates multiple partitions in a batch. |
| BatchDeletePartitions | BatchDeletePartitions | Deletes multiple partitions of a data table in the data lake. |
| BatchGetPartitionColumnStatistics | BatchGetPartitionColumnStatistics | Gets column statistics of multiple partitions in a batch. |
| BatchGetPartitions | BatchGetPartitions | Gets multiple partitions in a batch. |
| BatchUpdatePartitions | BatchUpdatePartitions | Updates multiple partitions in a batch. |
| RenamePartition | RenamePartition | Renames a partition. |
| Function | Function | |
| CreateFunction | CreateFunction | Creates a user-defined function (UDF) for a database. |
| DeleteFunction | DeleteFunction | Deletes a user-defined function for a database in the data lake by name. |
| UpdateFunction | UpdateFunction | Updates a user-defined function (UDF) by name. |
| ListFunctionNames | ListFunctionNames | Lists function names with pagination. |
| ListFunctions | ListFunctions | Lists user-defined functions (UDFs) of a database. |
| GetFunction | GetFunction | Gets a user-defined function (UDF) by 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 | Stops a metadata migration task. |
| RunMigrationWorkflow | RunMigrationWorkflow | Runs a metadata migration task. |
| GetAsyncTaskStatus | GetAsyncTaskStatus | Gets the status of an asynchronous metadata task. |
| Search | Search | Searches metadata. |
Permissions
|
API |
Title |
Description |
| CreateRole | CreateRole | Creates a role in Data Lake Formation. |
| GrantRoleToUsers | GrantRoleToUsers | Grants a role to multiple users. |
| GrantRolesToUser | GrantRolesToUser | Grants multiple roles to a user. |
| GrantPermissions | GrantPermissions | Grants resource permissions to a user or role. |
| BatchGrantPermissions | BatchGrantPermissions | Grants resource permissions in a batch. |
| DeleteRole | DeleteRole | Deletes a role. |
| RevokeRoleFromUsers | RevokeRoleFromUsers | Removes multiple users from a single data lake role. |
| RevokeRolesFromUser | RevokeRolesFromUser | Removes multiple roles from a single user. |
| RevokePermissions | RevokePermissions | Revokes resource permissions from a user or role. |
| BatchRevokePermissions | BatchRevokePermissions | Revokes resource permissions in a batch. |
| UpdateRole | UpdateRole | Updates a role. |
| UpdateRoleUsers | UpdateRoleUsers | Updates the users assigned to a role. |
| UpdatePermissions | UpdatePermissions | Updates permissions for a user or role. |
| UpdateCatalogSettings | UpdateCatalogSettings | Updates catalog settings. Requires the admin role. |
| GetRole | GetRole | Gets a role by name. |
| ListRoles | ListRoles | Lists data lake roles. |
| ListRoleUsers | ListRoleUsers | Lists users assigned to a role. |
| ListUserRoles | ListUserRoles | Lists roles assigned to a user. |
| ListPermissions | ListPermissions | Queries permissions. |
| CheckPermissions | CheckPermissions | Verifies user permissions. |
| GetCatalogSettings | GetCatalogSettings | Gets catalog settings. Requires the admin role. |
Data exploration
|
API |
Title |
Description |
| GetQueryResult | GetQueryResult | Gets the results of a query. |
| SubmitQuery | SubmitQuery | Submits an SQL query. |
| CancelQuery | CancelQuery | Cancels a query. |
Universal Services
|
API |
Title |
Description |
| GetRegionStatus | GetRegionStatus | Gets the activation status of Data Lake Formation in a region. |
| GetServiceStatus | GetServiceStatus | Gets the service activation status for a user. |
| DescribeRegions | DescribeRegions | Lists available regions. |
Other
|
API |
Title |
Description |
| SearchAcrossCatalog | SearchAcrossCatalog | Searches across catalogs for databases, tables, and columns. |
| RegisterLocation | RegisterLocation | Registers an OSS path to be managed by DLF. |
| DeregisterLocation | DeregisterLocation | Deregisters a location. |
| UpdateRegisteredLocation | UpdateRegisteredLocation | Updates a registered location. |
| ListPartitionsByExpr | ListPartitionsByExpr | Lists partitions that match an expression. |
| GetDatabaseProfile | GetDatabaseProfile | Gets a database data profile. |
| GetLifecycleRule | GetLifecycleRule | Gets lifecycle rules for a database or table. |
| ListPartitionsProfile | ListPartitionsProfile | Lists partition data profiles. |
Is this page helpful?