# Alibaba Cloud Data Lake Formation API

> Alibaba Cloud Data Lake Formation API on Apizie: 82 endpoints (Updates a catalog, Updates a database, Updates a sink, Updates a share, …) 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://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dlfnext`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dlfnext
- Page: https://zieapi.vercel.app/api/cloud/aliyun-dlfnext
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-dlfnext/openapi.json

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

## Endpoints

### Updates a catalog
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalog | string | yes | The name of the catalog |
| removals | array | no | The items to delete |
| updates | object | no | The items to update |

### Updates a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the catalog |
| database | string | yes | The name of the database |
| removals | array | no | The items to delete |
| updates | object | no | The items to update |

### Updates a sink
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-receiver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| receiver | string | yes | The name of the sink |
| comment | string | no | The comment |
| receiverName | string | no | The name of the sink |

### Updates a share
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| share | string | yes | The name of the share |
| comment | string | no | The comment for the share |
| enableWrite | string | no | Specifies whether to enable the write permission for the share |
| shareName | string | no | The name of the share |

### Updates the receivers of a share
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-share-receivers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| share | string | yes | The share name |
| addedReceivers | array | no | The receivers to add |
| removedReceivers | array | no | The receivers to remove |

### Modifies shared resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-share-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | no | The ID of the catalog |
| shareResourceList | array | no | The shared resources |
| share | string | yes | The share name |

### Updates a table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the catalog |
| database | string | yes | The name of the database |
| table | string | yes | The name of the table |
| changes | array | no | The changes made to the table |

### Changes the table schema
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-table-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the data catalog |
| database | string | yes | The name of the database |
| table | string | yes | The name of the table |
| schema | object | no | The table schema |

### Grants permissions in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/batch-grant-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| permissions | array | no | The list of permissions |

### Revokes permissions in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/batch-revoke-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| permissions | array | no | The list of permissions to be revoked |

### Creates a data catalog
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/create-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| isShared | string | no | Specifies whether the catalog is a shared data catalog |
| name | string | no | The name of the data catalog |
| options | object | no | The configuration parameter struct |
| shareId | string | no | The share ID |
| type | string | no | The type of the data catalog |

### Creates a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/create-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the catalog |
| name | string | no | The name of the database |
| options | object | no | The configuration options |

### Creates a receiver
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/create-receiver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| comment | string | no | The comment |
| receiverName | string | no | The name of the receiver |
| receiverTenantId | integer | no | The ID of the receiver's account |

### Creates a DLF role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/create-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| description | string | no | The role description |
| displayName | string | no | The role display name |
| roleName | string | no | The role name |

### Creates a share
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/create-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| comment | string | no | The comment for the share |
| enableWrite | string | no | Specifies whether to enable write permissions for the share |
| shareName | string | yes | The share name |

### Creates a table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/create-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the catalog |
| database | string | yes | The name of the database |
| identifier | object | no | The table identifier |
| schema | object | no | The table schema |

### Deletes a DLF role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/delete-role` (byok)

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

### Retrieves the regions where DLF is activated
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/describe-regions` (byok)

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

### Deletes a DLF catalog. The deletion fails unless the following conditions are met: all tables and databases…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/drop-catalog` (byok)

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

### Drops a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/drop-database` (byok)

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

### Removes a receiver
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/drop-receiver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| receiver | string | yes | The name of the receiver to remove |

### Deletes a share
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/drop-share` (byok)

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

### Drops a table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/drop-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the catalog |
| database | string | yes | The name of the database |
| table | string | yes | The name of the table to drop |

### Retrieves the details of a catalog
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-catalog` (byok)

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

### Retrieves the details of a catalog
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-catalog-by-id` (byok)

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

### Retrieves the DLF data access role ARN and KMS key policy authorization statement required to configure BYOK…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-catalog-kms-grants` (byok)

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

### Retrieves the storage overview of a data catalog
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-catalog-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| date | string | no | The date of the storage overview, in the YYYY-MM-DD format |

