You need to enable JavaScript to run this app.
Lake AI Service

Lake AI Service

  • Documentation
    • Lake AI ServiceAPI reference: control planeData lakeCatalog
Copy page
Download PDF
Data lake
Catalog
Copy page
Download PDF
Catalog

API overview

tip

The Volcano Engine LAS API reference documentation provides interfaces related to metadata and permissions for accessing the unified metadata service, including how to use it, its features, and limitations. Please read this reference documentation carefully before using our API.

Data catalog

API

Note

ListCatalogs

Query data catalog list

GetCatalog

Query data catalog details

CreateCatalog

Create data catalog

AlterCatalog

Edit data catalog

Database

API

Note

ListSchema

Query database list

GetSchema

Query database details

ListSchemaNames

Search database name

CreateSchema

Create database

AlterSchema

Edit database

DropSchema

Delete database

Tables

API

Note

ShowTables

Get metadata table list

GetTableDetail

Get metadata table details

GetTableStats

Get statistics

CreateTable

Create metadata table

AlterTable

Edit metadata table

DropTable

Delete metadata table

RegisterTable

Register or identify a Lake Formation table

Partition

API

Note

ShowPartitions

Query table partitions

Function

API

Note

ListUDF

Query function list

GetFunction

Query function details

CreateFunction

Create function

AlterFunction

Edit function

DropFunction

Delete function

Column mask

API

Note

BindColumnMask

Bind column mask

UnbindColumnMask

Unbind column mask

GetColumnMaskBindings

Unbind the masking function from a column.

ListColumnMaskBindings

Paginated query for columns with mask bindings

Permissions

API

Note

ListPrincipalsForDataObject

Get list of users/user groups with permissions

ListIAMUsersWithDataObjectRole

Query user list

GrantDataObjectPrivilege

Grant permissions for a specified data object to a user

RevokeDataObjectPrivilege

Revoke a user's permissions for a specified data object

AlterDataObjectPrivilege

Edit a user's permissions for a specified object

Obtain security credentials

Access Key (access credential) is the security credential for accessing Volcano Engine services. It consists of two parts: Access Key ID (abbreviated as AK) and Secret Access Key (abbreviated as SK). You can log in to the Volcano Engine console and go to Access Control > Access Key to create and manage your Access Key. For more information, refer to the Access Key help documentation.

API access

Service information

Field

Note

Example

Remarks

AK

Volcano Engine Access Key

AKLTZWU*****

SK

Volcano Engine Secret Key

TW1KaVl******

Service domain name

Domain name

https://las.cn-beijing.volcengineapi.com

Region

Region

cn-beijing

Currently supported

  • cn-beijing
  • cn-shanghai
  • cn-guangzhou

Service

Service

las

Fixed value

Action

API

ListSchema

Version

Version

2024-04-30

Fixed value

Data catalog

ListCatalogs

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

Offset

int

N

1

Pagination

Limit

int

N

20

Number of items per page, default is 20

Response parameters

Parameter name

Type

ResponseMetadata

—

Result

Limit

int

Offset

int

Total

int

Data

List<Catalog>

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

Y

hive

Catalog name to query

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

Result

Catalog

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Catalog

Catalog

Y

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

Example
Request example

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"
}

Response example

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

AlterCatalog

Request parameters

Parameter name

Parameter type

Required

CatalogName

String

Y

Catalog

Catalog

Y

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

Example
Request example

POST /?Action=AlterCatalog&Version=2024-04-30 HTTP/1.1
Host: las.cn-beijing.volcengineapi.comineapi.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"
    }
}

Response example

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

Database

ListSchema

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

N

—

Target schema name

Offset

int

N

1

Pagination

Limit

int

N

20

Number of items per page, default is 20

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

—

Result

Limit

int

Offset

int

Total

int

Data

List

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

—

Schema name

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

Result

Schema

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

Offset

int

N

1

Pagination

Limit

int

N

20

Number of items per page, default is 20

Response parameters

Parameter name

Type

ResponseMetadata

—

—

Result

Limit

int

Offset

int

Total

int

SchemaNames

