数据湖构建_API文档

数据湖构建 - OpenAPI 概览2020-07-10
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
元数据
OpenAPI 名称描述操作
目录
CreateCataloghot创建数据湖数据目录查看文档去调试
ListCatalogshot分页查询,获取元数据库命名空间(Catalog)列表查看文档去调试
GetCatalog获取数据目录详情查看文档去调试
UpdateCatalog更新数据目录内容查看文档去调试
DeleteCatalog删除数据目录查看文档去调试
CreateDatabase在数据湖元数据中创建一个新的元数据库查看文档去调试
GetDatabasehot获取数据湖具体的一个数据库的详细信息查看文档去调试
ListDatabaseshot获取数据湖中数据库列表,分页查询,可以根据数据库名称匹配查看文档去调试
UpdateDatabase更新数据湖中数据库的详细信息查看文档去调试
DeleteDatabase根据名称删除数据湖中的数据库查看文档去调试
CreateTablehot新增数据湖的数据表查看文档去调试
GetTablehot获取数据湖中数据表的详细信息查看文档去调试
GetTableColumnStatistics获取数据湖中数据表指定字段的统计信息查看文档去调试
GetTableVersion获取数据湖中数据表的一个指定版本查看文档去调试
ListTableNames仅用于查询数据湖数据表的名称列表查看文档去调试
ListTableshot获取数据湖中数据表列表查看文档去调试
ListTableVersions分页查询数据湖中数据表指定版本的列表查看文档去调试
GetTableProfilehot获取表数据概况的详细信息查看文档去调试
UpdateTable根据名称更新数据湖中数据表信息查看文档去调试
UpdateTableColumnStatistics创建或者更新数据表的字段统计信息查看文档去调试
DeleteTable根据名称删除数据湖的数据表查看文档去调试
DeleteTableColumnStatistics回收数据湖中数据表的字段统计信息查看文档去调试
DeleteTableVersion删除数据湖中数据表指定版本查看文档去调试
RenameTable仅用于更新数据湖中数据表的名称查看文档去调试
BatchGetTables批量获取数据湖中数据表的详细信息查看文档去调试
BatchCreateTables批量新增数据湖的数据表查看文档去调试
BatchDeleteTables根据名称批量删除数据湖的数据表查看文档去调试
BatchDeleteTableVersions批量删除数据湖数据表指定版本查看文档去调试
BatchUpdateTables批量更新数据湖中数据表详细信息查看文档去调试
分区
CreatePartition为数据湖的数据表,新增一个分区查看文档去调试
GetPartition获取数据湖中数据库分区详情查看文档去调试
GetPartitionColumnStatistics获取数据湖中数据分区指定字段的统计信息查看文档去调试
ListPartitionNames获取数据湖中数据表分区名称列表,通常用于多级分区查看文档去调试
ListPartitions获取数据湖中数据库分区详情列表查看文档去调试
ListPartitionsByFilter获取数据湖中数据表分区列表,按Filter条件查询查看文档去调试
UpdatePartitionColumnStatistics创建或者更新数据表分区的字段统计信息查看文档去调试
DeletePartition删除数据湖中数据表的指定分区查看文档去调试
DeletePartitionColumnStatistics回收数据湖中数据表分区的字段统计信息查看文档去调试
BatchCreatePartitions为数据湖的数据表,批量新增多个分区查看文档去调试
BatchDeletePartitions批量删除数据湖中数据表的指定分区查看文档去调试
BatchGetPartitionColumnStatistics批量获取数据湖中数据表分区的字段统计信息查看文档去调试
BatchGetPartitions批量获取数据湖中数据库分区详情查看文档去调试
BatchUpdatePartitions为数据湖的数据表,批量更新多个分区查看文档去调试
RenamePartition更新数据湖中数据表的分区名称查看文档去调试
函数
CreateFunction新增数据湖中数据库的用户自定义函数查看文档去调试
ListFunctionNames分页查询,获取数据库的函数名称列表查看文档去调试
ListFunctions批量获取数据湖中数据库的用户自定义函数列表查看文档去调试
GetFunction根据函数名称,获取数据湖中数据库的用户自定义函数查看文档去调试
UpdateFunction根据名称,更新数据湖中数据库的用户自定义函数信息查看文档去调试
DeleteFunction根据名称删除数据湖中数据库的用户自定义函数查看文档去调试
CreateLock创建一个指定的元数据锁查看文档去调试
GetLock查询指定的元数据锁查看文档去调试
AbortLock中止指定的元数据锁查看文档去调试
RefreshLock刷新指定的元数据锁查看文档去调试
UnLock解开指定的元数据锁查看文档去调试
元数据迁移
StopMigrationWorkflow停止元数据迁移任务查看文档去调试
RunMigrationWorkflow运行元数据迁移任务查看文档去调试
GetAsyncTaskStatus用于元数据相关异步API中,检查异步执行任务的状态查看文档去调试
Search元数据检索查看文档去调试
权限
OpenAPI 名称描述操作
CreateRole在数据湖权限中新增一个角色查看文档去调试
GrantRoleToUsers将数据湖角色授予多个用户查看文档去调试
GrantRolesToUser将多个角色授予给单个用户查看文档去调试
GrantPermissions对User/数据湖角色授予资源的操作权限查看文档去调试
BatchGrantPermissions批量对User/数据湖角色授予资源的操作权限查看文档去调试
GetRole根据角色名获取数据湖权限中的角色查看文档去调试
ListRoles获取数据湖角色列表查看文档去调试
ListRoleUsers获取单个角色的User列表查看文档去调试
ListUserRoles获取单个User的数据湖角色列表查看文档去调试
ListPermissions获取权限列表查看文档去调试
CheckPermissions对User权限进行校验查看文档去调试
GetCatalogSettings获取数据湖Catalog的配置,需admin角色以上角色查看文档去调试
UpdateRole更新数据湖权限中的角色 查看文档去调试
UpdateRoleUsers更新角色中的user,该user包含ram user/ram role查看文档去调试
UpdatePermissions对User/数据湖角色的权限进行更新查看文档去调试
UpdateCatalogSettings更新数据湖Catalog的配置,需admin角色以上角色查看文档去调试
DeleteRole删除数据湖权限中的角色查看文档去调试
RevokeRoleFromUsers将多个User从单个数据湖角色中移除查看文档去调试
RevokeRolesFromUser将多个角色从单个User中移除查看文档去调试
RevokePermissions取消对User/数据湖角色授予资源的操作权限查看文档去调试
BatchRevokePermissions批量取消对User/数据湖角色授予资源的操作权限查看文档去调试
数据探索
OpenAPI 名称描述操作
GetQueryResulthot获取数据探索查询结果查看文档去调试
SubmitQueryhot提交SQL查询任务查看文档去调试
CancelQuery取消查询任务查看文档去调试
通用服务
OpenAPI 名称描述操作
GetRegionStatus获取数据湖构建指定地域的服务开通状态查看文档去调试
GetServiceStatus获取数据湖构建某个用户的服务开通状态查看文档去调试
DescribeRegions获取开通的地区列表查看文档去调试
其他
OpenAPI 名称描述操作
SearchAcrossCatalog跨Catalog搜索库、表、字段等内容查看文档去调试
RegisterLocation将OSS路径注册为由DLF管理查看文档去调试
DeregisterLocation取消Location注册查看文档去调试
UpdateRegisteredLocation编辑已注册的Location查看文档去调试
ListPartitionsByExpr获取数据湖中数据表分区列表,按条件查询查看文档去调试
GetDatabaseProfile获取库数据概况的详细信息查看文档去调试
GetLifecycleRule获取库表生命周期规则查看文档去调试
ListPartitionsProfile获取分区数据概况的详细信息查看文档去调试