文档中心

AI 数据湖服务

数据湖

Catalog

API概览

说明

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

数据目录

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

数据库

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

数据表

API	说明
ShowTables	获取元数据表列表
GetTableDetail	获取元数据表详情
GetTableStats	获取统计信息
CreateTable	创建元数据表
AlterTable	编辑元数据表
DropTable	删除元数据表
RegisterTable	注册/识别 Lake Formation 表

分区

API	说明
ShowPartitions	查询表分区

函数

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

列掩码

API	说明
BindColumnMask	绑定列掩码
UnbindColumnMask	解绑列掩码
GetColumnMaskBindings	解除某列的脱敏函数绑定。
ListColumnMaskBindings	分页查询已绑定 mask 的列信息

权限

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

获取安全凭证

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

API接入

服务信息

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

数据目录

ListCatalogs

请求参数

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

返回参数

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

示例
请求示例

GET /?Action=ListCatalogs&Version=2024-04-30&Limit=10&Offset=1 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251128115804xxxx1C18F0848941B88E",
        "Action": "ListCatalogs",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Limit": 10,
        "Offset": 0,
        "Total": 1,
        "Data": [
            {
                "CatalogName": "xxx",
                "Owner": "xxx",
                "Region": null,
                "Description": "null",
                "Location": "tos://xxx/test.lance",
                "CreateTime": "2025-11-12 16:22:36",
                "UpdateTime": "2025-11-12 16:22:36",
                "AllowDeletion": true,
                "AllowEdition": true,
                "AllowCreate": true,
                "IamUser": true,
                "CatalogType": "lance"
            }
        ]
    }
}

GetCatalog

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	Y	hive	待查询 catalog 名称

返回参数

参数名称	参数类型
ResponseMetadata	—
Result	Catalog

示例
请求示例

GET /?Action=GetCatalog&Version=2024-04-30&CatalogName=xxx HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251128160645F36xxxAF61235FBA856",
        "Action": "GetCatalog",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "CatalogName": "hive",
        "Owner": "xxx",
        "Region": null,
        "Description": "",
        "Location": "tos://xxx/",
        "CreateTime": "2025-08-26 14:53:24",
        "UpdateTime": "2025-08-26 14:53:24",
        "AllowDeletion": true,
        "AllowEdition": true,
        "AllowCreate": true,
        "IamUser": true,
        "CatalogType": "hive"
    }
}

CreateCatalog

请求参数

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

返回参数

参数名称	参数类型
ResponseMetadata	—

示例
请求示例

POST /?Action=CreateCatalog&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "CatalogName": "xxx",
    "Owner": "xxx",
    "Region": null,
    "Description": "null",
    "Location": "tos://xxx/",
    "CreateTime": "2025-10-20 10:50:41",
    "UpdateTime": "2025-10-20 10:50:41",
    "AllowDeletion": false,
    "AllowEdition": false,
    "AllowCreate": false,
    "IamUser": true,
    "CatalogType": "iceberg"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2025112816132xxx1D47420B9AF074DB8C",
        "Action": "CreateCatalog",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": true
}

AlterCatalog

请求参数

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

返回参数

参数名称	参数类型
ResponseMetadata	—

示例
请求示例

POST /?Action=AlterCatalog&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "CatalogName": "xxx",
    "Catalog": {
        "CatalogName": "xxx",
        "Owner": "xxx",
        "Region": null,
        "Description": "null",
        "Location": "tos://xxx/",
        "CreateTime": "2025-09-03 12:01:33",
        "UpdateTime": "2025-09-03 12:01:33",
        "AllowDeletion": false,
        "AllowEdition": false,
        "AllowCreate": false,
        "IamUser": true,
        "CatalogType": "lance"
    }
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251128162002CEDExxx27CA27F2F417A",
        "Action": "AlterCatalog",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": true
}

数据库

ListSchema

请求参数

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

返回参数

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

示例
请求示例

GET /?Action=ListSchema&Version=2024-04-30&CatalogName=xxx&Offset=1&Limit=20 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202511281631xxxx6F7F92A520396C070",
        "Action": "ListSchema",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Data": [
            {
                "Region": "cn-beijing",
                "SourceType": "HIVE",
                "Name": "default",
                "Owner": "xxx",
                "Description": "Default database for catalog LanceCatalog",
                "TableCount": "1",
                "Permission": null,
                "Storage": "-",
                "ResourceCount": null,
                "UdfCount": null,
                "Env": "-",
                "SizeUpdateTime": "2025-11-28 16:31:28",
                "IsMetadata": false,
                "AllowDeletion": false,
                "AllowEdition": false,
                "TtlEnabled": false,
                "TtlDays": -1,
                "TtlHotDays": -1,
                "TieredStorageStrategy": null,
                "Location": "tos://xxx",
                "CatalogName": "xxx",
                "CreateTime": "2025-09-03 12:01:33",
                "UpdateTime": "2025-11-28 16:20:02"
            },
            {
                "Region": "cn-beijing",
                "SourceType": "HIVE",
                "Name": "dataset",
                "Owner": "xxx",
                "Description": null,
                "TableCount": "41",
                "Permission": null,
                "Storage": "-",
                "ResourceCount": null,
                "UdfCount": null,
                "Env": "-",
                "SizeUpdateTime": "2025-11-28 16:31:28",
                "IsMetadata": false,
                "AllowDeletion": false,
                "AllowEdition": false,
                "TtlEnabled": false,
                "TtlDays": -1,
                "TtlHotDays": -1,
                "TieredStorageStrategy": null,
                "Location": "file:/xxx",
                "CatalogName": "xxx",
                "CreateTime": "2025-09-03 12:01:55",
                "UpdateTime": "2025-09-03 12:01:55"
            }
        ],
        "Limit": 20,
        "Offset": 1,
        "Total": 2
    }
}

