API standards and multilingual preset SDKs
The OpenAPI of this product (DlfNext/2025-03-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.
API catalog
|
API |
Title |
Description |
| AlterCatalog | AlterCatalog | Updates a catalog. |
| AlterDatabase | AlterDatabase | Updates a database. |
| AlterReceiver | Update a sink | Updates a sink. |
| AlterShare | AlterShare | Updates a share. |
| AlterShareReceivers | AlterShareReceivers | Updates the receivers of a share. |
| AlterShareResources | AlterShareResources | Modifies shared resources. |
| AlterTable | AlterTable | Updates a table. |
| AlterTableSchema | Modify table schema | Changes the table schema. |
| BatchGrantPermissions | BatchGrantPermissions | Grants permissions to one or more DLF users or roles. |
| BatchRevokePermissions | BatchRevokePermissions | Revokes permissions in a batch. |
| CreateCatalog | CreateCatalog | Creates a catalog. |
| CreateDatabase | CreateDatabase | Creates a database. |
| CreateReceiver | CreateReceiver | Creates a receiver. |
| CreateRole | CreateRole | Creates a DLF role. |
| CreateShare | CreateShare | Creates a share. |
| CreateTable | CreateTable | Creates a table. |
| DeleteRole | DeleteRole | Deletes a DLF role. |
| DescribeRegions | DescribeRegions | Retrieves the regions where DLF is activated. |
| DropCatalog | Delete a data lake data catalog | Deletes a data lake data catalog. The following conditions must be met, otherwise the deletion will fail: all tables and user-created databases under the catalog have been deleted; the databases and tables have been deleted for at least 24 hours. |
| DropDatabase | DropDatabase | Drops a database. |
| DropReceiver | DropReceiver | Removes a receiver. |
| DropShare | DropShare | Deletes a share. |
| DropTable | DropTable | Drops a table. |
| GetCatalog | GetCatalog | Retrieves the details of a catalog. |
| GetCatalogById | GetCatalogById | Retrieves the details of a catalog. |
| GetCatalogSummary | GetCatalogSummary | Retrieves the storage overview of a data catalog. |
| GetCatalogSummaryTrend | GetCatalogSummaryTrend | Retrieves the storage overview trend for a catalog. |
| GetCatalogToken | GetCatalogToken | Obtains a temporary access credential (token) for a catalog. |
| GetDatabase | GetDatabase | Retrieves the details of a database. |
| GetDatabaseSummary | GetDatabaseSummary | You can view an inventory overview. |
| GetIcebergNamespace | GetIcebergNamespace | Retrieves information about an Iceberg namespace. |
| GetIcebergTable | GetIcebergTable | Retrieves the details of a table. |
| GetReceiver | GetReceiver | Retrieves a receiver. |
| GetRegionStatus | GetRegionStatus | Queries the DLF activation status of in a region. |
| GetRole | GetRole | Retrieves a role. |
| GetShare | GetShare | Retrieves the details of a share. |
| GetTable | GetTable | Retrieves the details of a table in a data lake. |
| GetTableCompaction | GetTableCompaction | Retrieves the compaction details of a table. |
| GetTableSnapshot | GetTableSnapshot | Queries a table snapshot. |
| GetTableSummary | GetTableSummary | Retrieves the storage summary for a table. |
| GetTableToken | GetTableToken | Obtains a temporary access credential for a data lake table. |
| GetUser | GetUser | Retrieves a user. |
| GetVpcConfig | GetVpcConfig | Obtain the VPC configuration. |
| GrantRoleToUsers | GrantRoleToUsers | Grants a role to one or more users. |
| ListCatalogs | ListCatalogs | Lists catalogs. |
| ListDatabaseDetails | ListDatabaseDetails | Retrieves database details. |
| ListDatabases | ListDatabases | Retrieves databases. |
| ListFunctions | ListFunctions | Lists functions. |
| ListIcebergNamespaceDetails | ListIcebergNamespaceDetails | Lists Iceberg namespaces. |
| ListIcebergSnapshots | ListIcebergSnapshots | Lists the snapshots of an Iceberg table. |
| ListIcebergTableDetails | ListIcebergTableDetails | Lists the details of Iceberg tables. |
| ListPartitionSummaries | ListPartitionSummaries | Retrieves storage overview for partitions. |
| ListPartitions | ListPartitions | Lists partitions. |
| ListPartitionsByNames | Retrieve partitions by name | Retrieves a list of partitions by their names. |
| ListPermissions | ListPermissions | Retrieves the permissions for a resource or principal. |
| ListProvidedShares | ListProvidedShares | Retrieves shares. |
| ListReceivedShares | ListReceivedShares | Retrieves received shares. |
| ListReceivers | ListReceivers | Queries a list of receivers. |
| ListRoleUsers | ListRoleUsers | Retrieves the users for a role. |
| ListRoles | ListRoles | Retrieves roles. |
| ListShareReceivers | ListShareReceivers | Gets the receivers of a share. |
| ListShareResources | ListShareResources | Retrieves shared resources. |
| ListSnapshots | ListSnapshots | Returns a list of table snapshots. |
| ListTableDetails | ListTableDetails | Lists the details of one or more tables. |
| ListTables | ListTables | Retrieves a list of tables. |
| ListUserRoles | ListUserRoles | Retrieves the roles assigned to a user. |
| ListUsers | ListUsers | Retrieves a list of users. |
| ListViewDetails | ListViewDetails | Lists the details of one or more views. |
| ListViews | ListViews | Returns the names of views. |
| RefreshUserSync | RefreshUserSync | Syncs users. |
| RevokeRoleFromUsers | RevokeRoleFromUsers | Revokes a role from one or more users. |
| RollbackTable | RollbackTable | Rolls back a table. |
| Subscribe | Subscribe | Subscribes to DLF in the current region. |
| UpdateRole | UpdateRole | Updates a DLF role. |
| UpdateRoleUsers | UpdateRoleUsers | Updates the users for a role. |