List

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

—

Database name (consists of lowercase letters, numbers, and underscores, up to 256 characters)

Location

String

Y

—

Storage location

Description

String

N

—

Description

Response parameters

Parameter name

Type

ResponseMetadata

—

—

Result

Success

boolean

Example
Request example

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"
}

Response example

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

AlterSchema

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

Y

—

Required

SchemaName

String

Y

—

Database name (consists of lowercase letters, numbers, and underscores, up to 256 characters)

Location

String

Y

—

Storage location

Description

String

N

—

Description

Response parameters

Parameter name

Type

ResponseMetadata

—

—

Result

Success

boolean

Example
Request example

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"
}

Response example

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

DropSchema

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

Y

—

Required

SchemaName

String

Y

—

Database name, required

Response parameters

Parameter name

Type

ResponseMetadata

—

—

Result

Success

boolean

Example
Request example

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"
}

Response example

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

Tables

ShowTables

Request parameters

Parameter name

Required

Default value

Note

CatalogName

N

hive

Default catalog, optional

SchemaName

Y

—

Database name

TableName

N

—

Search

Offset

N

1

Pagination

Limit

N

20

Number of items per page, default is 20

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

—

Result

Limit

int

Offset

int

Total

int

Data

List<Table>

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

—

—

TableName

String

Y

—

—

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

Result

Table

The detailed fields in Result are as follows.

Parameter name

Type

Note

CatalogName

String

Associated Catalog

SchemaName

String

Database name

TableName

String

Table name

Location

String

Table storage path

PartitionType

String

Partition type enumeration

TableComment

String

Table remarks

TableFormat

String

Table format: Hive / Paimon / Iceberg / Lance

FileFormat

String

File format: Parquet / ORC / TextFile / SequenceFile / Paimon / Iceberg / Lance

TableType

String

External / Managed

CreateTime

String

Creation time

UpdateTime

String

Update time

Owner

String

Table owner

FieldColumns

List

Field list. For the element structure, see the BaseColumn structure description below.

PartitionColumns

List

Partition field list. For the element structure, see the BaseColumn structure description below.

TableProperties

Map<String, String>

Table property key-value pairs

TtlEnabled

Boolean

Whether TTL is enabled

TtlDays

Integer

TTL days

TieredStorageStrategy

String

Tiered storage strategy: LastModifiedTime / PartitionValue / CreateTime

AllowDeletion

Boolean

Whether deletion is allowed

AllowEdition

Boolean

Whether editing is allowed

BaseColumn structure (FieldColumns / PartitionColumns element BatchGetFuncParams structure):

Parameter name

Type

Note

ColumnName

String

Column name

ColumnType

String

Column type

ColumnDesc

String

Column description

IsPrimaryKey

Boolean

Whether it is a primary key

MaskFunctionName

String

Name of the bound masking function; null if not bound

MaskFunctionCatalogName

String

Catalog where the masking function resides; null if not bound

MaskFunctionSchemaName

String

Database name where the masking function resides; null if not bound

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

—

—

TableName

String

Y

—

Displayed in full by default

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

Result

Stats

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

—

—

TableName

String

Y

—

—

Offset

int

N

1

Partition page number

Limit

int

N

20

Number of items per page, default is 20

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

—

Result

Limit

int

Offset

int

Total

int

Data

List

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

—

Default catalog, optional

SchemaName

String

Y

—

TableName

String

Y

—

Displayed in full by default

TableType

String

N

MANAGED_TABLE

Table type

FileFormat

String

N

Parquet

Storage format. Currently available values are Parquet, ORC, Avro, TextFile, SequenceFile, RcFile, JSON,

TableComment

String

N

—

Table comment

PartitionType

String

Y

—

Partition type. Options are PARTITION and NON_PARTITION

Location

String

N

—

Storage TOS bucket

FieldColumns

List

Y

—

Field list

PartitionColumns

List

N

—

Partition field list, mandatory for partitioned tables

FieldColumn

ColumnName

String

Y

—

Field name

ColumnType

String

Y

—