GetSchema

请求参数

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

返回参数

参数名称	参数类型
ResponseMetadata	—
Result	Schema

示例
请求示例

GET /?Action=GetSchema&Version=2024-04-30&CatalogName=xxx&SchemaName=xxx HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251128163425Bxxx2C2F604BF3D17AD7",
        "Action": "GetSchema",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Name": "dataset",
        "TableCount": "41",
        "Location": "file:/xxx",
        "Description": null,
        "Owner": "xxx",
        "CatalogName": "xxx",
        "CreateTime": "2025-09-03 12:01:55",
        "UpdateTime": "2025-09-03 12:01:55",
        "AllowDeletion": false,
        "AllowEdition": false
    }
}

ListSchemaNames

请求参数

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

返回参数

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

示例
请求示例

GET /?Action=ListSchemaNames&Version=2024-04-30&Limit=20&Offset=1&CatalogName=xxx HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2025112816363xx0964C09106DB992CC59",
        "Action": "ListSchemaNames",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Data": [
            "default",
            "dataset"
        ],
        "Limit": 20,
        "Offset": 1,
        "Total": 2
    }
}

CreateSchema

请求参数

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

返回参数

参数名称		类型
ResponseMetadata	—	—
Result	Success	boolean

示例
请求示例

POST /?Action=CreateSchema&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "SchemaName": "xxx",
    "Location": "file:/xxx",
    "Description": "demo",
    "CatalogName": "xxx"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251128164417Dxxx38A2359D8E4C6450",
        "Action": "CreateSchema",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

AlterSchema

请求参数

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

返回参数

参数名称		类型
ResponseMetadata	—	—
Result	Success	boolean

示例
请求示例

POST /?Action=AlterSchema&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "SchemaName": "xxx",
    "Location": "file:/xxx",
    "Description": "demo modification",
    "CatalogName": "xxx"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2025112816455759xxxxx0D3BFA7292FCC",
        "Action": "AlterSchema",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

DropSchema

请求参数

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

返回参数

参数名称		类型
ResponseMetadata	—	—
Result	Success	boolean

示例
请求示例

POST /?Action=DropSchema&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "SchemaName": "xxx",
    "CatalogName": "xxx"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202511281648084xxxx08E6E427641CFBF",
        "Action": "DropSchema",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "DelMetaSuccess": true,
        "DelTOSFileSuccess": false,
        "ErrorMessage": ""
    }
}

数据表

ShowTables

请求参数

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

返回参数

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

示例
请求示例

GET /?Action=ShowTables&Version=2024-04-30&CatalogName=lancecatalog&SchemaName=xxx&Limit=20&Offset=1 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251128170042xxxxF07CE5D019762BCF",
        "Action": "ShowTables",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Data": [
            {
                "CatalogName": "xxx",
                "SchemaName": "xxx",
                "TableName": "xxx",
                "Owner": "xxx",
                "CreateTime": "2025-11-18 19:54:59",
                "UpdateTime": "2025-11-18 20:05:17",
                "PartitionType": "NON_PARTITION",
                "Storage": "-",
                "IsMetadata": false,
                "AllowDeletion": false,
                "AllowEdition": false,
                "AllowRefresh": false,
                "AllowImport": false,
                "AllowView": false,
                "Location": "tos://xxx",
                "TableFormat": "Lance"
            }
        ],
        "Limit": 20,
        "Offset": 1,
        "Total": 1
    }
}

GetTableDetail

请求参数

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

返回参数

参数名称	参数类型
ResponseMetadata	—
Result	Table

其中，Result中的详细字段如下。

参数名称	类型	说明
CatalogName	String	所属 Catalog
SchemaName	String	所属库名
TableName	String	表名
Location	String	表存储路径
PartitionType	String	分区类型枚举
TableComment	String	表备注
TableFormat	String	表格式：Hive / Paimon / Iceberg / Lance
FileFormat	String	文件格式：Parquet / ORC / TextFile / SequenceFile / Paimon / Iceberg / Lance
TableType	String	External / Managed
CreateTime	String	创建时间
UpdateTime	String	更新时间
Owner	String	表 owner
FieldColumns	List	字段列表，元素结构见下方`BaseColumn`结构说明表
PartitionColumns	List	分区字段列表，元素结构见下方`BaseColumn`结构说明表
TableProperties	Map<String, String>	表属性键值对
TtlEnabled	Boolean	是否开启 TTL
TtlDays	Integer	TTL 天数
TieredStorageStrategy	String	分层存储策略：LastModifiedTime / PartitionValue / CreateTime
AllowDeletion	Boolean	是否允许删除
AllowEdition	Boolean	是否允许编辑

