API 参考--湖仓一体分析服务 LAS-火山引擎

文档中心

立即注册

导航

API 参考

最近更新时间：2024.11.01 22:07:09首次发布时间：2024.06.11 19:30:20

1 API概览

说明

火山引擎LAS API 参考文档提供了有关元数据以及权限相关接口去访问统一元数据服务，包括如何使用它、其功能和限制。在使用我们的 API 之前，请仔细阅读本参考文档。

数据目录

API	说明
ListCatalogs	查询数据目录列表
GetCatalog	查询数据目录详情
CreateCatalog	创建数据目录
AlterCatalog	修改数据目录

数据库

API	说明
ListSchema	查询数据库列表
GetSchema	查询数据库详情
ListSchemaNames	搜索数据库名称
CreateSchema	创建数据库
AlterSchema	编辑数据库
DropSchema	删除数据库

数据表

API	说明
ShowTables	获取元数据表列表
GetTableDetail	获取元数据表详情
GetTableStats	获取统计信息
CreateTable	创建元数据表
AlterTable	编辑元数据表
DropTable	删除元数据表

分区

API	说明
ShowPartitions	查询表分区

函数

API	说明
ListUDF	查询函数列表
GetFunction	查询函数详情
CreateFunction	创建函数
AlterFunction	编辑函数
DropFunction	删除函数

权限

API	说明
ListPrincipalsForDataObject	获取具有其权限的用户/用户组列表
ListIAMUsersWithDataObjectRole	查询用户列表
GrantDataObjectPrivilege	为用户授予指定数据对象的权限
RevokeDataObjectPrivilege	回收用户对指定数据对象的权限
AlterDataObjectPrivilege	修改用户对指定对象的权限

2 获取安全凭证

Access Key（访问密钥）是访问火山引擎服务的安全凭证，包含Access Key ID（简称为AK）和Secret Access Key（简称为SK）两部分。您可登录火山引擎控制台，前往访问控制的访问密钥中创建及管理您的Access Key。更多信息可参考访问密钥帮助文档。

3. API接入

3.1 服务信息

字段	说明	示例	备注
AK	火山引擎Access Key	AKLTZWU*****
SK	火山引擎Secret Key	TW1KaVl******
服务域名	域名	https://open.volcengineapi.com
Region	区域	cn-beijing cn-shanghai cn-guangzhou	当前支持 cn-beijing cn-shanghai cn-guangzhou
Service	服务	las	固定值
Action	接口	ListSchema
Version	版本	2024-04-30	固定值

3.2 服务URL

https://open.volcengineapi.com?Action={Action}&Version={Version}

3.3 签名机制

LAS采用火山引擎统一的签名机制。
为了保证请求者身份的合法性以及请求在传输过程中不被恶意篡改，火山引擎签名机制要求请求者对请求参数进行哈希值计算，经过加密后同 API 请求一起发送到服务器中，服务器将以同样的机制对收到的请求进行签名计算，并以此与请求者传来的签名进行比对，若签名未通过验证，请求将被拒绝。
如何计算签名，请参考签名方法。

4. API目录

元数据

数据目录

ListCatalogs

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
Offset	int	N	0	分页
Limit	int	N	20	每页展示数量，默认20

返回参数

参数名称		类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	Data	List<Catalog>

GetCatalog

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	Y	hive	默认catalog，非必传

返回参数

参数名称	参数类型
ResponseMetadata
Result	Catalog

CreateCatalog

请求参数

参数名称	参数类型	是否必须
Catalog	Catalog	Y

返回参数

参数名称	参数类型
ResponseMetadata

AlterCatalog

请求参数

参数名称	参数类型	是否必须
CatalogName	String	Y
Catalog	Catalog	Y

返回参数

参数名称	参数类型
ResponseMetadata

数据库

ListSchema

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	N		搜索
Offset	int	N	0	分页
Limit	int	N	20	每页展示数量，默认20

返回参数