Field type. Refer to official website
tinyint,smallint,int,bigint,float,double,decimal,timestamp,date,interval,,string,varchar,char,boolean,binary,array,maps,struct,union

ColumnDesc

String

N

—

Field description

TableProperties

Map<String, String>

N

—

Advanced configuration

Response parameters

Parameter name

Type

ResponseMetadata

—

—

Result

Success

boolean

Example
Request example

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"
}

Response example

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

AlterTable

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

Default catalog, optional

SchemaName

String

Y

Database name

TableName

String

Y

Table name

TableComment

String

N

Table comment

Location

String

N

Storage TOS bucket

FieldColumns

List

Y

Field list, fully overwrite

FieldColumn

ColumnName

String

Y

Field name

ColumnType

String

Y

Field type. Refer to official website
tinyint,smallint,int,bigint,float,double,decimal,timestamp,date,interval,,string,varchar,char,boolean,binary,array,maps,struct,union

ColumnDesc

String

N

Field description

TableProperties

Map<String, String>

N

Advanced configuration, fully overwrite

Response parameters

Parameter name

Type

ResponseMetadata

—

—

Result

Success

boolean

Example
Request example

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"
}

Response example

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

DropTable

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

Default catalog, optional

SchemaName

String

Y

Database name

TableName

String

Y

Table name

Response parameters

Parameter name

Type

ResponseMetadata

—

—

Result

Success

boolean

Example
Request example

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"
}

Response example

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

RegisterTable

Used to register or identify a Lake Formation table based on the specified table name, file format, and storage path. Returns the details of the identified table.

warning

The current RegisterTable only supports tables in Lance format.

API description

Request method

POST

Content-Type

application/json

Request parameters

Parameter
Type
Required
Example value
Description
CatalogName
String
No
hive
Catalog name. If empty, the default Catalog is used.
SchemaName
String
Yes
default
Schema name. If you have not regedited in the Catalog, you can fill in default.
TableName
String
Yes
sample_table
Table name.
FileFormat
String
No
Parquet
File format. Supported formats: Parquet, ORC, TextFile, Hive, File, SequenceFile, Lance, Iceberg, and PAIMON.
TableComment
String
No
registered from lf
Table comment.
PartitionType
String
No
PARTITION
Partition type. No mandatory validation under the Register group. Whether the table is partitioned depends on the underlying table information.
Location
String
Yes
tos://bucket/default/sam...
Table registration location. Required under the Register group.
FieldColumns
Array of TableColumn
No
{}
List of field column definitions.
PartitionColumns
Array of TableColumn
No
{}
List of partition column definitions. If empty, the code will convert it to an empty array.
TableProperties
TableProperties
No
{}
Table property key-value object.
TTLEnabled
Boolean
No
false
TTL switch. Currently, there is no explicit validation under the Register group.
TTLDays
Long
No
0
TTL days. Currently, there is no explicit validation under the Register group.
TieredStorageStrategy
String
No
CreateTime
Tiered storage strategy.
CreateType
String
No
meta
Creation type. Supports meta, meta_file, or empty.
TableFormat
String
No
Hive
Table format. The code currently validates this field, but LFTable construction does not directly use it. Actual behavior is mainly determined by FileFormat and the underlying implementation.

Response parameters

Parameter
Type
Example value
Description
CatalogName
String
hive
Catalog name.
SchemaName
String
default
Schema name.
TableName
String
sample_table
Table name.
Location
String
tos://bucket/default/sample_table/
Table path.
PartitionType
String
PARTITION
Partition type.
TableComment
String
registered from lf
Table comment.
FileFormat
String
Parquet
File format.
TableType
String
EXTERNAL_TABLE
Table type.
CreateTime
String
2026-05-18 18:00:00
Creation time.
UpdateTime
String
2026-05-18 18:00:00
Update time.
CompressFormat
String
--
Compression format.
InputFormat
String
--
Input format class.
OutputFormat
String
--
Output format class.
Owner
String
admin
Owner.
FieldColumns
Array of TableColumn
{}
General field list.
PartitionColumns
Array of TableColumn
{}
Partition field list.
TableProperties
TableProperties
{}
Table property key-value object.
TTLEnabled
Boolean
false
Indicates whether TTL is enabled.
TTLDays
Long
0
TTL days.
TieredStorageStrategy
String
--
Tiered storage strategy. The code will perform compatibility normalization.
AllowDeletion
Boolean
true
Indicates whether deletion is allowed.
AllowEdition
Boolean
true
Whether editing is allowed.
AllowView
Boolean
true
Whether viewing is allowed.
TableFormat
String
Hive
Table format.
DatasetName
String
--
Dataset name in Lake format scenarios; populate where possible.