BaseColumn 结构（FieldColumns / PartitionColumns 元素结构）：

参数名称	类型	说明
ColumnName	String	列名
ColumnType	String	列类型
ColumnDesc	String	列描述
IsPrimaryKey	Boolean	是否主键
MaskFunctionName	String	绑定的脱敏函数名，未绑定时为 null
MaskFunctionCatalogName	String	脱敏函数所在 Catalog，未绑定时为 null
MaskFunctionSchemaName	String	脱敏函数所在库名，未绑定时为 null

示例
请求示例

GET /?Action=GetTableDetail&Version=2024-04-30&CatalogName=lancecatalog&SchemaName=xxx&TableName=xxx HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202511281704440C0xxxBE982F85FAC4",
        "Action": "GetTableDetail",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "CatalogName": "xxx",
        "SchemaName": "xxx",
        "TableName": "xxx",
        "Location": "tos://xxx",
        "PartitionType": "NON_PARTITION",
        "TableComment": null,
        "FileFormat": "Lance",
        "TableType": "MANAGED_TABLE",
        "CreateTime": "2025-08-26 16:04:15",
        "UpdateTime": "2025-08-26 16:04:15",
        "CompressFormat": null,
        "InputFormat": "Lance",
        "OutputFormat": "Lance",
        "Owner": "xxxx",
        "FieldColumns": [
            {
                "ColumnName": "a",
                "ColumnType": "int64",
                "ColumnDesc": "",
                "IsPrimaryKey": null
            },
            {
                "ColumnName": "b",
                "ColumnType": "binary",
                "ColumnDesc": "",
                "IsPrimaryKey": null
            }
        ],
        "PartitionColumns": [],
        "TableProperties": {
            "totalSize": "1764",
            "numFiles": "3",
            "LanceSchema": "{\n  \"fields\" : [ {\n    \"name\" : \"a\",\n    \"nullable\" : true,\n    \"type\" : {\n      \"name\" : \"int\",\n      \"bitWidth\" : 64,\n      \"isSigned\" : true\n    },\n    \"children\" : [ ]\n  }, {\n    \"name\" : \"b\",\n    \"nullable\" : true,\n    \"type\" : {\n      \"name\" : \"binary\"\n    },\n    \"children\" : [ ]\n  } ]\n}",
            "table_type": "lance"
        },
        "TtlEnabled": false,
        "TtlDays": null,
        "TieredStorageStrategy": null,
        "AllowDeletion": true,
        "AllowEdition": true,
        "TableFormat": "Lance"
    }
}

GetTableStats

请求参数

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

返回参数

参数名称	参数类型
ResponseMetadata	—
Result	Stats

示例
请求示例

GET /?Action=GetTableStats&Version=2024-04-30&CatalogName=xxx&SchemaName=xxx&TableName=xxx HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202512011136511xxxD5AFA450B860C6E2",
        "Action": "GetTableStats",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "NumFiles": "3",
        "UpdateTime": "2025-08-26 16:04:15",
        "NumPartitions": "0",
        "Storage": "1.72KB"
    }
}

ShowPartitions

请求参数

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

返回参数

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

示例
请求示例

GET /?Version=2024-04-30&Action=ShowPartitions&SchemaName=xxx&TableName=xxx&Limit=20&Offset=1 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251127xxx336127812C5AC4D07F83556",
        "Action": "ShowPartitions",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Data": [
            {
                "PartitionName": "date=20250928",
                "CreateTime": "2025-09-28 17:17:16",
                "UpdateTime": "2025-09-28 17:17:16",
                "Storage": "-",
                "NumFiles": "-"
            }
        ],
        "Limit": 20,
        "Offset": 1,
        "Total": 1
    }
}

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

示例
请求示例

POST /?Action=CreateTable&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "ProjectName": "",
    "CatalogName": "xxx",
    "SchemaName": "xxx",
    "TableName": "xxx",
    "Location": "tos://xxx",
    "TableParse": true,
    "TableComment": "测试API建表",
    "TableProperties": {},
    "FieldColumns": [
        {
            "ColumnName": "a",
            "ColumnType": "int64",
            "ColumnDesc": "",
            "IsPrimaryKey": null
        },
        {
            "ColumnName": "b",
            "ColumnType": "binary",
            "ColumnDesc": "",
            "IsPrimaryKey": null
        }
    ],
    "TableFormat": "Lance",
    "FileFormat": "Lance",
    "PartitionType": "NON_PARTITION",
    "CreateType": "meta"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2025120111432xxx341A36E2E8F2EDCFB4",
        "Action": "CreateTable",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

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

示例
请求示例