### Retrieves the storage overview trends of the data catalog
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-catalog-summary-trend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the data catalog |
| startDate | string | yes | The start date in the yyyy-MM-dd format. The result includes the start date |
| endDate | string | yes | The end date in the yyyy-MM-dd format. The result includes the end date |

### Obtains a temporary access credential (token) for a catalog
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-catalog-token` (byok)

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

### Retrieves the details of a specific database in a data lake
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-database` (byok)

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

### Retrieves the database storage overview
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-database-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| database | string | yes | The database name |
| date | string | no | The date of the storage overview, in the YYYY-MM-DD format |

### Queries an Iceberg database
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-iceberg-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| namespace | string | yes | The namespace name |

### Retrieves the details of a table
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-iceberg-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The catalog ID |
| namespace | string | yes | The name of the namespace |
| table | string | yes | The table name |

### Retrieves a query
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-query` (byok)

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

### Retrieves a receiver
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-receiver` (byok)

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

### Queries the DLF activation status of in a region
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-region-status` (byok)

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

### Retrieves a role
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| rolePrincipal | string | no | The resource descriptor of the role |

### Retrieves the details of a share
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| share | string | yes | The share name |

### Retrieves the details of a table in a data lake
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-table` (byok)

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

### Retrieves the compaction details of a table
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-table-compaction` (byok)

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

### Queries a table snapshot
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-table-snapshot` (byok)

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

### Retrieves the table storage overview
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-table-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| database | string | yes | The database name |
| table | string | yes | The table name |
| date | string | no | The date of the storage overview, in the YYYY-MM-DD format |

### Obtains a temporary access credential for a data lake table
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-table-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| isInternal | string | no | Specifies whether the access is from a VPC |
| catalogId | string | yes | The catalog ID |
| database | string | yes | The database name |
| table | string | yes | The table name |

### Retrieves a user
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| userPrincipal | string | no | The resource descriptor of the user |

### Obtain the VPC configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/get-vpc-config` (byok)

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

### Grants a role to one or more users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/grant-role-to-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| rolePrincipal | string | no | The resource descriptor for a role |
| userPrincipals | array | no | The resource descriptors for users |

### Queries the list of catalogs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-catalogs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| maxResults | integer | no | The maximum number of records to retrieve at a time |
| pageToken | string | no | The pagination token used to retrieve the next page of results. If the response does not include a token, pass an empty string ("") or an… |
| catalogNamePattern | string | no | The catalog name pattern |

### Queries the list of databases in the data lake by using a paged query with paging
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-database-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| maxResults | integer | no | The page size. Default value: 1000 Maximum value: 1000 |
| pageToken | string | no | The pagination token used to retrieve the next page of results. If no token is provided in the response, pass an empty string ("") or an… |
| databaseNamePattern | string | no | The SQL-style right fuzzy match pattern for database names. The percent sign (%) is supported |
| status | string | no | The filter for the database deletion status. active indicates a normal database, and retained indicates a soft-deleted database that is… |

### Retrieves databases
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the catalog |
| maxResults | integer | no | The maximum number of records to return in a single request |
| pageToken | string | no | The token for the next page of results. If the response does not provide a token, pass an empty string ("") |
| databaseNamePattern | string | no | The database name pattern for fuzzy matching |

### Lists functions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-functions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the data catalog |
| database | string | yes | The name of the database |
| maxResults | integer | no | The maximum number of records to return in the response |
| pageToken | string | no | A pagination token. Use this token to retrieve the next page of results. Pass an empty string ("") if this parameter is not returned in… |
| functionNamePattern | string | no | A pattern to filter function names |

### Lists Iceberg namespaces
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-iceberg-namespace-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the catalog |
| maxResults | integer | no | The number of entries to return on each page. Default value: 1000. Maximum value: 1000 |
| pageToken | string | no | The token for the next page of results. If the response does not include this token, pass an empty string ("") |
| namespaceNamePattern | string | no | The namespace name pattern. Supports right-hand fuzzy matching with the percent sign (%) |

### Lists the snapshots of an Iceberg table
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-iceberg-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The catalog ID |
| namespace | string | yes | The namespace name |
| table | string | yes | The table name |
| maxResults | integer | no | The maximum number of records to return in a single request |
| pageToken | string | no | The pagination token used to retrieve the next page of results. If the response does not return this token, pass an empty string ("") |