Example
Request example

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"
  },
  "TableFormat": "Hive"
}

Response example

{
  "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": ""
  }
}

Function

ListUDF

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

—

—

FunctionName

String

N

—

Target function name

Offset

int

N

1

Pagination

Limit

int

N

20

Number of items per page, default is 20

Response parameters

Parameter name

Parameter type

ResponseMetadata

General response header

Result

Limit

int

Number per page

Offset

int

Current offset

Total

int

Total count

UDFMetadata

List

UDF list. Each element is a Function structure (fields are the same as those returned by GetFunction, with the following additional fields)

UDFMetadata[].AdvancedParams

List

Advanced parameter configuration list. If not configured, the list is empty. In the response result:

  • ParamName: string, advanced parameter name
  • ParamSource: string, parameter source. The enumeration values include:
    • CURRENT_CATALOG: current Catalog name
    • CURRENT_SCHEMA: current schema name
    • CURRENT_TABLE: current table name
    • CURRENT_COLUMN: current column name
    • CURRENT_COL_VALUE: previous column value ($COL_VALUE placeholder)
    • CURRENT_USER: current user ID
    • CURRENT_ROLE: current role ID

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

—

—

FunctionName

String

Y

—

—

Response parameters

Parameter name

Parameter type

ResponseMetadata

—

Result

Function

The Result field contains the following fields.

Parameter name

Type

Note

CatalogName

String

Associated Catalog

SchemaName

String

Associated schema

UDFName

String

Function name

ClassName

String

Fully qualified implementation class name

Type

String

Function type

Owner

String

Created by

CreateTime

String

Creation time

ResourceUris

List

Resource package list

AllowCreate

bool

Whether creation is allowed

AllowDeletion

bool

Whether deletion is allowed

AllowEdit

bool

Whether editing is allowed

AdvancedParams

List

Advanced parameter configuration list. If not configured, the list is empty. In the response result:

  • ParamName: string, advanced parameter name
  • ParamSource: string, parameter source. The enumeration values include:
    • CURRENT_CATALOG: current Catalog name
    • CURRENT_SCHEMA: current schema name
    • CURRENT_TABLE: current table name
    • CURRENT_COLUMN: current column name
    • CURRENT_COL_VALUE: previous column value ($COL_VALUE placeholder)
    • CURRENT_USER: current user ID
    • CURRENT_ROLE: current role ID

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

hive

Default catalog, optional

SchemaName

String

Y

Database name (consists of lowercase letters, numbers, and underscores, up to 256 characters)

UDFName

String

Y

—

Type

String

Y

Java

ClassName

String

Y

Class name

ResourceUris

List

Y

Resource path, including the following subfields:

  • ResourceType: string, resource type. Optional values: JAR, FILE, ARCHIVE (case-insensitive)
  • Uri: string, resource path.

AdvancedParams

List

N

Advanced parameter configuration list, used for column masking parameter injection. If not specified, it is not effective. Includes the following subfields:

  • ParamName: string, parameter name. Must exactly match the function definition, case-sensitive
  • ParamSource: string, parameter source. The enumeration values include:
    • CURRENT_CATALOG: current Catalog name
    • CURRENT_SCHEMA: current schema name
    • CURRENT_TABLE: current table name
    • CURRENT_COLUMN: current column name
    • CURRENT_COL_VALUE: previous column value ($COL_VALUE placeholder)
    • CURRENT_USER: current user ID
    • CURRENT_ROLE: current role ID

Response parameters