POST /?Action=AlterTable&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "ProjectName": "",
    "CatalogName": "xxx",
    "SchemaName": "xxx",
    "TableName": "xxx",
    "Location": "tos://xxx",
    "TableParse": true,
    "TableComment": "测试API改表",
    "TableProperties": {},
    "FieldColumns": [
        {
            "ColumnName": "a",
            "ColumnType": "int64",
            "ColumnDesc": "",
            "IsPrimaryKey": null
        },
        {
            "ColumnName": "b",
            "ColumnType": "binary",
            "ColumnDesc": "",
            "IsPrimaryKey": null
        },
        {
            "ColumnName": "new_column",
            "ColumnType": "int64",
            "ColumnDesc": "",
            "IsPrimaryKey": null
        }
    ],
    "TableFormat": "Lance",
    "FileFormat": "Lance",
    "PartitionType": "NON_PARTITION",
    "CreateType": "meta"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251201114901E1xxx84DB847100AC973",
        "Action": "AlterTable",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

DropTable

请求参数

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

返回参数

参数名称		类型
ResponseMetadata	—	—
Result	Success	boolean

示例
请求示例

POST /?Action=DropTable&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "CatalogName": "xxx",
    "SchemaName": "xxx",
    "TableName": "xxx"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2025120111522xxxE101A4C9CECCB1D5AA",
        "Action": "DropTable",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "DelMetaSuccess": true,
        "DelTOSFileSuccess": false,
        "ErrorMessage": ""
    }
}

RegisterTable

用于基于指定的表名、文件格式和存储路径注册/识别 Lake Formation 表，并返回识别后的表详情。

注意

当前 RegisterTable 仅支持 Lance 格式的表。

接口描述

请求方法	`POST`
Content-Type	`application/json`

请求参数

参数	类型	是否必填	示例值	描述
CatalogName	String	否	hive	Catalog 名称；为空时走默认 Catalog 语义。
SchemaName	String	是	default	Schema 名称。如果还未在 Catalog 注册表，可填写 default 。
TableName	String	是	sample_table	表名称。如果还未在 Catalog 注册表，可填写 default 。
FileFormat	String	否	Parquet	文件格式；支持 Parquet、ORC、TextFile、Hive、File、SequenceFile、Lance、Iceberg、PAIMON。
TableComment	String	否	registered from lf	表注释。
PartitionType	String	否	PARTITION	分区类型；Register 分组下无强制校验，实际是否分区以底层表信息为准。
Location	String	是	tos://bucket/default/sam...	注册表位置；Register 分组下必填。
FieldColumns	Array of TableColumn	否	{}	字段列定义列表。
PartitionColumns	Array of TableColumn	否	{}	分区列定义列表；为空时代码会转为空数组。
TableProperties	TableProperties	否	{}	表属性键值对对象。
CreateType	String	否	meta	创建类型；支持 meta、meta_file 或为空。

返回参数

参数	类型	示例值	描述
CatalogName	String	hive	所属 Catalog 名称。
SchemaName	String	default	所属 Schema 名称。
TableName	String	sample_table	表名称。
Location	String	tos://bucket/default/sample_table/	表路径。
PartitionType	String	PARTITION	分区类型。
TableComment	String	registered from lf	表注释。
FileFormat	String	Parquet	文件格式。
TableType	String	EXTERNAL_TABLE	表类型。
CreateTime	String	2026-05-18 18:00:00	创建时间。
UpdateTime	String	2026-05-18 18:00:00	更新时间。
CompressFormat	String	--	压缩格式。
InputFormat	String	--	输入格式类。
OutputFormat	String	--	输出格式类。
Owner	String	admin	所有者。
FieldColumns	Array of TableColumn	{}	普通字段列表。
PartitionColumns	Array of TableColumn	{}	分区字段列表。
TableProperties	TableProperties	{}	表属性键值对对象。
TTLEnabled	Boolean	false	是否开启 TTL。
TTLDays	Long	0	TTL 天数。
TieredStorageStrategy	String	--	分层存储策略；代码会做兼容归一化。
AllowDeletion	Boolean	true	是否允许删除。
AllowEdition	Boolean	true	是否允许编辑。
AllowView	Boolean	true	是否允许查看。
TableFormat	String	Hive	表格式。
DatasetName	String	--	Lake format 场景下的数据集名称；best effort 填充。

示例
请求示例

POST /?Action=RegisterTable&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8

