本产品（
数据湖构建/2025-03-10）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
通用服务
| API | 标题 | API概述 |
|---|---|---|
| Subscribe | 订阅当前地域的 DLF | 订阅当前地域的 DLF。 |
| DescribeRegions | 查询 DLF 开通地域 | 查询 DLF 开通地域。 |
| GetRegionStatus | 查询 DLF 当前地域开通状态 | 查询 DLF 当前地域开通状态。 |
数据目录
| API | 标题 | API概述 |
|---|---|---|
| CreateCatalog | 创建数据湖数据目录 | 创建数据目录。 |
| GetCatalog | 获取目录详情 | 获取数据目录详情。 |
| GetCatalogById | 获取目录详情 | 获取数据目录详情。 |
| AlterCatalog | 更新数据目录 | 更新数据目录。 |
| DropCatalog | 删除数据湖数据目录 | 删除数据目录。 |
| ListCatalogs | 获取数据目录列表 | 查看数据目录列表。 |
| GetCatalogToken | 获取数据目录的临时访问凭证 | 获取数据湖Catalog的临时访问凭证。 |
数据库
| API | 标题 | API概述 |
|---|---|---|
| GetDatabase | 获取数据库详情 | 获取数据湖具体的一个数据库的详细信息。 |
| CreateDatabase | 创建数据库 | 创建数据库。 |
| AlterDatabase | 更新数据库信息 | 更新数据库。 |
| DropDatabase | 删除数据库 | 删除数据湖中的数据库。 |
| ListDatabases | 获取数据库列表 | 查看数据库列表。 |
| ListDatabaseDetails | 获取数据库详细列表 | 获取数据湖中数据库列表，分页查询。 |
数据表
| API | 标题 | API概述 |
|---|---|---|
| GetTable | 获取数据表详情 | 获取数据湖中数据表的详细信息。 |
| CreateTable | 新增数据表 | 创建数据湖的数据表。 |
| AlterTable | 更新数据表信息 | 根据名称更新数据湖中数据表信息。 |
| DropTable | 删除数据表 | 删除数据湖的数据表。 |
| RollbackTable | 回滚表 | 回滚表。 |
| ListTables | 获取数据表列表 | 获取数据湖中数据表列表。 |
| ListTableDetails | 获取数据表详细列表 | 查看表详情列表。 |
| GetTableSnapshot | 获取表快照 | 查看表快照。 |
| ListSnapshots | 获取快照列表 | 查看表快照列表。 |
| GetTableToken | 获取表数据的临时访问凭证 | 获取数据湖表的临时访问凭证 |
数据共享
| API | 标题 | API概述 |
|---|---|---|
| CreateShare | 创建共享 | 创建共享。 |
| GetShare | 获取共享 | 获取共享。 |
| AlterShare | 变更共享 | 更新共享。 |
| DropShare | 删除共享 | 删除共享。 |
| ListProvidedShares | 获取提供的共享列表 | 获取提供的共享列表。 |
| ListReceivedShares | 获取接收的共享列表 | 获取接收的共享列表。 |
| CreateReceiver | 创建接收者 | 创建接收者。 |
| GetReceiver | 获取接收者 | 获取接收者。 |
| AlterReceiver | 变更接收者 | 更新接收者。 |
| DropReceiver | 删除接收者 | 删除接收者 |
| ListReceivers | 获取接收者列表 | 获取接收者列表 |
| ListShareReceivers | 获取共享接收列表 | 获取共享中的接收者列表 |
| AlterShareReceivers | 变更共享接收者 | 更新共享中的接收者 |
| AlterShareReceivers | 变更共享接收者 | 更新共享中的接收者 |
| AlterShareResources | 变更共享资源 | 更改共享资源。 |
| ListShareResources | 获取共享资源列表 | 获取共享资源列表 |
权限
| API | 标题 | API概述 |
|---|---|---|
| BatchGrantPermissions | 批量对User/数据湖角色授予资源的操作权限 | 批量授权。 |
| BatchRevokePermissions | 批量取消对User/数据湖角色授予的权限 | 批量取消授权。 |
| ListPermissions | 获取权限列表 | 获取指定资源或指定Principal的权限信息。 |
用户和角色
| API | 标题 | API概述 |
|---|---|---|
| CreateRole | 创建角色 | 创建角色。 |
| GetRole | 获取角色 | 获取角色。 |
| UpdateRole | 更新角色 | 更新角色。 |
| DeleteRole | 删除角色 | 删除角色。 |
| ListRoles | 获取角色列表 | 获取角色列表。 |
| GetUser | 获取用户 | 获取用户。 |
| ListUsers | 获取用户列表 | 获取用户列表。 |
| ListRoleUsers | 获取角色用户列表 | 获取角色用户列表。 |
| UpdateRoleUsers | 更新角色用户 | 更新角色用户。 |
| ListUserRoles | 获取用户角色列表 | 获取用户角色列表。 |
| GrantRoleToUsers | 将角色授予用户 | 批量授予角色权限给用户。 |
| RevokeRoleFromUsers | 将用户从角色中移除 | 将多个用户从角色中移除。 |
| RefreshUserSync | 用户同步 | 刷新用户同步。 |
存储概览
| API | 标题 | API概述 |
|---|---|---|
| GetCatalogSummary | 获取数据目录存储概览 | 获取数据目录存储概览。 |
| GetCatalogSummaryTrend | 获取数据目录存储概览趋势 | 获取数据目录存储概览趋势。 |
| GetDatabaseSummary | 获取库存储概览 | 获取库存储概览。 |
| GetTableSummary | 获取表存储概览 | 获取表存储概览。 |
| ListPartitionSummaries | 获取分区存储概览列表 | 获取分区存储概览列表。 |
ICEBERG
| API | 标题 | API概述 |
|---|---|---|
| ListIcebergTableDetails | 获取Iceberg数据表详细列表 | 查看iceberg表详情列表 |
| ListIcebergSnapshots | 获取快照列表 | 查看iceberg表快照列表 |
| ListIcebergNamespaceDetails | 查看命名空间详细列表 | 查看iceberg数据库列表 |
| GetIcebergTable | 获取Iceberg表详情 | 查看表 |
| GetIcebergNamespace | 获取命名空间详情 | 查看iceberg数据库 |