Parameter name

Type

ResponseMetadata

Result

Success

boolean

Example
Request example

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"
        }
    ]
}

Response example

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

AlterFunction

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

N

If catalogName is not provided, the default value is used

SchemaName

String

Y

Database name (consists of lowercase letters, numbers, and underscores, up to 256 characters)

UDFName

String

Y

Type

String

Y

Java

ClassName

String

Y

Class name

ResourceUris

List

Y

Resource path, including the following subfields:

  • ResourceType: string, resource type. Optional values: JAR, FILE, ARCHIVE (case-insensitive)
  • Uri: string, resource path.

AdvancedParams

List

N

Advanced parameter configuration list, used for column masking parameter injection. If not specified, it is not effective. Includes the following subfields:

  • ParamName: string, parameter name. Must exactly match the function definition, case-sensitive
  • ParamSource: string, parameter source. The enumeration values include:
    • CURRENT_CATALOG: current Catalog name
    • CURRENT_SCHEMA: current schema name
    • CURRENT_TABLE: current table name
    • CURRENT_COLUMN: current column name
    • CURRENT_COL_VALUE: previous column value ($COL_VALUE placeholder)
    • CURRENT_USER: current user ID
    • CURRENT_ROLE: current role ID

Response parameters

Parameter name

Type

ResponseMetadata

Result

Success

boolean

Example
Request example

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"
        }
    ]
}

Response example

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

DropFunction

Request parameters

Parameter name

Parameter type

Required

Default value

Note

CatalogName

String

Y

catalogName

SchemaName

String

Y

Database name

UDFName

String

Y

Response parameters

Parameter name

Type

ResponseMetadata

Result

Success

boolean

Example
Request example

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"
}

Response example

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

Column mask (Column Mask)

Notes

When binding a column mask through the API, you can select a function that has already been created. Functions created across catalogs are also available, but the operation account must have execute permission for the corresponding function.

BindColumnMask

API description: Bind a specified masking UDF to a column of a table. If the column is already bound, the binding will be overwritten and updated.
Request method: POST
Request parameters (Request Body, JSON):

Parameter name

Type

Required

Note

CatalogName

String

Y

Catalog where the target column is located

SchemaName

String

Y

Schema where the target column is located

TableName

String

Y

Table where the target column is located

ColName

String

Y

Target column name

UdfCatalogName

String

Y

Catalog where the masking function resides

UdfSchemaName

String

Y

Database name where the masking function resides

UdfName

String

Y

Name of the masking function

Response parameters:

Parameter name

Type

Note

Success

Boolean

Indicates whether the binding was successful

UnbindColumnMask

API description: Unbind the masking function from a column. The function itself will not be deleted. The column data will be visible in plaintext to users with view permissions.
Request method: POST
Request parameters (Request Body, JSON):

Parameter name

Type

Required

Note

CatalogName

String

Y

Catalog where the target column is located

SchemaName

String

Y

Schema where the target column is located

TableName

String

Y

Table where the target column is located

ColName

String

Y

Target column name

UdfCatalogName

String

Y

Catalog where the masking function resides

UdfSchemaName

String

Y

Database name where the masking function resides

UdfName

String

Y

Name of the masking function

Response parameters:

Parameter name

Type

Note

Success

Boolean

Indicates whether the binding was successful

GetColumnMaskBindings

API description: Query column-level masking binding information for a specified table, returning all columns in the table that have a mask bound.
Request method: POST
Request parameters (Request Body, JSON, PascalCase):

Parameter name

Type

Required

Note

CatalogName

String

Y

Catalog where the target column resides

SchemaName

String

Y

Database name where the target column resides

TableName

String

Y

Table name where the target column resides

Response parameters:

Parameter name

Type

Note

Bindings

List

List of bindings; returns an empty list if there are no bindings

MaskBinding structure:

Parameter name

Type

Note

ColumnName

String

Column name

MaskFuncCatalogName

String

Catalog where the masking function resides

MaskFuncSchemaName

String

Database name where the masking function resides

MaskFuncName

String

Name of the masking function

Response example:

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