{
  "CatalogName": "hive",
  "SchemaName": "default",
  "TableName": "sample_table",
  "FileFormat": "Parquet",
  "Location": "tos://bucket/default/sample_table/",
  "FieldColumns": [
    {
      "ColumnName": "id",
      "ColumnType": "bigint",
      "ColumnDesc": "主键",
      "IsPrimaryKey": true
    }
  ],
  "PartitionColumns": [
    {
      "ColumnName": "dt",
      "ColumnType": "string",
      "ColumnDesc": "分区日期",
      "IsPrimaryKey": false
    }
  ],
  "TableProperties": {
    "comment": "registered from lf"
  }
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "2026051818000000000000000000000001",
    "Action": "RegisterTable",
    "Version": "2024-04-30",
    "Service": "las",
    "Region": "cn-beijing"
  },
  "Result": {
    "CatalogName": "hive",
    "SchemaName": "default",
    "TableName": "sample_table",
    "Location": "tos://bucket/default/sample_table/",
    "PartitionType": "PARTITION",
    "TableComment": "registered from lf",
    "FileFormat": "Parquet",
    "TableType": "EXTERNAL_TABLE",
    "CreateTime": "2026-05-18 18:00:00",
    "UpdateTime": "2026-05-18 18:00:00",
    "CompressFormat": "",
    "InputFormat": "",
    "OutputFormat": "",
    "Owner": "admin",
    "FieldColumns": [
      {
        "ColumnName": "id",
        "ColumnType": "bigint",
        "ColumnDesc": "主键",
        "IsPrimaryKey": true
      }
    ],
    "PartitionColumns": [
      {
        "ColumnName": "dt",
        "ColumnType": "string",
        "ColumnDesc": "分区日期",
        "IsPrimaryKey": false
      }
    ],
    "TableProperties": {
      "comment": "registered from lf"
    },
    "TTLEnabled": false,
    "TTLDays": 0,
    "TieredStorageStrategy": "",
    "AllowDeletion": true,
    "AllowEdition": true,
    "AllowView": true,
    "TableFormat": "Hive",
    "DatasetName": ""
  }
}

函数

ListUDF

请求参数

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

返回参数

参数名称		参数类型
ResponseMetadata			通用响应头
Result	Limit	int	每页数量
	Offset	int	当前偏移
	Total	int	总数
	UDFMetadata	List	UDF 列表，每个元素为 Function 结构（字段同 GetFunction 返回，含以下新增字段）
	UDFMetadata[].AdvancedParams	List	高级参数配置列表，未配置时为空列表。返回结果中： `ParamName`：string，高级参数名称 `ParamSource`：string，参数来源，枚举值包括： `CURRENT_CATALOG`：当前 Catalog 名 `CURRENT_SCHEMA`：当前库名 `CURRENT_TABLE`：当前表名 `CURRENT_COLUMN`：当前列名 `CURRENT_COL_VALUE`：前列值（`$COL_VALUE` 占位符） `CURRENT_USER`：当前用户 ID `CURRENT_ROLE`：当前角色 ID

示例
请求示例

GET /?Action=ListUDF&Version=2024-04-30&CatalogName=xxx&SchemaName=xxx&FunctionName=xxx&Offset=1&Limit=20 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2025120114261029E29E5E9962909458D2",
        "Action": "ListUDF",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Data": [
            {
                "ClassName": "ApiTest",
                "Owner": "xxx",
                "CreateTime": "2025-12-01 14:21:39",
                "Type": "JAVA",
                "AllowDeletion": true,
                "AllowEdit": true,
                "ResourceSchemaName": null,
                "ResourceName": null,
                "InputParam": "",
                "OutputParam": "",
                "UseCases": "",
                "CatalogName": "xxx",
                "SchemaName": "xxx",
                "ResourceUris": [
                    {
                        "ResourceType": "FILE",
                        "Uri": "tos://ve-test/a.lance/data/47b.file"
                    }
                ],
                "UDFName": "api_test"
            }
        ],
        "Limit": 20,
        "Offset": 1,
        "Total": 1
    }
}

GetFunction

请求参数

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

返回参数

参数名称	参数类型
ResponseMetadata	—
Result	Function

其中，Result结果字段包含以下字段。

参数名称	类型	说明
CatalogName	String	所属 Catalog
SchemaName	String	所属库
UDFName	String	函数名称
ClassName	String	实现类全限定名
Type	String	函数类型
Owner	String	创建人
CreateTime	String	创建时间
ResourceUris	List	资源包列表
AllowCreate	bool	是否允许创建
AllowDeletion	bool	是否允许删除
AllowEdit	bool	是否允许编辑
AdvancedParams	List	高级参数配置列表，未配置时为空列表。返回结果中： `ParamName`：string，高级参数名称 `ParamSource`：string，参数来源，枚举值包括： `CURRENT_CATALOG`：当前 Catalog 名 `CURRENT_SCHEMA`：当前库名 `CURRENT_TABLE`：当前表名 `CURRENT_COLUMN`：当前列名 `CURRENT_COL_VALUE`：前列值（`$COL_VALUE` 占位符） `CURRENT_USER`：当前用户 ID `CURRENT_ROLE`：当前角色 ID

示例
请求示例

GET /?Action=GetFunction&Version=2024-04-30&CatalogName=xxx&SchemaName=xxx&FunctionName=xxx HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251201142958A326C604B4F170C5B85A",
        "Action": "GetFunction",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "ClassName": "ApiTest",
        "Owner": "xxx",
        "CreateTime": "2025-12-01 14:21:39",
        "Type": "JAVA",
        "AllowDeletion": true,
        "AllowEdit": true,
        "ResourceSchemaName": null,
        "ResourceName": null,
        "InputParam": "",
        "OutputParam": "",
        "UseCases": "",
        "CatalogName": "xxx",
        "SchemaName": "xxx",
        "ResourceUris": [
            {
                "ResourceType": "FILE",
                "Uri": "tos://ve-test/a.lance/data/47b.file"
            }
        ],
        "UDFName": "api_test"
    }
}