参数名称		参数类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	Data	List

GetSchema

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y		schema名称

返回参数

参数名称	参数类型
ResponseMetadata
Result	Schema

ListSchemaNames

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
Limit	int	N
Offset	int	N

返回参数

参数名称		类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	SchemaNames	List

CreateSchema

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y		数据库名（由小写字母、数字、下划线组成，最长256字符）
Location	String	Y		存储位置
Description	String	N		描述

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

AlterSchema

请求参数

参数名称	参数类型	是否必须	说明
CatalogName	String	Y	必传
SchemaName	String	Y	数据库名（由小写字母、数字、下划线组成，最长256字符）
Location	String	Y	存储位置
Description	String	N	描述

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

DropSchema

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	Y		必传	必传
SchemaName	String	Y		库名，必传	必传

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

数据表

ShowTables

请求参数

参数名称	是否必须	默认值	说明
CatalogName	N	hive	默认catalog，非必传
SchemaName	Y		数据库名称
TableName	N		搜索
Offset	N	0	分页
Limit	N	20	每页展示数量，默认20

返回参数

参数名称		参数类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	Data	List<Table>

GetTableDetail

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y
TableName	String	Y

返回参数

参数名称	参数类型
ResponseMetadata
Result	Table

GetTableStats

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y
TableName	String	Y		默认全部展示

返回参数

参数名称	参数类型
ResponseMetadata
Result	Stats

ShowPartitions

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y
TableName	String	Y
Offset	int	0		Partition 分页
Limit	int	20		每页展示数量，默认20

返回参数

参数名称		参数类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	Data	List

CreateTable

请求参数

参数名称		参数类型	是否必须	默认值	说明
CatalogName		String	N		默认catalog，非必传
SchemaName		String	Y
TableName		String	Y		默认全部展示
TableType		String	N	MANAGED_TABLE	表类型
FileFormat		String	N	Parquet	存储格式，目前可选值为Parquet，ORC，Avro, TextFile，SequenceFile，RcFile，JSON,
TableComment		String	N		表注释
PartitionType		String	Y		分区类型，选择范围为PARTITION和NON_PARTITION
Location		String	N		存储tos桶
FieldColumns		List	Y		字段列表
PartitionColumns		List	N		分区字段列表，分区表必须
FieldColumn	ColumnName	String	Y		字段名
	ColumnType	String	Y		字段类型,参考官网 tinyint,smallint,int,bigint,float,double,decimal,timestamp,date,interval,,string,varchar,char,boolean,binary,array,maps,struct,union
	ColumnDesc	String	N		字段描述
tableProperties		Map<String, String>	N		高级配置

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

AlterTable

请求参数

参数名称		参数类型	是否必须	说明
CatalogName		String	N	默认catalog，非必传
SchemaName		String	Y	库名
TableName		String	Y	表名
TableComment		String	N	表注释
Location		String	N	存储tos桶
FieldColumns		List	Y	字段列表，全量覆盖
FieldColumn	ColumnName	String	Y	字段名
	ColumnType	String	Y	字段类型,参考官网 tinyint,smallint,int,bigint,float,double,decimal,timestamp,date,interval,,string,varchar,char,boolean,binary,array,maps,struct,union
	ColumnDesc	String	N	字段描述
tableProperties		Map<String, String>	N	高级配置，全量覆盖

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

DropTable

请求参数

参数名称	参数类型	是否必须	说明
CatalogName	String	N	默认catalog，非必传
SchemaName	String	Y	库名
TableName	String	Y	表名

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

函数

ListUDF

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y
FunctionName	String	N		搜索
Offset	int	N	0	分页
Limit	int	N	20	每页展示数量，默认20

返回参数

参数名称		参数类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	UDFMetadata	List

GetFunction

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y
FunctionName	String	Y

返回参数

参数名称	参数类型
ResponseMetadata
Result	Function