ListColumnMaskBindings

API description: Paginated query for columns with mask bindings, supports filtering by Catalog, Schema, and Table. Cursor pagination is used.
Request method: POST
Request parameters (Request Body, JSON, PascalCase):

Parameter name

Type

Required

Note

CatalogName

String

Y

Filter condition: catalog name

SchemaName

String

N

Filter condition: database name

TableName

String

N

Filter condition: table name

MaxResults

Integer

N

Number of items returned per page

NextCursor

String

N

Pagination cursor; leave empty for the first query

Response parameters:

Parameter name

Type

Note

Bindings

List

List of bindings

NextCursor

String

Cursor for the next page; returns an empty string if there is no more data

MaskBindingDetail structure:

Parameter name

Type

Note

CatalogName

String

Catalog where the target column resides

SchemaName

String

Database name where the target column resides

TableName

String

Table name where the target column resides

ColumnName

String

Column name

MaskFuncCatalogName

String

Catalog where the masking function resides

MaskFuncSchemaName

String

Database name where the masking function resides

MaskFuncName

String

Name of the masking function

Response example:

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

Paginated query SQL semantics:

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}

Permissions

ListPrincipalsForDataObject

Request parameters

Parameter

Required

Description

DataObjectScope

Y

Specify objects at different levels. Options are: Schema/Table/UDF/Resource

SchemaName

Y

Schema Name

DataObjectName

N

DataObject name. If Scope is Schema, this item is empty

IdentityName

N

Filter: User or group name keyword search, exact match

IdentityType

N

Filter: User type. Options are: User, Group, GroupDataLeap. If multiple selections, separate with commas, such as xxx,yyy

Role

N

Filter: Role. Options are: Admin, Viewer, Developer. If multiple selections, separate with commas, such as xxx,yyy

Limit

Y

This is the maximum number that can be displayed per page

Offset

Y

The minimum value is 1, representing the page number

Response parameters

Parameter name

Parameter type

ResponseMetadata

Result

Limit

int

Offset

int

Total

int

Data

List

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter

Required

Description

IdentityName

Y

User name, supports fuzzy search

DataObjectScope

Y

The level of the DataObject object. Optional values: Schema/Table/UDF

SchemaName

Y

Schema Name

DataObjectName

N

Data object name. When Scope is Schema, this field is empty

Limit

N

This is the maximum number that can be displayed per page. The default is 10

Response parameters

Parameter name

Parameter type

ResponseMetadata

Result

Limit

int

Offset

int

Total

int

Data

List

Example
Request example

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

Response example

{
    "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

Request parameters

Parameter

Parameter type

Required

Description

IdentityList

Array

Y

User information array

IdentityList.AccountID

String

N

User AccountID. The default is the current user's AccountID

IdentityList.IdentityId

String

Y

User/group ID

IdentityList.IdentityType

String

Y

User type: User/Group/GroupDataLeap

DataObjectScope

String

Y

The level of the DataObject object. Optional values: Schema/Table/UDF/Resource/Column/Row/Decryption

SchemaName

String

Y

Schema Name

DataObjectName

String

N

Data object name. When Scope is Schema, this field is empty

Role

String

Y

Role (operation permissions on the data object). Optional values: Admin/Viewer/Developer

ExpiredDays

Int

N

Expiration days, for example: 30 means applying for 30 days of permission, starting from today, expiring after 30 days.

  • -1 means "permanent authorization"
  • When Scope is UDF and Resource, this field is empty.

Response parameters

Parameter name

Parameter type

ResponseMetadata

Result

OperateResponse

Example
Request example

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"
}

Response example

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

RevokeDataObjectPrivilege

Request parameters

Parameter

Parameter type

Required

Description

IdentityList

Array

Y

User information array

IdentityList.AccountID

String

N

User AccountID. The default is the current user's AccountID

IdentityList.IdentityId

String

Y

User/group ID

IdentityList.IdentityType

String

Y

User type: User/Group/GroupDataLeap

DataObjectScope

String

Y

The level of the DataObject object. Optional values: Schema/Table/UDF/Resource

