# Alibaba Cloud Data Lake Formation API

> Alibaba Cloud Data Lake Formation API on Apizie: 95 endpoints (Aborts the specified metadata lock, Creates multiple partitions for a data lake table in a batch, Creates multiple tables in a data lake, Deletes specified partitions from a data lake table, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-datalake/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-datalake`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/datalake
- Page: https://apizie.tech/api/cloud/aliyun-datalake
- OpenAPI: https://apizie.tech/api/cloud/aliyun-datalake/openapi.json

Alibaba Cloud OpenAPI for Data Lake Formation (datalake, version 2020-07-10). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Aborts the specified metadata lock
`POST https://apizie.tech/v1/cloud:aliyun-datalake/abort-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| LockId | integer | no | The lock ID |

### Creates multiple partitions for a data lake table in a batch
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-create-partitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IfNotExists | string | no | Specifies whether to ignore the error if a partition with the same name already exists |
| NeedResult | string | no | Specifies whether to return partition information. If this parameter is set to \`true\`, the response includes the \`Partitions\` parameter |
| PartitionInputs | array | no | A list of partition inputs |
| TableName | string | no | The name of the data table |

### Creates multiple tables in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-create-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IfNotExists | string | no | Specifies whether to ignore an error if a table with the same name already exists |
| TableInputs | array | no | The list of tables |

### Deletes specified partitions from a data lake table
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-delete-partitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IfExists | string | no | Specifies whether to ignore an error if you try to delete a partition that does not exist |
| PartitionValueList | array | no | The list of partition values to delete |
| TableName | string | no | The name of the data table |

### Deletes specified versions of a data lake table in a batch
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-delete-table-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the table |
| VersionIds | array | no | A list of version numbers |

### Deletes multiple tables in a data lake by name
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-delete-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IfExists | string | no | Specifies whether to ignore the error if the table does not exist |
| TableNames | array | no | The list of table names |

### Retrieves the column statistics of multiple partitions in a data lake table
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-get-partition-column-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The data catalog ID |
| ColumnNames | array | no | The list of fields in the data table |
| DatabaseName | string | no | The name of the database |
| PartitionNames | array | no | The list of partition names for the data table |
| TableName | string | no | The name of the data table |

### Retrieves the details of multiple partitions in a data lake database
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-get-partitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IsShareSd | string | no | Indicates whether to share the column information in the storage descriptor (SD) of the partitions |
| PartitionValueList | array | no | The list of partition values |
| TableName | string | no | The name of the data table |

### Retrieves details for multiple tables in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-get-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableNames | array | no | The names of the data tables |

### Grants operation permissions on resources to DLF users or roles in batches
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-grant-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the catalog |
| GrantRevokeEntries | array | no | The list of authorizations to be granted |
| Type | string | yes | The type of authorization. Only Hive is supported |

### Revokes the granted resource operation permissions from users or data lake roles in batches
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-revoke-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The data catalog ID |
| GrantRevokeEntries | array | no | The list of grants to revoke |
| Type | string | yes | The authorization type. Only Hive is supported |

### Performs a batch update on multiple partitions for a table in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-update-partitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| PartitionInputs | array | no | The list of partition inputs |
| TableName | string | no | The name of the table |

### Batch updates the details of tables in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/batch-update-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IsAsync | string | no | Specifies whether to update the tables asynchronously. Valid values: true: Asynchronous invocation. The API operation returns a response… |
| TableInputs | array | no | The details of the tables to be updated |

### Cancels a query
`POST https://apizie.tech/v1/cloud:aliyun-datalake/cancel-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| QueryId | string | no | The query ID. Call the SubmitQuery operation to obtain the query ID |

### Checks user permissions
`POST https://apizie.tech/v1/cloud:aliyun-datalake/check-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |
| Principal | object | no | The principal |
| PrivilegeResources | array | no | The list of resources to be granted permissions |

### Creates a catalog
`POST https://apizie.tech/v1/cloud:aliyun-datalake/create-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogInput | object | no | The details of the catalog to create |

### Creates a metadatabase in the metadata of a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/create-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseInput | object | no | The details of the database |

### Creates a user-defined function in a database within a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/create-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| FunctionInput | object | no | The details of the function definition |

### Creates a metadata lock
`POST https://apizie.tech/v1/cloud:aliyun-datalake/create-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| LockObjList | array | no | A list of lock information |

### Adds a partition to a data table in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/create-partition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IfNotExists | string | no | Specifies whether to ignore the exception if a partition with the same name already exists |
| NeedResult | string | no | Specifies whether to return partition information. If you set this parameter to true, the Partition object is returned |
| PartitionInput | object | no | The partition input |
| TableName | string | no | The name of the data table |

### Creates a DLF role
`POST https://apizie.tech/v1/cloud:aliyun-datalake/create-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| Description | string | no | The description of the role |
| DisplayName | string | no | Role Display Name |
| Name | string | no | Data Lake Role Name |

### Creates a table in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/create-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableInput | object | no | The details of the table |

### Deletes a catalog
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | yes | The ID of the catalog |
| IsAsync | string | no | Specifies whether the deletion is asynchronous. By default, the operation is synchronous |

### Deletes a database from a catalog
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |
| Name | string | no | The database name |
| Cascade | string | no | Specifies whether to perform a cascade delete. Valid values: true: Deletes the tables in the database. false: Does not delete the tables… |
| Async | string | no | Specifies whether to execute the operation asynchronously |

### Deletes a user-defined function from a database in the data lake by name
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| FunctionName | string | no | The name of the function |

### Deletes a specified partition from a table in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-partition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IfExists | string | no | Specifies whether to ignore an exception if you try to delete a partition that does not exist. Valid values: true: Ignores the exception… |
| PartitionValues | array | no | The partition values |
| TableName | string | no | The name of the table |

### Deletes the column statistics of a table partition in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-partition-column-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the table |
| PartitionNames | string | no | A list of partition names (JSON-encoded) |
| ColumnNames | string | no | A list of column names (JSON-encoded) |

### Deletes a DLF role
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleName | string | no | The name of the role to delete |

### Deletes a data table from a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the data table |

### Deletes the column statistics of a table in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-table-column-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the table |
| ColumnNames | string | no | A list of field names (JSON-encoded) |

### Deletes a specified version of a table in the data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/delete-table-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the data table |
| VersionId | integer | no | The version number |

### Deregisters a location
`POST https://apizie.tech/v1/cloud:aliyun-datalake/deregister-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| LocationId | string | yes | The location ID. Call the RegisterLocation operation to obtain the location ID |

### Retrieves a list of available regions
`GET https://apizie.tech/v1/cloud:aliyun-datalake/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |

### Queries the status of an asynchronous task
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-async-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |
| TaskId | string | no | The ID of the asynchronous task. Obtain this ID from the result of the asynchronous operation |

### Retrieves the details of a catalog
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the catalog |

### Retrieves the configuration of a catalog. This operation requires the admin role or a higher role
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-catalog-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |

### Retrieves the details of a specific database in a data lake
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| Name | string | no | The name of the database |

### Retrieves the database profile
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-database-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |
| DatabaseName | string | yes | The database name |

### Retrieves a user-defined function from a database in a data lake
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| FunctionName | string | no | The name of the user-defined function |

### Retrieves the lifecycle rule of a table
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-lifecycle-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| ResourceName | string | no | The fully qualified table name |
| BizId | string | no | The business ID |

### Queries a specified metadata lock
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| LockId | integer | no | The ID of the lock |

### Retrieves the details of a database partition in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/get-partition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| PartitionValues | array | no | The list of partition values |
| TableName | string | no | The name of the data table |

### Retrieves statistics for specified columns in a data partition of a data lake
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-partition-column-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the data table |
| PartitionNames | string | no | The list of partitions in the data table (JSON-encoded) |
| ColumnNames | string | no | The list of columns in the data table (JSON-encoded) |

### Retrieves the results of a data exploration query
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-query-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| QueryId | string | no | The query ID. You can call the SubmitQuery operation to obtain the query ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Maximum value: 1000 |

### Retrieves the DLF activation status in a region
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-region-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |

### Retrieves a DLF role by its name
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleName | string | no | The name of the role |

### Retrieves the DLF activation status for a user
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-service-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |

### Retrieves the details of a table in a data lake
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the table |

### Retrieves statistics for specified columns in a data lake table
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-table-column-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the data table |
| ColumnNames | string | no | A list of table columns (JSON-encoded) |

### Retrieves the details of a table's data profile
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-table-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |
| DatabaseName | string | yes | The name of the database |
| TableName | string | yes | The name of the table |

### Retrieves a specific version of a table
`GET https://apizie.tech/v1/cloud:aliyun-datalake/get-table-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the table |
| VersionId | integer | no | The version number of the table |

### Grants operation permissions on resources to a user or a data lake role
`POST https://apizie.tech/v1/cloud:aliyun-datalake/grant-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| Accesses | array | yes | The list of accesses |
| CatalogId | string | no | The catalog ID |
| DelegateAccesses | array | yes | The list of grantable accesses |
| MetaResource | object | yes | The metadata resource |
| Principal | object | yes | Specifies the user or role for authorization. The format is as follows: Resource Access Management (RAM) user:… |
| Type | string | yes | The type of authorization. Only Hive is supported |

### Grants a DLF role to multiple users
`POST https://apizie.tech/v1/cloud:aliyun-datalake/grant-role-to-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleName | string | no | The role name |
| Users | array | no | The principal to grant permissions. The format is as follows: RAM user: acs:ram::[accountId]:user/[userName]. RAM role:… |

### Grants multiple roles to a user
`POST https://apizie.tech/v1/cloud:aliyun-datalake/grant-roles-to-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleNames | array | yes | The roles to grant |
| User | object | yes | The RAM identity to grant the roles. The format: RAM role: acs:ram::[accountId]:role/[roleName]. RAM user:… |

### Retrieve catalogs
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-catalogs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| IdPattern | string | no | A regular expression to match catalog IDs |
| NextPageToken | string | no | The token for the next page of results. This is returned in the previous response. For the first request, pass an empty string ('') |
| PageSize | integer | no | The number of entries per page |

### Retrieves a paginated list of databases in a data lake. You can match databases by name
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The namespace for database categorization. By default, this is the UID of the Alibaba Cloud account |
| NamePattern | string | no | A regular expression that matches database names. To match all databases, enter .* |
| NextPageToken | string | no | The token to retrieve the next page of results. This is returned in the response. For the first page, pass an empty string ("") |
| PageSize | integer | no | The number of entries to return on each page |

### Performs a paged query to retrieve a list of function names from a database
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-function-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| FunctionNamePattern | string | no | The regular expression that the function names must match |
| NextPageToken | string | no | The token to retrieve the next page of results. It is returned in the response. To retrieve the first page, pass an empty string ('') or… |
| PageSize | integer | no | The number of entries to return on each page. The maximum value is 1000 |

### Lists the user-defined functions from a database in a data lake
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-functions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| FunctionNamePattern | string | no | A regular expression that filters user-defined functions by name |
| NextPageToken | string | no | The token to retrieve the next page of results. If the response does not provide this token, pass an empty string ("") |
| PageSize | integer | no | The number of entries to return on each page. The maximum value is 1000 |

### Retrieves a list of partition names for a table in a data lake. This operation is typically used for tables…
`POST https://apizie.tech/v1/cloud:aliyun-datalake/list-partition-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| NextPageToken | string | no | The token used to retrieve the next page of results. This token is returned in the response to a previous call. If this is your first… |
| PageSize | integer | no | The number of entries per page. The maximum value is 1000 |
| PartialPartValues | array | no | A list of partition values. You can pass a partial list of partition values to query the names of all sub-partitions |
| TableName | string | no | The name of the data table |

### Lists the details of database partitions in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/list-partitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IsShareSd | string | no | Specifies whether to share the column information in the storage descriptor (SD) of the partition. Valid values: true: Shares the… |
| NextPageToken | string | no | The token for the next page of results. This token is returned in the response. For the first request, pass an empty string |
| PageSize | integer | no | The number of entries per page. The maximum value is 1000 |
| PartialPartValues | array | no | The list of partition values. You can provide a partial list of values to query the names of all sub-partitions |
| TableName | string | no | The name of the data table |

### Lists partitions of a table based on a conditional query
`POST https://apizie.tech/v1/cloud:aliyun-datalake/list-partitions-by-expr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |

### Retrieves a list of partitions for a data table in a data lake based on a filter condition
`POST https://apizie.tech/v1/cloud:aliyun-datalake/list-partitions-by-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The data catalog ID |
| DatabaseName | string | no | The database name |
| Filter | string | no | A conditional expression for the query. The following operators are supported: Comparison operators: =, <>, !=, , and >=. For example: ds… |
| IsShareSd | string | no | Specifies whether to share column information in the storage descriptor (SD) of the partition. Valid values: true: The information is… |
| NextPageToken | string | no | The token to retrieve the next page of results. If no token is returned in the response, pass an empty string ("") |
| PageSize | integer | no | The number of entries per page. The maximum value is 1000 |
| TableName | string | no | The table name |

### Retrieves the details of partition data profiles
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-partitions-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog. By default, the ID of the Alibaba Cloud account is used |
| DatabaseName | string | yes | The name of the metastore database |
| TableName | string | no | The name of the metadata table |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| PartitionNames | string | no | The list of partition names (JSON-encoded) |

### Retrieves a list of permissions
`POST https://apizie.tech/v1/cloud:aliyun-datalake/list-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The data catalog ID |
| IsListUserRolePermissions | string | no | Specifies whether to retrieve the permissions of the roles to which the user belongs. This parameter takes effect only when a specific… |
| MetaResource | object | no | Filters permissions by resource |
| MetaResourceType | string | no | The resource type to filter, such as database or table. If not specified, both are included |
| NextPageToken | string | no | The pagination token used to retrieve the next page of results. If no token is returned in the response, pass an empty string ("") |
| PageSize | integer | no | The number of entries per page. Maximum value: 1000 |
| Principal | object | no | Filters permissions by principal |
| Type | string | yes | The type of permissions to retrieve. Currently, only Hive is supported |

### Lists the users for a specific role
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-role-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleName | string | no | The name of the role |
| PageSize | integer | no | The number of entries per page. The maximum value is 1000 |
| UserNamePattern | string | no | A regular expression that the username must match |
| NextPageToken | string | no | The pagination token from the previous response. If this is your first request, leave this parameter empty or pass an empty string |

### Retrieves DLF roles
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| NextPageToken | string | no | The pagination token used to retrieve the next page of results. If a NextPageToken is not returned in the response, pass an empty string… |
| RoleNamePattern | string | no | A regular expression that the role name must match. Fuzzy search is supported. For example, .\test |
| PageSize | integer | no | The number of entries to return on each page. The maximum value is 1,000 |

### Lists the names of tables in a data lake
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-table-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| TableNamePattern | string | no | The regular expression that is used to match table names |
| NextPageToken | string | no | The token that is used to retrieve the next page of results. This value is returned in the response of a previous request. For the first… |
| PageSize | integer | no | The number of entries to return on each page |
| DatabaseName | string | no | The name of the database |
| TableType | string | no | The type of the table. Valid values: MANAGED_TABLE: internal table. EXTERNAL_TABLE: foreign table. VIRTUAL_VIEW: virtual view.… |

### Performs the versions of a table
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-table-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the catalog |
| DatabaseName | string | no | The name of the database |
| TableName | string | no | The name of the table |
| NextPageToken | string | no | The token for the next page of results. If the response does not include this token, pass an empty string ("") |
| PageSize | integer | no | The number of entries per page. The maximum value is 1000 |

### Retrieves a list of data tables in a data lake
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| TableNamePattern | string | no | The table name, which is matched using a regular expression |
| NextPageToken | string | no | The pagination token that is returned in the response. To retrieve the first page of results, pass an empty string ('') |
| PageSize | integer | no | The number of entries to return on each page |
| DatabaseName | string | no | The database name |
| TableType | string | no | The type of the data table. Valid values: MANAGED_TABLE: internal table. EXTERNAL_TABLE: external table. VIRTUAL_VIEW: virtual view.… |

### Retrieves the DLF roles assigned to a specific user
`GET https://apizie.tech/v1/cloud:aliyun-datalake/list-user-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| PrincipalArn | string | no | Uniquely identifies a RAM user or RAM role. The format is: RAM user: acs:ram::[accountId]:user/[userName]. RAM role:… |
| PageSize | integer | no | The number of entries per page. The maximum value is 1000 |
| RoleNamePattern | string | no | A regular expression that matches the role name. Fuzzy search is supported |
| NextPageToken | string | no | The token to retrieve the next page of results. If the response does not return this token, pass an empty string ("") |

### Refreshes the specified metadata lock
`POST https://apizie.tech/v1/cloud:aliyun-datalake/refresh-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| LockId | integer | no | The lock ID |

### Registers an Object Storage Service (OSS) path to be managed by Data Lake Formation (DLF)
`POST https://apizie.tech/v1/cloud:aliyun-datalake/register-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| InventoryCollectEnabled | string | no | Specifies whether to enable the storage inventory |
| Location | string | yes | The OSS path to register |
| OssLogCollectEnabled | string | no | Specifies whether to enable OSS log collection |
| RoleName | string | yes | The Resource Access Management (RAM) role name. DLF requires an authorized role to read and write data in the specified OSS path. You can… |

### Renames a partition in a data lake table
`POST https://apizie.tech/v1/cloud:aliyun-datalake/rename-partition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| PartitionInput | object | no | The updated partition information. This is the same as the information for CreatePartition |
| PartitionValues | array | no | The partition values |
| TableName | string | no | The name of the data table |

### Updates the name of a data table in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/rename-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IsAsync | string | no | Specifies whether to update the table asynchronously. Valid values: false (default): The call is synchronous. The API operation waits for… |
| TableInput | object | no | The table object. Note: Only specify the TableName |
| TableName | string | no | The name of the data table |

### Revokes the operation permissions on resources granted to a user or a data lake role
`POST https://apizie.tech/v1/cloud:aliyun-datalake/revoke-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| Accesses | array | yes | The list of accesses to be revoked |
| CatalogId | string | no | The ID of the data catalog |
| DelegateAccesses | array | no | The list of grantable accesses to be revoked. This parameter is not supported |
| MetaResource | object | yes | The meta resource to be revoked |
| Principal | object | yes | Revokes the authorization for the user or role. The format is as follows: Resource Access Management (RAM) user:… |
| Type | string | yes | The type of revocation. Only Hive is supported |

### Revokes a DLF role from multiple users
`POST https://apizie.tech/v1/cloud:aliyun-datalake/revoke-role-from-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleName | string | no | The role to revoke from users |
| Users | array | no | The RAM identities to remove. The format is as follows: RAM user: acs:ram::[accountId]:user/[userName]. RAM role:… |

### Removes multiple roles from a single user
`POST https://apizie.tech/v1/cloud:aliyun-datalake/revoke-roles-from-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleNames | array | yes | The RAM roles to be revoked from the RAM user |
| User | object | yes | The RAM user from whom you want to revoke roles. Format: RAM roles: acs:ram::[accountId]:role/[roleName]. RAM user:… |

### Runs a migration workflow
`POST https://apizie.tech/v1/cloud:aliyun-datalake/run-migration-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the migration workflow instance |

### Retrieves metadata
`POST https://apizie.tech/v1/cloud:aliyun-datalake/search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The catalog ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| SearchText | string | no | The search query |
| SearchType | string | no | The object type |
| SortCriteria | array | no | The sorting criteria |

### Searches for databases, tables, and columns across catalogs
`POST https://apizie.tech/v1/cloud:aliyun-datalake/search-across-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogIds | array | no | The catalog IDs. If this parameter is not specified, all catalogs are searched |
| PageNumber | integer | no | The page number to return |
| PageSize | integer | no | The number of entries to return per page |
| SearchText | string | no | The search query |
| SearchTypes | array | no | The search types. Valid values: ALL, CATALOG, DATABASE, and TABLE |
| SortCriteria | array | no | The sorting criteria |

### Stops a metadata migration task
`POST https://apizie.tech/v1/cloud:aliyun-datalake/stop-migration-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the migration task instance |

### Submits an SQL query
`POST https://apizie.tech/v1/cloud:aliyun-datalake/submit-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| catalogId | string | no | The data catalog ID |
| sql | string | no | The SQL statement |
| workspaceId | string | no | The workspace ID |

### Releases the specified metadata lock
`POST https://apizie.tech/v1/cloud:aliyun-datalake/un-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| LockId | integer | no | The lock ID |

### Updates a catalog
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogInput | object | yes | The details of the catalog to update |

### Updates the configuration of a catalog. This operation requires the admin role or a higher role
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-catalog-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the catalog |
| CatalogSettings | object | no | The catalog settings |

### Updates the details of a database in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseInput | object | no | The new database |
| Name | string | no | The original name of the database. If the name is not changed, only other metadata is updated |

### Updates a user-defined function in a database of a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| FunctionInput | object | no | The details of the function to update |
| FunctionName | string | no | The name of the function |

### Creates or updates the column statistics for a data table partition
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-partition-column-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The namespace of the database category. By default, the Uid of the primary account is entered |
| ColumnStatisticsList | array | no | The list of field statistics |
| DatabaseName | string | no | The name of the metadatabase |
| Engine | string | no | Engine |
| IsStatsCompliant | string | no | IsStatsCompliant |
| TableName | string | no | The name of the metadata table |
| ValidWriteIdList | string | no | This parameter is not supported and can be left empty |
| WriteId | string | no | This parameter is not supported and can be left empty |

### Updates the permissions of a user or data lake role
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| Accesses | array | yes | The list of access permissions to be granted |
| CatalogId | string | no | The ID of the data catalog |
| DelegateAccesses | array | yes | The list of grantable access permissions. This parameter is not supported |
| MetaResource | object | yes | The metadata resource to which permissions are granted |
| Principal | object | yes | The user or role to which authorization is granted. The format is as follows: Resource Access Management (RAM) user:… |
| Type | string | yes | The type of authorization. Only Hive is supported |

### Updates a registered location
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-registered-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| InventoryCollectEnabled | string | no | Specifies whether to enable OSS inventory |
| LocationId | string | yes | The location ID. Call the RegisterLocation operation to obtain the location ID |
| OssLogCollectEnabled | string | no | Specifies whether to enable OSS logging |

### Updates a role that has the data lake permissions
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleInput | object | no | The input information of the updated role |
| RoleName | string | no | The role name |

### Updates users for a DLF role
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-role-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| RoleName | string | no | The name of the role |
| Users | array | no | The users. The format is as follows: RAM user: acs:ram::[accountId]:user/[userName]. RAM role: acs:ram::[accountId]:role/[roleName] |

### Updates the information of a data table in a data lake
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| AllowPartitionKeyChange | string | no | Specifies whether to allow updates to the partition key |
| CatalogId | string | no | The ID of the data catalog |
| DatabaseName | string | no | The name of the database |
| IsAsync | string | no | Specifies whether to perform an asynchronous update |
| SkipArchive | string | no | By default, updating a data table creates a new archived version. If you set SkipArchive to true, no new version is created |
| TableInput | object | no | The detailed information of the data table after the update |
| TableName | string | no | The name of the data table |

### Creates or updates the column statistics for a data table
`POST https://apizie.tech/v1/cloud:aliyun-datalake/update-table-column-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |
| CatalogId | string | no | The namespace of the database category. By default, the Uid of the primary account is entered |
| ColumnStatisticsList | array | no | The list of field statistics |
| DatabaseName | string | no | The name of the metadatabase |
| Engine | string | no | Engine |
| IsStatsCompliant | string | no | IsStatsCompliant |
| TableName | string | no | The name of the metadata table |
| ValidWriteIdList | string | no | This parameter is not supported and can be left empty |
| WriteId | string | no | This parameter is not supported and can be left empty |

### version
`POST https://apizie.tech/v1/cloud:aliyun-datalake/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlf.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-datalake/abort-lock" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Data Lake Formation API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-datalake/abort-lock with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Data Lake Formation API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Data Lake Formation itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Data Lake Formation API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-datalake.

### What is the status of the Alibaba Cloud Data Lake Formation API?
Needs your own provider key (bring your own key)