数据湖构建API有哪些功能_数据湖构建(DLF)-阿里云帮助中心

本产品（数据湖构建/2020-07-10）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

元数据

API	标题	API概述
目录	目录
CreateCatalog	创建数据湖数据目录	创建数据湖数据目录。
DeleteCatalog	删除数据湖数据目录	删除数据目录。
UpdateCatalog	更新目录	更新数据目录内容。
ListCatalogs	获取数据目录列表	分页查询，获取元数据库命名空间（Catalog）列表。
GetCatalog	获取目录详情	获取数据目录详情。
库	库
CreateDatabase	新增元数据库	在数据湖元数据中创建一个新的元数据库。
DeleteDatabase	删除元数据库	根据名称删除数据湖元数据库。
UpdateDatabase	更新元数据库信息	更新数据湖元数据库的详细信息。
GetDatabase	获取元数据库详情	获取数据湖具体的一个元数据库的详细信息。
ListDatabases	获取元数据库列表	获取数据湖元数据库列表，分页查询，可以根据数据库名称匹配。
表	表
CreateTable	新增元数据表	新增数据湖的元数据表。
DeleteTable	删除元数据表	根据名称删除数据湖的元数据表。
DeleteTableColumnStatistics	删除元数据表统计信息	回收数据湖元数据表的字段统计信息。
DeleteTableVersion	删除元数据表指定版本	删除数据湖元数据表指定版本。
UpdateTable	更新元数据表信息	根据名称更新数据湖元数据表信息。
UpdateTableColumnStatistics	更新元数据表统计信息	创建或者更新元数据表的字段统计信息。
GetTable	获取元数据表详情	获取某个数据湖元数据表的详细信息。
GetTableColumnStatistics	获取元数据表字段的统计信息	获取数据湖元数据表指定字段的统计信息。
GetTableVersion	获取元数据表指定版本	获取数据湖元数据表的一个指定版本。
ListTableNames	获取元数据表名称列表	仅用于查询数据湖元数据表的名称列表。
ListTables	获取元数据表列表	获取数据湖元数据表列表。
ListTableVersions	获取元数据表版本列表	分页查询数据湖元数据表指定版本的列表。
GetTableProfile	获取表数据概况	获取表数据概况的详细信息。
RenameTable	更新元数据表的名称	仅用于更新数据湖元数据表的名称。
BatchGetTables	批量获取元数据表详情	批量获取某个数据湖元数据表的详细信息。
BatchCreateTables	批量新增元数据表	批量新增数据湖的元数据表。
BatchDeleteTables	批量删除元数据表	根据名称批量删除数据湖的元数据表。
BatchDeleteTableVersions	批量删除元数据表版本	批量删除数据湖元数据表指定版本。
BatchUpdateTables	批量更新元数据表信息	批量更新数据湖元数据表详细信息。
分区	分区
CreatePartition	新增元数据表的分区	为数据湖的元数据表，新增一个分区。
DeletePartition	删除元数据表分区	删除数据湖元数据表的指定分区。
DeletePartitionColumnStatistics	删除元数据表分区统计信息	回收数据湖元数据表分区的字段统计信息。
UpdatePartitionColumnStatistics	更新元数据表分区统计信息	创建或者更新元数据表分区的字段统计信息。
GetPartition	获取元数据库分区	获取数据湖元数据库分区详情。
GetPartitionColumnStatistics	获取元数据分区字段的统计信息	获取数据湖元数据分区指定字段的统计信息。
ListPartitionNames	获取元数据表分区名称列表	获取数据湖元数据表分区名称列表，通常用于多级分区。
ListPartitions	获取元数据库分区列表	获取数据湖元数据库分区详情列表。
ListPartitionsByFilter	按条件获取元数据表分区列表	获取数据湖元数据表分区列表，按Filter条件查询。
BatchCreatePartitions	批量新增元数据表的分区	为数据湖的元数据表，批量新增多个分区。
BatchDeletePartitions	批量删除元数据表分区	批量删除数据湖元数据表的指定分区。
BatchGetPartitionColumnStatistics	批量获取元数据分区统计信息	批量获取数据湖元数据表分区的字段统计信息。
BatchGetPartitions	批量获取元数据库分区	批量获取数据湖元数据库分区详情。
BatchUpdatePartitions	批量更新元数据表的分区	为数据湖的元数据表，批量更新多个分区。
RenamePartition	更新元数据表分区名	更新数据湖元数据表的分区名称。
函数	函数
CreateFunction	新增元数据库的函数	新增数据湖元数据库的用户自定义函数。
DeleteFunction	删除元数据库的函数	根据名称删除数据湖元数据库的用户自定义函数。
UpdateFunction	更新元数据库的函数	根据名称，更新数据湖元数据库的用户自定义函数信息。
ListFunctionNames	获取元数据库的函数名称列表	分页查询，获取元数据库的函数名称列表。
ListFunctions	获取元数据库的函数列表	批量获取数据湖元数据库的用户自定义函数列表。
GetFunction	获取元数据库的指定函数	根据函数名称，获取数据湖元数据库的用户自定义函数。
锁	锁
CreateLock	创建元数据锁	创建一个指定的元数据锁。
GetLock	查询元数据锁	查询指定的元数据锁。
AbortLock	中止元数据锁	中止指定的元数据锁。
RefreshLock	刷新元数据锁	刷新指定的元数据锁。
UnLock	解锁指定的元数据锁	解开指定的元数据锁。
元数据迁移	元数据迁移
StopMigrationWorkflow	停止迁移工作流	停止元数据迁移任务。
RunMigrationWorkflow	执行迁移工作流
GetAsyncTaskStatus	获取异步任务状态	用于元数据相关异步API中，检查异步执行任务的状态。
Search	搜索元数据	元数据检索。

