# Alibaba Cloud Dataphin API

> Alibaba Cloud Dataphin API on Apizie: 377 endpoints (Adds a regular member to a data service application. Only the application owner can perform this operation.…, Adds users to a data service project and assigns roles to them, Adds members to a project, Registers data lineage. Available since version v5.4.0, …) 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-dataphin-public/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Dataphin (dataphin-public, version 2023-06-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a regular member to a data service application. Only the application owner can perform this operation.…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-data-service-app-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AddCommand | string | yes | The command to add a regular member to a data service application (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Adds users to a data service project and assigns roles to them
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-data-service-project-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The data service project ID |
| AddCommand | string | yes | The command to add project members (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Adds members to a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-project-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The project ID |
| AddCommand | string | yes | The command for adding members (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Registers data lineage. Available since version v5.4.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-register-lineage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AddRegisterLineageCommand | string | yes | The command for registering and adding data lineage (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Adds users to a tenant in batches. Only super administrators (SuperAdmin) and system administrators can…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-tenant-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AddCommand | string | yes | The request command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Adds tenant members by using source users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-tenant-members-by-source-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AddCommand | string | no | The add request (JSON-encoded) |

### Adds members to a user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-user-group-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AddCommand | string | no | The command to add user group members (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Applies for API permissions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/apply-data-service-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The data service project ID |
| ApplyCommand | string | yes | The apply command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Applies for application permissions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/apply-data-service-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The data service project ID |
| ApplyCommand | string | yes | The apply command (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Binds specified quality rules to schedule settings. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/assign-quality-rule-of-all-rule-scope-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AssignCommand | string | yes | The assignment binding command (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Creates knowledge graph entity records in batches. Available since version v6.1.1
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/batch-create-kg-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The workspace ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Creates knowledge graph relationship records in batches. Online version: v6.1.1
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/batch-create-kg-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The workspace ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Transfers assets in batches. Released in version 6.3.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/batch-handover-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The operator user ID |
| HandoverCommand | string | yes | The batch transfer command (JSON-encoded) |

### Checks the connectivity of a compute source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/check-compute-source-connectivity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CheckCommand | string | yes | The check command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Checks the connectivity of an existing compute source by compute source ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/check-compute-source-connectivity-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The compute source ID |
| OpUserId | string | no | The ID of the operator user |

### Checks the connectivity of a data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/check-data-source-connectivity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CheckCommand | string | yes | The object to check (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Checks the connectivity of a data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/check-data-source-connectivity-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The data source ID |
| OpUserId | string | no | The ID of the operator user |

### Checks the connectivity of a data source on a specified schedule resource group. Available since version 6.3.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/check-data-source-connectivity-on-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CheckCommand | string | yes | The check object (JSON-encoded) |
| OpUserId | string | no | The ID of the operator |

### Checks whether a project has data dependencies such as tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/check-project-has-dependency` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| Id | integer | yes | Project ID |
| OpUserId | string | no | 操作用户ID |

### Checks whether a user has the permission on a specified resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/check-resource-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| CheckCommand | string | yes | Check user resource permission (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates an ad hoc query file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-ad-hoc-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The request for creating an ad hoc query file (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a Basic (single-environment) project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-basic-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a batch task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-batch-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator |
| CreateCommand | string | yes | The create command (JSON-encoded) |

### Creates a business entity
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-biz-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a business metric. Release version: v5.5.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-biz-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateBizMetricCommand | string | yes | The create request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a data domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-biz-unit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a cluster. Online since version v6.3.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-compute-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator user |
| ClusterConfig | string | yes | The cluster configuration (JSON-encoded) |

### Creates a compute source. Business unit administrators and project administrators have permissions to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-compute-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator |
| CreateCommand | string | yes | The create command (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create request (JSON-encoded) |
| OpUserId | string | no | The ID of the operator |

### Creates a data service API and submits it
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-data-service-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The request for creating an API (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a data service application. Only super administrators or system administration administrators can…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-data-service-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The command to create a data service application (JSON-encoded) |
| OpUserId | string | no | The ID of the operator |

### Creates a data service application group. Only super administrators and system administrators can perform…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-data-service-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| GroupName | string | yes | The group name |
| OpUserId | string | no | The ID of the operator |

### Create Data Source: Tenant administrators, data administrators, business unit administrators, project…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| CreateCommand | string | no | Request object (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a new dataset in the specified project. Available since v6.2.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | string | yes | The project ID |
| CreateCommand | string | yes | The creation request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a Dev-Prod (dual-environment) project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-dev-prod-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a menu tree directory. This operation supports features such as compute nodes, data integration, and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a knowledge graph entity record. Online version: v6.1.1
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-kg-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The workspace ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a knowledge graph relationship record. Online version: v6.1.1
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-kg-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The workspace ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### General-purpose data backfill operation that supports both list mode and batch mode data backfill: Generates…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-node-supplement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator user |
| CreateCommand | string | yes | The data backfill request (JSON-encoded) |
| Env | string | no | The environment identifier. Valid values: DEV: Development environment. PROD (default): Production environment |

### Creates an integration pipeline or unstructured workflow node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator user |
| Context | string | yes | The request context information (JSON-encoded) |
| CreateCommand | string | yes | The configuration for creating a pipeline or workflow node (JSON-encoded) |

### Asynchronously create a pipeline/unstructured workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-pipeline-by-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| Context | string | yes | Request context information (JSON-encoded) |
| CreateCommand | string | yes | Create pipeline/workflow task configuration (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a data integration task. Note: This operation is deprecated starting from Dataphin v5.3.1. Use…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-pipeline-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreatePipelineNodeCommand | string | yes | The command to create a pipeline. Both offline and real-time pipelines are supported (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a resource file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a row-level permission
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-row-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateRowPermissionCommand | string | yes | The request command (JSON-encoded) |
| OpUserId | string | no | The ID of the operator |

### Creates a data category. Available since v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-security-classify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create instruction (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Creates a data classification folder. Available since v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-security-classify-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a security identification result. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-security-identify-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a data classification level. Available since v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-security-level` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Creates a standard. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-standard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a data standard lookup table. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-standard-lookup-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates standard mapping relationships, including valid mappings and invalid mappings. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-standard-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a standard association relationship. Online version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-standard-relations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a standard set. Available since: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-standard-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Create a data standard template. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-standard-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| CreateCommand | string | yes | Create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a data standard root word. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-standard-word-root` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a stream-batch integrated node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-stream-batch-job-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| StreamBatchJobMappingCreateCommand | string | yes | The stream-batch integrated node information (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a user-defined function
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-udf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | yes | The create command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates a user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| CreateCommand | string | no | The creation request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Creates an unstructured workflow node using JSON script mode. Online since v6.2.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/create-work-flow-by-json` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator user |
| Context | string | yes | The request context information (JSON-encoded) |
| CreateCommand | string | yes | The JSON script command for creating a workflow (JSON-encoded) |

### Deletes an ad hoc query file from the menu tree
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-ad-hoc-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project ID |
| FileId | integer | yes | The file ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a batch task. If the node has not been offlined, you must offline it before deleting it
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-batch-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a business entity
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-biz-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| BizUnitId | integer | yes | The ID of the business unit to which the entity belongs |
| Type | string | yes | The type of the business entity. For more information, refer to the create business entity operation |
| Id | integer | yes | The ID of the business entity |
| OpUserId | string | no | 操作用户ID |

### Deletes a business metric. Release version: v5.5.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-biz-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteBizMetricCommand | string | yes | The delete request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a data domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-biz-unit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The business domain ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a cluster. Online version: v6.3.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-compute-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator user |
| Id | integer | yes | The cluster ID |

### Deletes a compute source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-compute-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The compute source ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a subject domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-data-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| BizUnitId | integer | yes | The business unit ID |
| Id | integer | yes | The subject domain ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a data service application. Only superusers, system administrators, or application owners can…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-data-service-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AppId | integer | yes | The application ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a data service application group. Only superusers and system administrators can perform this…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-data-service-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| GroupId | integer | yes | The group ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The request for deleting a data source (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a dataset. Release version: v6.2.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The dataset ID |
| ProjectId | integer | yes | The project ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a file directory from the menu tree
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project ID |
| FileId | integer | yes | The file ID |
| OpUserId | string | no | 操作用户ID |

### Deletes an entity record. Online version: v6.1.1
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-kg-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The workspace ID |
| EntityType | string | yes | The entity type code |
| EntityId | string | yes | The entity record ID |
| OpUserId | string | no | 操作用户ID |

### Deletes a relationship record. Online version: v6.1.1
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-kg-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The workspace ID |
| RelationType | string | yes | The relationship type code |
| RelationId | string | yes | The relationship record ID |
| OpUserId | string | no | The ID of the operator user |

### Deletes a project (applicable to both Basic and Dev-Prod projects)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The project ID |
| OpUserId | string | no | 操作用户ID |

### Deletes quality rule objects in batches. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-quality-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes quality scheduling objects in batches. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-quality-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes quality template objects in batches. Online version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-quality-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes monitored objects in batches. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-quality-watches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes registered data lineage. Available since v5.4.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-register-lineage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteRegisterLineageCommand | string | yes | The command for deleting registered data lineage (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Delete a resource file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| ProjectId | integer | yes | Project ID |
| Id | integer | yes | Resource file ID |
| Comment | string | yes | Remarks |
| OpUserId | string | no | 操作用户ID |

### Deletes a row-level permission
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-row-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteRowPermissionCommand | string | yes | The request command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a data categorization. Available since v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-security-classify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a data classification catalog. Available since v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-security-classify-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes security identification results in batches. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-security-identify-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a data classification level. Available since v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-security-level` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a standard. Online version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-standard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes invalid mapping relationships. Online version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-standard-in-valid-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a data standard lookup table. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-standard-lookup-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The lookup table ID |
| OpUserId | string | no | 操作用户ID |

### Deletes standard associations in batches. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-standard-relations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a standard set. Online version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-standard-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The standard set ID |
| OpUserId | string | no | 操作用户ID |

### Deletes valid mapping relationships. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-standard-valid-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| DeleteCommand | string | yes | The delete instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Deletes a data standard root word. Online version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-standard-word-root` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Name | string | yes | The name of the root word |
| OpUserId | string | no | 操作用户ID |

### Deletes a user-defined function
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-udf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project ID |
| Id | integer | yes | The ID of the user-defined function |
| Comment | string | yes | The comment |
| OpUserId | string | no | 操作用户ID |

### Deletes a user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/delete-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| UserGroupId | string | yes | The user group ID |
| OpUserId | string | no | 操作用户ID |

### Executes a custom Cypher query. Online version: v6.2.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/exec-kg-cypher` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The model ID |
| ExecCommand | string | yes | The custom Cypher query instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Executes a custom Cypher query. Available since v6.3.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/exec-kg-gremlin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| OpUserId | string | no | The ID of the operator user |
| WorkspaceId | string | yes | The model ID |
| ExecCommand | string | yes | The custom Cypher query command (JSON-encoded) |

### Executes an ad hoc query task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/execute-ad-hoc-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ExecuteCommand | string | yes | The execution command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Executes a DDL statement: creates a table on a data source based on the specified data source identifier and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/execute-ddl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Context | string | yes | The request context information (JSON-encoded) |
| DDLCommand | string | yes | The one-click table creation parameters (JSON-encoded) |

### Runs a manually scheduled node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/execute-manual-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ExecuteCommand | string | yes | The request for running a manual task (JSON-encoded) |
| Env | string | no | The environment identifier. Valid values: DEV: development environment PROD (default): production environment |
| OpUserId | string | no | 操作用户ID |

### Runs a trigger-based node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/execute-trigger-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| NodeId | string | yes | The node ID |
| BizDate | string | yes | The business date |
| ProjectId | integer | yes | The project ID |
| Index | integer | no | If the node is an hourly or minutely node, multiple instances are generated per day. This parameter specifies the ordinal number of the… |
| Env | string | no | The environment. Valid values: DEV: development environment. PROD: production environment. Default value: PROD |
| OpUserId | string | no | 操作用户ID |

### Exports knowledge graph metadata definitions. Online version: v6.1.1
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/export-kg-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| WorkspaceId | string | yes | The workspace ID |
| OutputFormat | string | no | The format of the exported content. Valid values: json and yaml. Default value: yaml |
| VersionId | integer | no | The version number. If this parameter is empty or set to -1, the model metadata in draft state is returned. If this parameter is set to 0,… |
| OpUserId | string | no | 操作用户ID |

### Reruns downstream nodes to fix data link issues. Supports forced rerun of downstream nodes. Impact: incurs…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/fix-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| FixDataCommand | string | yes | The command to rerun downstream nodes to fix data link issues. You can choose to force a rerun (JSON-encoded) |
| Env | string | no | The environment identifier. Valid values: DEV: development environment. PROD (default): production environment |
| OpUserId | string | no | 操作用户ID |

### Retrieves all authorized accounts under a specific row-level permission by row-level permission ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-account-by-row-permission-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| GetAccountByRowPermissionIdQuery | string | yes | The request command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Queries a custom query file in the directory tree
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-ad-hoc-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project ID |
| FileId | integer | yes | The file ID |
| OpUserId | string | no | 操作用户ID |

### Retrieves the runtime logs of an ad hoc query task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-ad-hoc-task-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project ID |
| TaskId | string | yes | The task ID |
| SubTaskId | integer | yes | The subtask ID. The value starts from 0 |
| Offset | integer | yes | The offset for querying logs. Increment the value based on the returned result. Set the initial value to 0 |
| OpUserId | string | no | 操作用户ID |

### Retrieves the task execution result of an ad hoc query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-ad-hoc-task-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project ID |
| TaskId | string | yes | The task ID |
| SubTaskId | integer | yes | The subtask ID |
| OpUserId | string | no | 操作用户ID |

### Retrieves the details of an alert event
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-alert-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Id | integer | yes | The alert event ID |
| OpUserId | string | no | 操作用户ID |

### Queries asset property values. Online version: v6.3.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-asset-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| QueryCommand | string | yes | The query instruction (JSON-encoded) |
| OpUserId | string | no | The ID of the operator user |

### Queries mapping relationships by asset object GUID. Available since: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-asset-mapping-relations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AssetMappingQuery | string | no | The query instruction (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Queries asset property definitions. Online version: v6.3.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-asset-type-attribute-codes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| AssetType | string | no | The asset type filter. Valid values: TABLE: table. COLUMN: column. INDEX: metric. BIZ_INDEX: business metric. API: API. PAGE: dashboard |
| OpUserId | string | no | The ID of the operator |

### Retrieves the details of an offline computing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-batch-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project to which the task belongs |
| FileId | integer | yes | The node ID in the task directory tree |
| Env | string | no | The environment identifier. Valid values: dev and prod. Default value: dev |
| IncludeAllUpStreams | string | no | Specifies whether to include all upstream nodes, including invalid dependencies. Default value: false |
| OpUserId | string | no | The ID of the operator |

### Retrieves the details of a specified version of an offline computing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-batch-task-info-by-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project to which the task belongs |
| FileId | integer | yes | The node ID of the task directory tree |
| VersionId | integer | yes | The version number |
| OpUserId | string | no | The operator user ID |

### Obtains the custom lineage of an offline task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-batch-task-udf-lineages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| ProjectId | integer | yes | The project to which the task belongs |
| FileId | integer | yes | The node ID of the task directory tree |
| OpUserId | string | no | 操作用户ID |

### Retrieves the version list of a batch task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-batch-task-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The ID of the project to which the node belongs |
| FileId | integer | yes | The node ID in the node directory tree |
| OpUserId | string | no | 操作用户ID |

### Retrieves the version list of a specified offline template ID. Online version: v6.2.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-batch-template-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| ProjectId | integer | yes | The project ID |
| TemplateId | integer | yes | The template ID |
| Env | string | no | The environment. Valid values: DEV: development environment. PROD: production environment. Default value for dev_prod projects: DEV |
| OpUserId | string | no | 操作用户ID |

### Query mapping relationships by belonging asset GUID. Release version: v5.4.2
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-belong-asset-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| AssetMappingQuery | string | no | Query command (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

### Retrieves the details of a business entity
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-biz-entity-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Type | string | yes | The business entity type. For more information, refer to the create business entity operation |
| Id | integer | yes | The business entity ID |
| OpUserId | string | no | 操作用户ID |

### Queries the details of a business entity of a specified version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-biz-entity-info-by-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | The tenant ID |
| Type | string | yes | The business type. Valid values: BIZ_OBJECT and BIZ_PROCESS |
| Id | integer | yes | The business entity ID |
| VersionId | integer | yes | The version |
| OpUserId | string | no | 操作用户ID |

### Query business metric details by name. Release version: v5.5.0
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/get-biz-metric-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dataphin-public.cn-hangzhou.aliyuncs.com |
| OpTenantId | integer | yes | Tenant ID |
| BizMetricByNameQuery | string | yes | Query request (JSON-encoded) |
| OpUserId | string | no | 操作用户ID |

…and 257 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-data-service-app-member" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Dataphin API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dataphin-public/add-data-service-app-member with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Dataphin 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-dataphin-public.

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