### Lists the details of Iceberg tables
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-iceberg-table-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The catalog ID |
| namespace | string | yes | The namespace |
| tableNamePattern | string | no | The pattern to filter table names |
| maxResults | integer | no | The maximum number of records to return in a single request |
| pageToken | string | no | The token to retrieve the next page of results. If this parameter is not returned in the response, pass an empty string ("") |

### Retrieves the partition storage overview list
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-partition-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| database | string | yes | The database name |
| table | string | yes | The table name |
| maxResults | integer | no | The number of entries per page |
| pageToken | string | no | The pagination token used to retrieve the next page of data. If it is not provided in the response, pass an empty string ("") or an empty… |
| partitionNamePattern | string | no | The partition name pattern |

### Lists the partitions of a data table
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-partitions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the data catalog |
| database | string | yes | The name of the database |
| table | string | yes | The name of the data table |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| pageToken | string | no | The pagination token used to retrieve the next page of data. If the response does not include this token, pass an empty string ("") or an… |
| partitionNamePattern | string | no | The partition name pattern |

### Retrieves a list of partitions by their names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-partitions-by-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| database | string | yes | The database name |
| table | string | yes | The table name |
| specs | array | no | The list of partition specifications |

### Retrieves the permission information of a specified resource or a specified principal
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The data catalog ID |
| resourceType | string | yes | The permission resource type |
| database | string | no | The database name |
| table | string | no | The data table name |
| function | string | no | The function name |
| view | string | no | The view name |
| principal | string | no | The user resource descriptor |
| pageToken | string | no | The pagination token used to retrieve the next page of data. If the response does not include this token, pass an empty string ("") or an… |
| maxResults | integer | no | The number of entries per page |

### Retrieves shares
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-provided-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| pageToken | string | no | The pagination token. Use this token to retrieve the next page of results. If this parameter is not returned, pass an empty string ("") |
| maxResults | integer | no | The maximum number of records to return |

### Retrieves received shares
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-received-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| pageToken | string | no | The token to retrieve the next page of results. If the response does not include this token, pass an empty string ("") |
| maxResults | integer | no | The maximum number of records to return for this request |

### Queries a list of receivers
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-receivers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| receiverName | string | no | The name of the receiver |
| pageToken | string | no | The token to retrieve the next page of results. If the response does not include this token, pass an empty string ("") |
| maxResults | integer | no | The maximum number of records to return |

### Retrieves the users for a role
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-role-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| rolePrincipal | string | no | The resource descriptor for the DLF role |
| pageToken | string | no | The token to retrieve the next page of results. If the response does not return a token, pass an empty string ("") |
| maxResults | integer | no | The number of entries per page |

### Retrieves roles
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| roleName | string | no | The role name |
| pageToken | string | no | The token used to retrieve the next page of results. If the response does not return this parameter, pass an empty string ("") |
| maxResults | integer | no | The number of entries to return on each page |

### Gets the receivers of a share
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-share-receivers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| share | string | yes | The share name |
| pageToken | string | no | The token to retrieve the next page of results. If the response does not include this token, pass an empty string ("") |
| maxResults | integer | no | The maximum number of records to return |

### Retrieves shared resources
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-share-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| share | string | yes | The name of the share |
| pageToken | string | no | The token used to page through results. If this parameter is not returned, pass an empty string ("") |
| maxResults | integer | no | The maximum number of records to return |

### Returns a list of table snapshots
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The catalog ID |
| database | string | yes | The database name |
| table | string | yes | The table name |
| maxResults | integer | no | The maximum number of records to return on a single page |
| pageToken | string | no | The token that is used to retrieve the next page of results. If the response does not provide this token, pass an empty string ("") |

### Queries the details of tables
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-table-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the data catalog |
| database | string | yes | The database name |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| pageToken | string | no | The pagination token used to retrieve the next page of data. If the response does not provide this value, pass an empty string ("") or an… |
| tableNamePattern | string | no | The fuzzy match pattern for the table name |
| type | string | no | The type |
| status | string | no | The deletion status of the table. Valid values: retained: The table is deleted and temporarily stored in the recycle bin. active: The… |