CreateFunction

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y		数据库名（由小写字母、数字、下划线组成，最长256字符）
UDFName	String	Y
Type	String	Y		Java
ClassName	String	Y		类名
ResourceUris	List	Y		资源路径

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

AlterFunction

请求参数

参数名称	参数类型	是否必须	说明
CatalogName	String	N	catalogName 不传使用默认值
SchemaName	String	Y	数据库名（由小写字母、数字、下划线组成，最长256字符）
UDFName	String	Y
Type	String	Y	Java
ClassName	String	Y	类名
ResourceUris	List	Y	资源路径

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

DropFunction

请求参数

参数名称	参数类型	是否必须	说明
CatalogName	String	Y	catalogName
SchemaName	String	Y	数据库名
UDFName	String	Y

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

权限

ListPrincipalsForDataObject

请求参数

参数	是否必须	描述
DataObjectScope	Y	指定不同层级的对象，可选项为：Schema/Table/UDF/Resource
SchemaName	Y	Schema Name
DataObjectName	N	DataObject Name，如果 Scope 为 Schema，则此项为空
IdentityName	N	过滤项：用户/组名关键词搜索，精确匹配
IdentityType	N	过滤项：用户类型，可选项为：User/Group/GroupDataLeap。如果多选，则逗号分隔，如 xxx,yyy
Role	N	过滤项：角色，可选项为：Admin/Viewer/Developer。如果多选，则逗号分隔，如 xxx,yyy
Limit	Y	这个是每页能够显示的最大数量
Offset	Y	最小值为1，代表页数

返回参数

参数名称		参数类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	Data	List

ListIAMUsersWithDataObjectRole

请求参数

参数	是否必须	描述
IdentityName	Y	用户名，支持模糊查询
DataObjectScope	Y	DataObject 对象的层级，可选项为：Schema/Table/UDF
SchemaName	Y	Schema Name
DataObjectName	N	数据对象名，当 Scope 为 Schema 时，此项为空
Limit	N	这个是每页能够显示的最大数量，默认为10

返回参数

参数名称		参数类型
ResponseMetadata
Result	Limit	int
	Offset	int
	Total	int
	Data	List

GrantDataObjectPrivilege

请求参数

参数	参数类型	是否必须	描述
IdentityList	Array	Y	用户信息数组
IdentityList.AccountID	String	N	用户 AccountID，默认为当前用户 AccountID
IdentityList.IdentityId	String	Y	用户/组 ID
IdentityList.IdentityType	String	Y	用户类型：User/Group/GroupDataLeap
DataObjectScope	String	Y	DataObject 对象的层级，可选项为：Schema/Table/UDF/Resource
SchemaName	String	Y	Schema Name
DataObjectName	String	N	数据对象名，当 Scope 为 Schema 时，此项为空
Role	String	Y	角色（对数据对象的操作权限），可选项为：Admin/Viewer/Developer
ExpiredDays	Int	N	过期天数，e.g.: 30 表示申请30天的权限，从今天开始，30天后到期。 -1 表示 “永久授权” 当 Scope 为 UDF 和 Resource 时，此项为空。

返回参数

参数名称	参数类型
ResponseMetadata
Result	OperateResponse

RevokeDataObjectPrivilege

请求参数

参数	参数类型	是否必须	描述
IdentityList	Array	Y	用户信息数组
IdentityList.AccountID	String	N	用户 AccountID，默认为当前用户 AccountID
IdentityList.IdentityId	String	Y	用户/组 ID
IdentityList.IdentityType	String	Y	用户类型：User/Group/GroupDataLeap
DataObjectScope	String	Y	DataObject 对象的层级，可选项为：Schema/Table/UDF/Resource
SchemaName	String	Y	Schema Name
DataObjectName	String	N	数据对象名，当 Scope 为 Schema 时，此项为空
Role	String	Y	角色：Admin/Viewer/Developer

返回参数

参数名称	参数类型
ResponseMetadata
Result	OperateResponse

AlterDataObjectPrivilege