权限

API	标题	API概述
CreateRole	创建数据湖权限的角色	在数据湖权限中新增一个角色。
GrantRoleToUsers	将数据湖角色授予用户	将数据湖角色授予多个用户。
GrantRolesToUser	将多个角色授予给单个用户	将多个角色授予给单个用户。
GrantPermissions	对User/数据湖角色授予权限	对User/数据湖角色授予资源的操作权限。
BatchGrantPermissions	批量对User/数据湖角色授予资源的操作权限	批量对User/数据湖角色授予资源的操作权限。
DeleteRole	删除数据湖权限中的角色	删除数据湖权限中的角色。
RevokeRoleFromUsers	将多个User从单个角色中移除	将多个User从单个数据湖角色中移除。
RevokeRolesFromUser	将多个角色从单个User中移除	将多个角色从单个User中移除。
RevokePermissions	取消User/数据湖角色授予的权限	取消对User/数据湖角色授予资源的操作权限。
BatchRevokePermissions	批量取消对User/数据湖角色授予的权限	批量取消对User/数据湖角色授予资源的操作权限。
UpdateRole	更新数据湖权限中的角色	更新数据湖权限中的角色。
UpdateRoleUsers	更新角色中的用户	更新角色中的user，该user包含ram user/ram role。
UpdatePermissions	对User/数据湖角色的权限进行更新	对User/数据湖角色的权限进行更新。
UpdateCatalogSettings	更新数据湖Catalog的配置	更新数据湖Catalog的配置，需admin角色以上角色。
GetRole	获取数据湖权限中的角色详情	根据角色名获取数据湖权限中的角色。
ListRoles	获取数据湖角色列表	获取数据湖角色列表。
ListRoleUsers	获取单个角色的User列表	获取单个角色的User列表。
ListUserRoles	获取单个User的数据湖角色列表	获取单个User的数据湖角色列表。
ListPermissions	获取权限列表	获取权限列表。
CheckPermissions	对User权限进行校验	对User权限进行校验。
GetCatalogSettings	获取数据湖Catalog的配置	获取数据湖Catalog的配置，需admin角色以上角色。

数据探索

API	标题	API概述
GetQueryResult	获取查询结果	获取数据探索查询结果。
SubmitQuery	提交查询	提交SQL查询任务。
CancelQuery	取消查询	取消查询任务。

通用服务

API	标题	API概述
GetRegionStatus	获取数据湖构建服务开通状态	获取数据湖构建指定地域的服务开通状态。
GetServiceStatus	获取某个用户的服务开通状态	获取数据湖构建某个用户的服务开通状态。
DescribeRegions	获取开通的地区	获取开通的地区列表。

其他

API	标题	API概述
SearchAcrossCatalog	跨Catalog搜索元数据	跨Catalog搜索库、表、字段等内容。
RegisterLocation	注册Location	将OSS路径注册为由DLF管理。
DeregisterLocation	取消Location注册	取消Location注册。
UpdateRegisteredLocation	编辑Location	编辑已注册的Location。
ListPartitionsByExpr	按条件获取元数据表分区列表	获取数据湖元数据表分区列表，按条件查询。
GetDatabaseProfile	获取库数据概况	获取库数据概况的详细信息。
GetLifecycleRule	获取库表生命周期规则	获取库表生命周期规则。
ListPartitionsProfile	获取分区数据概况	获取分区数据概况的详细信息。