### Retrieves a list of tables
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The catalog ID |
| database | string | yes | The database name |
| maxResults | integer | no | The maximum number of records to return |
| pageToken | string | no | The token to retrieve the next page of results. If the response does not include this parameter, pass an empty string ("") |
| tableNamePattern | string | no | The table name pattern |

### Retrieves the roles assigned to a user
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-user-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| userPrincipal | string | no | The resource descriptor for the user |
| pageToken | string | no | The pagination token used to retrieve the next page of data. If the response does not provide this token, pass an empty string ("") |
| maxResults | integer | no | The number of entries per page |

### Retrieves a list of users
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| userName | string | no | The user name |
| type | string | no | The type of the user |
| pageToken | string | no | The pagination token used to retrieve the next page of results. If this parameter is not returned in the response, pass an empty string ("") |
| maxResults | integer | no | The number of entries to return on each page |

### Lists the details of one or more views
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-view-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the data catalog |
| database | string | yes | The name of the database |
| maxResults | integer | no | The maximum number of records to return in a single request |
| pageToken | string | no | The token for the next page of results. If the response does not include this token, pass an empty string ("") |
| viewNamePattern | string | no | A pattern to filter view names |

### Returns the names of views
`GET https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/list-views` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The ID of the data catalog |
| database | string | yes | The name of the database |
| maxResults | integer | no | The maximum number of records to return |
| pageToken | string | no | The token to retrieve the next page of results. If the response does not include this token, pass an empty string ("") |
| viewNamePattern | string | no | The pattern used to filter view names |

### Syncs users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/refresh-user-sync` (byok)

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

### Revokes a role from one or more users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/revoke-role-from-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| rolePrincipal | string | no | The resource descriptor for the DLF role |
| userPrincipals | array | no | The resource descriptors for the users |

### Rolls back a table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/rollback-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalogId | string | yes | The catalog ID |
| database | string | yes | The database name |
| table | string | yes | The table name |
| instant | object | no | The details of the instance |

### Submits a query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/submit-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| defaultCatalog | string | no | The default catalog |
| defaultDatabase | string | no | The default database |
| limit | integer | no | The limit on the number of returned results |
| sql | string | no | The SQL text. Multiple statements separated by semicolons are supported and executed sequentially within the same session |
| tier | string | no | The execution specifications. Default value: standard |

### Subscribes to DLF in the current region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/subscribe` (byok)

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

### Deletes tags from resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| resourceType | string | yes | The resource type. Valid value: catalog |
| resourceId | string | yes | The list of resource IDs. You can specify up to 50 resource IDs (JSON-encoded) |
| tagKey | string | no | The list of tag keys. This parameter and the All parameter are mutually exclusive (JSON-encoded) |
| all | string | no | Specifies whether to delete all tags from the resources. This parameter and the TagKey parameter are mutually exclusive |

### Updates a DLF role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/update-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| description | string | no | The description of the role |
| displayName | string | no | The display name of the role |
| rolePrincipal | string | no | The resource descriptor of the role |

### Updates the users for a role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/update-role-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| rolePrincipal | string | no | The resource descriptor of the DLF role |
| userPrincipals | array | no | The resource descriptors of the users |

### Updates the trusted VPC configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/update-vpc-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| removals | array | no | The list of VPC IDs to delete |
| updates | array | no | The list of VPCs to update |

### Validates the BYOK SSE-KMS configuration of a Catalog: performs an SSE-KMS write probe on the storage bucket…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/verify-catalog-kms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dlfnext.ap-southeast-1.aliyuncs.com |
| catalog | string | yes | The name of the Catalog whose BYOK SSE-KMS configuration you want to validate |
| kmsKeyId | string | yes | The ID of the KMS customer master key (CMK) to be validated. The server uses this key to perform an SSE-KMS write probe |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/version` (byok)

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-catalog" \
  -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://zieapi.vercel.app/v1/cloud:aliyun-dlfnext/alter-catalog 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://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dlfnext.

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