SchemaName

String

Y

Schema Name

DataObjectName

String

N

Data object name. When Scope is Schema, this field is empty

Role

String

Y

Role: Admin/Viewer/Developer

Response parameters

Parameter name

Parameter type

ResponseMetadata

Result

OperateResponse

Example
Request example

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"
}

Response example

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

AlterDataObjectPrivilege

Request parameters

Parameter

Parameter type

Required

Description

IdentityList

Array

Y

User information array

IdentityList.AccountID

String

N

User AccountID. The default is the current user's AccountID

IdentityList.IdentityId

String

Y

User/group ID

IdentityList.IdentityType

String

Y

User type: User/Group/GroupDataLeap

DataObjectScope

String

Y

The level of the DataObject object. Optional values: Schema/Table/UDF/Resource

SchemaName

String

Y

Schema Name

DataObjectName

String

N

Data object name. When Scope is Schema, this field is empty

OldRole

String

Y

Old role (operation permissions on the data object). Optional values: Admin/Viewer/Developer

Role

String

Y

Role (operation permissions on the data object). Optional values: Admin/Viewer/Developer

ExpiredDays

Int

N

Expiration days, for example: 30 means applying for 30 days of permission, starting from today, expiring after 30 days.

  • -1 means "permanent authorization"
  • When Scope is UDF and Resource, this field is empty.

Response parameters

Parameter name

Parameter type

ResponseMetadata

Result

OperateResponse

Example
Request example

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"
}

Response example

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

Data structure

Catalog

Parameter name

Type

CatalogName

String

Location

String

Description

String

Owner

String

CreateTime

String

UpdateTime

String

Schema

Parameter name

Parameter type

Name

String

TableCount

String

Location

String

Description

String

Owner

String

CatalogName

String

CreateTime

String

UpdateTime

String

Table

Parameter name

Parameter type

CatalogName

String

SchemaName

String

TableName

String

Location

String

Owner

String

CreateTime

String

UpdateTime

String

TableDetail

Parameter name

Parameter type

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

Parameter name

Parameter type

ColumnName

String

ColumnType

String

ColumnDesc

String

Stats

Parameter name

Parameter type

Parameter description

Storage

String

Storage size

NumFiles

String

Number of files

UpdateTime

String

Last modified time

NumPartitions

String

Number of table partitions

Storage

String

Storage size

Partition

Parameter name

Field type

PartitionName

String

DataRows

String

NumFiles

String

Storage

String

CreateTime

String

UpdateTime

String

Function

Parameter name

Parameter type

CatalogName

String

SchemaName

String

UDFName

String

ClassName

String

Type

String

Owner

String

CreateTime

String

ResourceUris

List

ResourceUri

Parameter name

Parameter type

Note

ResourceType

String

JAR,
FILE,
ARCHIVE;

Uri

String

Storage location

AuthorizedPrincipal

Parameter

Type

Description

AccountId

String

AccountID of the tenant to which the user belongs

IdentityId

String

User/group ID

IdentityName

String

User/group name

IdentityType

String

User type: User/Group

Role

String

Role: Admin/Viewer/Developer

AuthorizedSource

String

Authorization source: granted by xxx, or originated from inheritance

IsInherit

Boolean

true/false. true indicates that it is inherited and cannot be modified or deleted

ExpiredTime

String

Expiration time: 2021-12-30 23:23:23, -1 indicates "permanent authorization". This field is empty for UDF/Resource/Queue.

ExpiredDays

Int

Expiration days: 20, -1 indicates "permanent authorization"

IAMUserWithRole

Parameter

Type

Description

AccountId

String

AccountID of the tenant to which the user belongs

IdentityId

String

User/group ID

IdentityName

String

User/group name

IdentityType

String

User type: User/Group

Role

String

Role: Admin/Viewer/Developer. If there is no Role, this field is empty. Multiple values separated by commas

Response structure and common error codes

After sending a request message, you will receive a response from the message queue server. The returned result includes a status code, response headers, and a message body.
For common response structures and error codes, refer to Response structure.

Last updated: 2026.07.08 17:21:54