CreateFunction

请求参数

参数名称	参数类型	是否必须	默认值	说明
CatalogName	String	N	hive	默认catalog，非必传
SchemaName	String	Y		数据库名（由小写字母、数字、下划线组成，最长256字符）
UDFName	String	Y		—
Type	String	Y		Java
ClassName	String	Y		类名
ResourceUris	List	Y		资源路径，包含以下子字段： `ResourceType`：string，资源类型，可选值：`JAR`、`FILE`、`ARCHIVE`（大小写不敏感） `Uri`：string，资源路径。
AdvancedParams	List	N		高级参数配置列表，用于列掩码参数注入，不填则不生效，包含以下子字段： `ParamName`：string，参数名称，需与函数定义完全一致，区分大小写 `ParamSource`：string，参数来源，枚举值包括： `CURRENT_CATALOG`：当前 Catalog 名 `CURRENT_SCHEMA`：当前库名 `CURRENT_TABLE`：当前表名 `CURRENT_COLUMN`：当前列名 `CURRENT_COL_VALUE`：前列值（`$COL_VALUE` 占位符） `CURRENT_USER`：当前用户 ID `CURRENT_ROLE`：当前角色 ID

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

示例
请求示例

POST /?Action=CreateFunction&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "ProjectName": "",
    "UdfName": "api_test",
    "CatalogName": "xxx",
    "SchemaName": "xxx",
    "Type": "JAVA",
    "ClassName": "ApiTest",
    "ResourceUris": [
        {
            "ResourceType": "JAR",
            "Uri": "tos://ve-test/ApiTest.jar"
        }
    ]
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202512011421390xxx4F3C4A3CDAF80399",
        "Action": "CreateFunction",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

AlterFunction

请求参数

参数名称	参数类型	是否必须	说明
CatalogName	String	N	catalogName 不传使用默认值
SchemaName	String	Y	数据库名（由小写字母、数字、下划线组成，最长256字符）
UDFName	String	Y
Type	String	Y	Java
ClassName	String	Y	类名
ResourceUris	List	Y	资源路径，包含以下子字段： `ResourceType`：string，资源类型，可选值：`JAR`、`FILE`、`ARCHIVE`（大小写不敏感） `Uri`：string，资源路径。
AdvancedParams	List	N	高级参数配置列表，用于列掩码参数注入，不填则不生效，包含以下子字段： `ParamName`：string，参数名称，需与函数定义完全一致，区分大小写 `ParamSource`：string，参数来源，枚举值包括： `CURRENT_CATALOG`：当前 Catalog 名 `CURRENT_SCHEMA`：当前库名 `CURRENT_TABLE`：当前表名 `CURRENT_COLUMN`：当前列名 `CURRENT_COL_VALUE`：前列值（`$COL_VALUE` 占位符） `CURRENT_USER`：当前用户 ID `CURRENT_ROLE`：当前角色 ID

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

示例
请求示例

POST /?Action=AlterFunction&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "UdfName": "xxx",
    "CatalogName": "xxxx",
    "SchemaName": "xxx",
    "Type": "JAVA",
    "ClassName": "ApiTest",
    "ResourceUris": [
        {
            "ResourceType": "FILE",
            "Uri": "tos://ve-test/a.lance/data/2bfbb698.lance"
        }
    ]
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251201143xxx8257CCD7D268B7A87EC7",
        "Action": "AlterFunction",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

DropFunction

请求参数

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

返回参数

参数名称		类型
ResponseMetadata
Result	Success	boolean

示例
请求示例

POST /?Action=DropFunction&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "UdfName": "xxx",
    "CatalogName": "xxx",
    "SchemaName": "xxx"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251201144125BE4B7AA8xx1E3603ED83",
        "Action": "DropFunction",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

列掩码（Column Mask）

注意事项

调用接口绑定列掩码时，可选择已创建的函数，跨 catalog 创建的函数也可用，但操作账号需有对应函数的 execute 权限。

BindColumnMask

接口描述：将表的某列与指定脱敏 UDF 绑定。若该列已有绑定，则覆盖更新。
请求方式：POST
请求参数（Request Body，JSON）：

参数名称	类型	是否必须	说明
`CatalogName`	String	是	目标列所在的 Catalog
`SchemaName`	String	是	目标列所在的库名
`TableName`	String	是	目标列所在的表名
`ColName`	String	是	目标列名
`UdfCatalogName`	String	是	脱敏函数所在的 Catalog
`UdfSchemaName`	String	是	脱敏函数所在的库名
`UdfName`	String	是	脱敏函数名称

返回参数：

参数名称	类型	说明
`Success`	Boolean	是否绑定成功

UnbindColumnMask

接口描述：解除某列的脱敏函数绑定。函数本身不会被删除，该列数据对有查看权限的用户恢复明文可见。
请求方式：POST
请求参数（Request Body，JSON）：