请求参数

参数	参数类型	是否必须	描述
IdentityList	Array	Y	用户信息数组
IdentityList.AccountID	String	N	用户 AccountID，默认为当前用户 AccountID
IdentityList.IdentityId	String	Y	用户/组 ID
IdentityList.IdentityType	String	Y	用户类型：User/Group/GroupDataLeap
DataObjectScope	String	Y	DataObject 对象的层级，可选项为：Schema/Table/UDF/Resource
SchemaName	String	Y	Schema Name
DataObjectName	String	N	数据对象名，当 Scope 为 Schema 时，此项为空
OldRole	String	Y	老角色（对数据对象的操作权限），可选项为：Admin/Viewer/Developer
Role	String	Y	角色（对数据对象的操作权限），可选项为：Admin/Viewer/Developer
ExpiredDays	Int	N	过期天数，e.g.: 30 表示申请30天的权限，从今天开始，30天后到期。 -1 表示 “永久授权” 当 Scope 为 UDF 和 Resource 时，此项为空。

返回参数

参数名称	参数类型
ResponseMetadata
Result	OperateResponse

5 数据结构

Catalog

参数名称	类型
CatalogName	String
Location	String
Description	String
Owner	String
CreateTime	String
UpdateTime	String

Schema

参数名称	参数类型
Name	String
TableCount	String
Location	String
Description	String
Owner	String
CatalogName	String
CreateTime	String
UpdateTime	String

Table

参数名称	参数类型
CatalogName	String
SchemaName	String
TableName	String
Location	String
Owner	String
CreateTime	String
UpdateTime	String

TableDetail

参数名称	参数类型
CatalogName	String
SchemaName	String
TableName	String
Location	String
PartitionType	String
TableComment	String
FileFormat	String
TableType	String
CreateTime	String
UpdateTime	String
CompressFormat	String
InputFormat	String
OutputFormat	String
FiledColumns	List
PartitionColumns	List

FiledSchema

参数名称	参数类型
ColumnName	String
ColumnType	String
ColumnDesc	String

Stats

参数名称	参数类型	参数说明
Storage	String	存储大小
NumFiles	String	文件数量
UpdateTime	String	最后更改时间
NumPartitions	String	表分区个数
Storage	String	存储大小

Partition

参数名称	字段类型
PartitionName	String
DataRows	String
NumFiles	String
Storage	String
CreateTime	String
UpdateTime	String

Function

参数名称	参数类型
CatalogName	String
SchemaName	String
UDFName	String
ClassName	String
Type	String
Owner	String
CreateTime	String
ResourceUris	List

ResourceUri

参数名称	参数类型	说明
ResourceType	String	JAR, FILE, ARCHIVE;
Uri	String	存储位置

AuthorizedPrincipal

参数	类型	描述
AccountId	String	用户所属租户的 AccountID
IdentityId	String	用户/组 ID
IdentityName	String	用户/组名称
IdentityType	String	用户类型：User/Group
Role	String	角色：Admin/Viewer/Developer
AuthorizedSource	String	授权来源：由 xxx 授予、源自继承
IsInherit	Boolean	true/false，true 表示源自继承，无法修改&删除
ExpiredTime	String	到期时间：2021-12-30 23:23:23，-1 表示“永久授权”。对于 UDF/Resource/Queue，此项为空。
ExpiredDays	Int	到期天数：20， -1 表述“永久授权”

IAMUserWithRole

参数	类型	描述
AccountId	String	用户所属租户的 AccountID
IdentityId	String	用户/组 ID
IdentityName	String	用户/组名称
IdentityType	String	用户类型：User/Group
Role	String	角色：Admin/Viewer/Developer，如果没有 Role，则为空。多个以 , 分隔

6 返回结构及公共错误码

发送请求消息以后，您会收到消息队列服务端的响应，返回结果中包含状态码、响应消息头和消息体。
公共返回结构及错误码请参考返回结构