文档

API概览

更新时间:
本产品(数据湖构建/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按条件获取元数据表分区列表获取数据湖元数据表分区列表,按条件查询。
  • 本页导读 (0)
文档反馈