元数据
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
目录 | ||
CreateCatalog![]() | 创建数据湖数据目录 | 查看文档去调试 |
ListCatalogs![]() | 分页查询,获取元数据库命名空间(Catalog)列表 | 查看文档去调试 |
GetCatalog | 获取数据目录详情 | 查看文档去调试 |
UpdateCatalog | 更新数据目录内容 | 查看文档去调试 |
DeleteCatalog | 删除数据目录 | 查看文档去调试 |
库 | ||
CreateDatabase | 在数据湖元数据中创建一个新的元数据库 | 查看文档去调试 |
GetDatabase![]() | 获取数据湖具体的一个数据库的详细信息 | 查看文档去调试 |
ListDatabases![]() | 获取数据湖中数据库列表,分页查询,可以根据数据库名称匹配 | 查看文档去调试 |
UpdateDatabase | 更新数据湖中数据库的详细信息 | 查看文档去调试 |
DeleteDatabase | 根据名称删除数据湖中的数据库 | 查看文档去调试 |
表 | ||
CreateTable![]() | 新增数据湖的数据表 | 查看文档去调试 |
GetTable![]() | 获取数据湖中数据表的详细信息 | 查看文档去调试 |
GetTableColumnStatistics | 获取数据湖中数据表指定字段的统计信息 | 查看文档去调试 |
GetTableVersion | 获取数据湖中数据表的一个指定版本 | 查看文档去调试 |
ListTableNames | 仅用于查询数据湖数据表的名称列表 | 查看文档去调试 |
ListTables![]() | 获取数据湖中数据表列表 | 查看文档去调试 |
ListTableVersions | 分页查询数据湖中数据表指定版本的列表 | 查看文档去调试 |
GetTableProfile![]() | 获取表数据概况的详细信息 | 查看文档去调试 |
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 名称 | 描述 | 操作 |
---|---|---|
SearchAcrossCatalog | 跨Catalog搜索库、表、字段等内容 | 查看文档去调试 |
RegisterLocation | 将OSS路径注册为由DLF管理 | 查看文档去调试 |
DeregisterLocation | 取消Location注册 | 查看文档去调试 |
UpdateRegisteredLocation | 编辑已注册的Location | 查看文档去调试 |
ListPartitionsByExpr | 获取数据湖中数据表分区列表,按条件查询 | 查看文档去调试 |
GetDatabaseProfile | 获取库数据概况的详细信息 | 查看文档去调试 |
GetLifecycleRule | 获取库表生命周期规则 | 查看文档去调试 |
ListPartitionsProfile | 获取分区数据概况的详细信息 | 查看文档去调试 |