参数名称	类型	是否必须	说明
`CatalogName`	String	是	目标列所在的 Catalog
`SchemaName`	String	是	目标列所在的库名
`TableName`	String	是	目标列所在的表名
`ColName`	String	是	目标列名
`UdfCatalogName`	String	是	脱敏函数所在的 Catalog
`UdfSchemaName`	String	是	脱敏函数所在的库名
`UdfName`	String	是	脱敏函数名称

返回参数：

参数名称	类型	说明
`Success`	Boolean	是否绑定成功

GetColumnMaskBindings

接口描述：查询指定表的列级脱敏绑定信息，返回该表下所有已绑定 mask 的列。
请求方式：POST
请求参数（Request Body，JSON，PascalCase）：

参数名称	类型	是否必须	说明
CatalogName	String	Y	目标列所在 Catalog
SchemaName	String	Y	目标列所在库名
TableName	String	Y	目标列所在表名

响应参数：

参数名称	类型	说明
Bindings	List	绑定列表，无绑定时为空列表

MaskBinding 结构：

参数名称	类型	说明
ColumnName	String	列名
MaskFuncCatalogName	String	脱敏函数所在 Catalog
MaskFuncSchemaName	String	脱敏函数所在库名
MaskFuncName	String	脱敏函数名称

响应示例：

{
  "Bindings": [
    {
      "ColumnName": "phone_number",
      "MaskFuncCatalogName": "hive",
      "MaskFuncSchemaName": "security",
      "MaskFuncName": "mask_phone_middle"
    }
  ]
}

ListColumnMaskBindings

接口描述：分页查询已绑定 mask 的列信息，支持按 Catalog、Schema、Table 过滤。使用游标分页。
请求方式：POST
请求参数（Request Body，JSON，PascalCase）：

参数名称	类型	是否必须	说明
CatalogName	String	Y	过滤条件：Catalog 名称
SchemaName	String	N	过滤条件：库名
TableName	String	N	过滤条件：表名
MaxResults	Integer	N	每页返回条数
NextCursor	String	N	分页游标；首次查询不传

响应参数：

参数名称	类型	说明
Bindings	List	绑定列表
NextCursor	String	下一页游标；无更多数据时为空字符串

MaskBindingDetail 结构：

参数名称	类型	说明
CatalogName	String	目标列所在 Catalog
SchemaName	String	目标列所在库名
TableName	String	目标列所在表名
ColumnName	String	列名
MaskFuncCatalogName	String	脱敏函数所在 Catalog
MaskFuncSchemaName	String	脱敏函数所在库名
MaskFuncName	String	脱敏函数名称

响应示例：

{
  "Bindings": [
    {
      "CatalogName": "hive",
      "SchemaName": "production",
      "TableName": "user_info",
      "ColumnName": "phone_number",
      "MaskFuncCatalogName": "hive",
      "MaskFuncSchemaName": "security",
      "MaskFuncName": "mask_phone_middle"
    }
  ],
  "NextCursor": "1024"
}

分页查询 SQL 语义：

SELECT * FROM gemini_security_objects
WHERE object_kind = MASK
  AND catalog_name = #{catalogName}
  [AND schema_name = #{schemaName}]
  [AND table_name = #{tableName}]
  [AND id > #{nextCursor}]
ORDER BY id ASC
LIMIT #{maxResults}

权限

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

示例
请求示例

GET /?Action=ListPrincipalsForDataObject&Version=2024-04-30&DataObjectScope=Catalog&CatalogName=xxx&Limit=10&Offset=1 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "01019ad8af4563#202512011452366AD84F17EE2731F2FA1E#7230",
        "Action": "ListPrincipalsForDataObject",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Data": [
            {
                "AccountId": "xxx",
                "IdentityId": "xxx",
                "IdentityName": "xxx",
                "IdentityType": "User",
                "Role": "Viewer",
                "AuthorizedSource": "由 xxx 授予",
                "IsInherit": false,
                "ExpiredTime": "-1",
                "ExpiredDays": -1,
                "CatalogName": "xxx",
                "SchemaName": null,
                "DataObjectName": "xxx",
                "OperatorUser": "xxx",
                "UpdateTime": "2025-09-10 14:06:27",
                "DataObjectScope": "Catalog"
            },
            {
                "AccountId": "xxx",
                "IdentityId": "xxx",
                "IdentityName": "xxx",
                "IdentityType": "User",
                "Role": "Admin",
                "AuthorizedSource": "由 系统 授予",
                "IsInherit": false,
                "ExpiredTime": "-1",
                "ExpiredDays": -1,
                "CatalogName": "xxx",
                "SchemaName": null,
                "DataObjectName": "xxx",
                "OperatorUser": "系统",
                "UpdateTime": "2025-08-26 15:08:11",
                "DataObjectScope": "Catalog"
            }
        ],
        "Limit": 10,
        "Offset": 1,
        "Total": 2,
        "Scope": "Catalog"
    }
}

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

示例
请求示例

GET /?Action=ListIAMUsersWithDataObjectRole&Version=2024-04-30&CatalogName=xxx&DataObjectScope=Catalog&IdentityName=&Limit=10 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

响应示例

{
    "ResponseMetadata": {
        "RequestId": "01019ad8b723f3#202512011501121FB409824xxx09500950#0BFE",
        "Action": "ListIAMUsersWithDataObjectRole",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Data": [
            {
                "AccountId": "xxxx",
                "IdentityId": "xx",
                "IdentityName": "xx",
                "IdentityType": "User",
                "Role": ""
            },
            {
                "AccountId": "xxx",
                "IdentityId": "xxx",
                "IdentityName": "xx",
                "IdentityType": "User",
                "Role": ""
            }
        ],
        "Limit": 10,
        "Offset": 1,
        "Total": 2,
        "Scope": "Catalog"
    }
}

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/Column/Row/Decryption
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

示例
请求示例

POST /?Action=GrantDataObjectPrivilege&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "ProjectName": "",
    "IdentityList": [
        {
            "IdentityId": "xxx",
            "IdentityType": "User"
        }
    ],
    "DataObjectScope": "Catalog",
    "CatalogName": "xxx",
    "Role": "Viewer"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "01019ad8b8d543#20251201150303xxxF1F7F232491008BAC#5233",
        "Action": "GrantDataObjectPrivilege",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

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

示例
请求示例

POST /?Action=RevokeDataObjectPrivilege&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "ProjectName": "",
    "IdentityList": [
        {
            "AccountID": "xxx",
            "IdentityId": "xxx",
            "IdentityType": "User"
        }
    ],
    "DataObjectScope": "Catalog",
    "CatalogName": "xxx",
    "SchemaName": null,
    "Role": "Create",
    "DataObjectName": "ve_test"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "01019ad8bc03da#202512011506313xxxF6AD87C47A00AC7B#261C",
        "Action": "RevokeDataObjectPrivilege",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

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

示例
请求示例

POST /?Action=AlterDataObjectPrivilege&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.com
Region: cn-beijing
Service: las

{
    "ProjectName": "",
    "IdentityList": [
        {
            "IdentityId": "xxxx",
            "IdentityType": "User"
        }
    ],
    "DataObjectScope": "Catalog",
    "CatalogName": "xxx",
    "Role": "Create",
    "OldRole": "Viewer"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "01019ad8bac058#2xxx1201150508CCD1E145170DC600B32F#2E8F",
        "Action": "AlterDataObjectPrivilege",
        "Version": "2024-04-30",
        "Service": "las",
        "Region": "cn-beijing",
        "Error": null
    },
    "Result": {
        "Success": true
    }
}

数据结构

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，则为空。多个以 , 分隔

返回结构及公共错误码

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

最近更新时间：2026.08.04 11:29:51

这个页面对您有帮助吗？

有用

无用

AI 数据湖服务

API概览 #

数据目录 #

数据库 #

数据表 #

分区

函数 #

列掩码 #

权限 #

获取安全凭证 #

API接入 #

服务信息 #

数据目录 #

ListCatalogs #

GetCatalog #

CreateCatalog #

AlterCatalog #

数据库 #

ListSchema #

GetSchema #

ListSchemaNames #

CreateSchema #

AlterSchema #

DropSchema #

数据表 #

ShowTables #

GetTableDetail #

GetTableStats #

ShowPartitions #

CreateTable #

AlterTable #

DropTable #

RegisterTable #

函数 #

ListUDF #

GetFunction #

CreateFunction #

AlterFunction #

DropFunction #

列掩码（Column Mask） #

注意事项 #

BindColumnMask #

UnbindColumnMask #

GetColumnMaskBindings #

ListColumnMaskBindings #

权限 #

ListPrincipalsForDataObject #

ListIAMUsersWithDataObjectRole #

GrantDataObjectPrivilege #

RevokeDataObjectPrivilege #

AlterDataObjectPrivilege #

数据结构 #

Catalog #

Schema #

Table #

TableDetail

FiledSchema

Stats

Partition

Function #

ResourceUri

AuthorizedPrincipal #

IAMUserWithRole #

返回结构及公共错误码 #

API概览

数据目录

数据库

数据表

函数

列掩码

权限

获取安全凭证

API接入

服务信息

数据目录

ListCatalogs

GetCatalog

CreateCatalog

AlterCatalog

数据库

ListSchema

GetSchema

ListSchemaNames

CreateSchema

AlterSchema

DropSchema

数据表

ShowTables

GetTableDetail

GetTableStats

ShowPartitions

CreateTable

AlterTable

DropTable

RegisterTable

函数

ListUDF

GetFunction

CreateFunction

AlterFunction

DropFunction

列掩码（Column Mask）

注意事项

BindColumnMask

UnbindColumnMask

GetColumnMaskBindings

ListColumnMaskBindings

权限

ListPrincipalsForDataObject

ListIAMUsersWithDataObjectRole

GrantDataObjectPrivilege

RevokeDataObjectPrivilege

AlterDataObjectPrivilege

数据结构

Catalog

Schema

Table

Function

AuthorizedPrincipal

IAMUserWithRole

返回结构及公共错误码