# Alibaba Cloud DataWorks API

> Alibaba Cloud DataWorks API on Apizie: 382 endpoints (Stops a cross-workspace publish flow, Calls this operation to change the status of a specified deployment process to terminated. The deployment…, Adds a specified entity object to a Data Map collection. The collection object can be a Data Map category or…, Commits an access permissions request for specific resources, …) 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-dataworks-public/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for DataWorks (dataworks-public, version 2024-05-18). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Stops a cross-workspace publish flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/abolish-cross-project-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The workspace ID |
| PipelineRunId | string | yes | The ID of the cross-workspace publish flow |
| Reason | string | no | The reason for stopping the cross-workspace publish flow |

### Calls this operation to change the status of a specified deployment process to terminated. The deployment…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/abolish-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can logon to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Id | string | yes | The unique identifier of the deployment process |

### Adds a specified entity object to a Data Map collection. The collection object can be a Data Map category or…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/add-entity-into-meta-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| MetaCollectionId | string | yes | The ID of the collection object. You can obtain the ID from the response of the ListMetaCollections operation |
| Id | string | yes | The ID of the entity. Currently, only the table type is supported. You can obtain the ID from the response of the ListTables operation |
| Remark | string | no | The remarks when adding the entity to the collection. Currently, this parameter takes effect only for the album type |

### Commits an access permissions request for specific resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/apply-resource-access-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Reason | string | yes | The reason for the request |
| ApplyContents | string | yes | The list of resource permission request entries (JSON-encoded) |
| ClientToken | string | no | The idempotency token. Used to prevent duplicate operations caused by multiple calls |

### Approves or rejects a specified approval process instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/approve-process-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProcessInstanceId | string | yes | The flow instance ID. Both new and legacy Security Center approval orders are supported |
| ApprovalComment | string | yes | The approval comment |
| NewExpiration | integer | no | The modified authorization expiration time. The value is a millisecond-level timestamp |
| ApprovalAction | string | yes | The approval action. Valid values: Agree: approves the request. Deny: rejects the request |
| ClientToken | string | no | The idempotency token. We recommend that you use a UUID |

### Associates an image with a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/associate-project-to-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The image ID |
| ProjectId | integer | yes | The project ID |

### Associates a resource group with a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/associate-project-to-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | yes | The unique identifier of the resource group |
| ProjectId | integer | yes | The ID of the workspace to associate with the resource group |

### Creates metadata entities in batches. All entities in the same batch must be of the same type. Currently,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/batch-create-meta-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Entities | string | yes | The list of entities. A maximum of five entities are supported. All entities in the same batch must have the same entityType (JSON-encoded) |

### Deletes metadata entity objects in batches. Supports deleting custom entities and extension table type…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/batch-delete-meta-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Ids | string | yes | The list of entity IDs to delete. A maximum of 10 IDs are supported. All entities in the same batch must be of the same entityType… |

### Updates multiple nodes in batches by using incremental updates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/batch-update-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Tasks | string | no | The list of nodes (JSON-encoded) |
| Comment | string | no | The remarks |

### Builds an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/build-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The image ID |
| ResourceGroupId | string | yes | The unique identifier of the general-purpose resource group |
| ProcessId | string | no | The image build execution ID, which is used as an idempotence identifier |
| Cu | number | no | The number of compute units (CUs) used for the build |

### Interrupts the Agent call for a specified session, supporting interruption during streaming responses
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/cancel-agent-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Jsonrpc | string | no | The JSON-RPC version. Fixed value: 2.0 |
| Id | string | no | The ID passed in by the requester, returned as-is in the response |
| Params | string | no | The business parameters of the request (JSON-encoded) |

### Cancels an image test
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/cancel-image-test` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The image ID |
| ProcessId | string | no | The execution ID of the image test to cancel |

### Clones an existing data source to create a new one
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/clone-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the data source, which is the unique identifier of the data source. You can call the ListDataSources operation to query existing… |
| CloneDataSourceName | string | yes | The name of the target data source. The name can contain letters, digits, and underscores (_), and cannot start with a digit or an… |

### Creates an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the agent. The name must be unique within the current account |
| DisplayName | string | no | The display name of the agent |
| Description | string | no | The description of the agent |
| Model | string | no | The model configuration (JSON-encoded) |
| SystemPrompt | string | no | The system prompt |
| Tools | string | no | The list of tools (JSON-encoded) |
| Skills | string | no | The list of skills (JSON-encoded) |
| ExpertSuites | string | no | The published expert suites bound to the agent. For personal or enterprise suites, use SuiteId and optionally Version. For official… |
| CallableAgents | string | no | The list of sub-agents that can be called by this agent (JSON-encoded) |
| PublishImmediately | string | no | Specifies whether to publish the agent immediately after creation. A value of true publishes the created version. A value of false or… |
| Metadata | string | no | The extended metadata in key-value pairs (JSON-encoded) |
| Visibility | string | no | The visibility level. Valid values: `TENANT`: The agent is visible within the account. `PROJECT`: The agent is visible to specified… |
| VisibilityScope | string | no | The visibility scope. The corresponding fields are used based on the Visibility value (JSON-encoded) |

### Creates an agent session and returns the session ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-agent-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Jsonrpc | string | no | The JSON-RPC version. This value is always 2.0 |
| Id | string | no | The ID passed by the requester. The value is returned as is |
| Params | string | no | The business parameters (JSON-encoded) |

### Creates a custom monitoring alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the custom rule |
| Owner | string | yes | The Alibaba Cloud UID of the owner of the custom rule |
| Enabled | string | yes | Specifies whether the alert rule is enabled |
| TriggerCondition | string | yes | The condition that triggers the alert (JSON-encoded) |
| Notification | string | no | The alert notification configuration (JSON-encoded) |

### Creates a business process in Data Studio for data development
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-business` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| ProjectIdentifier | string | no | The unique identifier of the DataWorks workspace, which is the English identifier displayed in the workspace switcher at the top of the… |
| BusinessName | string | yes | The name of the business process. The name must be unique within the same workspace |
| Description | string | no | The description of the business process |
| Owner | string | no | The Alibaba Cloud account ID of the owner of the business process. You can log on to the DataWorks console… |
| UseType | string | no | The functional module to which the business process belongs. Valid values: NORMAL: Data Studio. MANUAL_BIZ: Manual business process |

### Creates a scheduling calendar
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the scheduling calendar. The name must be unique within the current tenant and can be up to 100 characters in length |
| AllProjects | string | no | Specifies whether the calendar applies to all workspaces. Default value: false. true: all workspaces. false: the workspaces specified by… |
| ProjectIds | string | no | The list of applicable workspace IDs. If AllProjects is set to false or left empty: This parameter is required and cannot be empty. If… |
| Type | string | yes | The type of the calendar. StrongConstraint: strong constraint calendar. WeakConstraint: weak constraint calendar |
| StartDate | string | no | The start date of the calendar validity period. Format: `yyyy-mm-dd`. This parameter is required when Type is set to StrongConstraint |
| EndDate | string | no | The end date of the calendar validity period. Format: `yyyy-mm-dd`. This parameter is required when Type is set to StrongConstraint. The… |
| ExpirationReminder | string | no | The expiration reminder. This parameter is required when Type is set to StrongConstraint. OneMonthBefore: one month in advance.… |
| OverduePolicy | string | no | The scheduling policy after the calendar expires. This parameter is required when Type is set to StrongConstraint. Normal: normal… |
| SchedulePolicy | string | yes | The date scheduling policy. For a strong constraint calendar, the normal scheduling dates and non-scheduling dates must cover every day… |
| FallbackPolicy | string | no | The default scheduling policy for dates that are not configured. This parameter is required when Type is set to WeakConstraint. Normal:… |
| Owner | string | yes | The account ID of the owner |
| Description | string | yes | The description of the scheduling calendar. The description must be 5 to 2,048 characters in length |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace where the data source resides. You can call the https://help.aliyun.com/document_detail/2780068.html… |
| Spec | string | yes | The FlowSpec information that describes the workflow. For more information about the specifications, see FlowSpec… |
| ClientToken | string | no | The reserved field |

### Creates a compute resource in a specified workspace. The compute resource can be used in the development or…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-compute-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The DataWorks workspace ID |
| Name | string | yes | The name of the compute resource. The name can contain letters, digits, and underscores (_), and cannot start with a digit or an… |
| Type | string | yes | The type of the compute resource. Multiple compute resource types are supported |
| ConnectionPropertiesMode | string | yes | The mode in which the compute resource is added. Different types have different subtypes and corresponding parameter constraints. For… |
| Description | string | no | The description of the compute resource. The description can be up to 3,000 characters in length |
| ConnectionProperties | string | yes | The specific connection configuration information of the compute resource, including the endpoint, access identity, and environment… |

### Creates a metadata crawler and configures the data source, collection scope, resource group, and scheduling…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-crawler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the metadata crawler. The name can be up to 128 characters in length |
| DataSourceId | integer | yes | The ID of the data source associated with the crawler. The data source must be bound to a DataWorks workspace, and the data source type… |
| Type | string | yes | The crawler type. Call GetCrawlerTypeCapabilities to query the valid values supported in the current region |
| ResourceGroupId | string | no | The ID of the Serverless 2.0 resource group used to run the collection task. Whether this parameter is required depends on the… |
| Scope | string | no | The collection scope configuration. If this parameter is not specified, the DefaultScopeUnit value returned by GetCrawlerTypeCapabilities… |
| ScheduleConfig | string | no | The scheduling configuration. If this parameter is not specified, manual scheduling is used (JSON-encoded) |
| EnableAiComment | string | no | Specifies whether to enable AI metadata descriptions. This parameter is supported only when the SupportAiComment value returned by… |
| Options | string | no | The extended configuration for the crawler type. The key names, value types, required fields, default values, and valid values are… |

### Creates a cross-workspace deployment flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-cross-project-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The workspace ID |
| DeploymentEnvironmentId | integer | yes | The cross-workspace deployment environment ID |
| Type | string | yes | The deployment type. Valid values: Offline: Deployment to take the object offline. Online: Deployment to bring the object online |
| ObjectIds | string | yes | The list of top-level object IDs from the source project to deploy. The list must contain exactly one object. Child objects of composite… |
| Description | string | no | The deployment description |

### Creates a custom attribute definition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-custom-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The custom attribute ID. The value must match `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`. The part after custom-attribute: must be… |
| DisplayName | string | yes | The display name of the custom attribute. The value must be less than 128 characters in length |
| Type | string | yes | The type of the custom attribute. Valid values: ENUM, TEXT, and HYPERLINK |
| EntityTypes | string | yes | The list of applicable entity types. Exact entity types and wildcard patterns such as `*-table` and `*-column` are supported. Examples:… |
| ValueEnums | string | no | The enumeration values. This parameter is required when type is set to ENUM. This parameter is not supported for TEXT or HYPERLINK types… |
| DisplayEnabled | string | no | Specifies whether to display the attribute on the details page. Default value: true |
| SearchFilterEnabled | string | no | Specifies whether the attribute can be used as a filter condition on the DataWorks Data Map search page. Default value: false. Currently,… |
| Comment | string | no | The description of the custom attribute. The value must be less than 256 characters in length |

### Creates an alert rule for a data integration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-dialarm-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Description | string | no | The description of the alert rule |
| MetricType | string | yes | The alert metric type. Valid values: Heartbeat: task status alert. FailoverCount: failover count alert. Delay: task latency alert.… |
| Enabled | string | no | Specifies whether to enable the alert rule. By default, the alert rule is disabled |
| DIJobId | integer | yes | The task ID associated with the alert rule |
| ClientToken | string | no | The idempotency parameter |
| Name | string | yes | The name of the alert rule |
| TriggerConditions | string | yes | The list of alert trigger conditions. Multiple conditions are supported (JSON-encoded) |
| NotificationSettings | string | yes | The alert notification settings (JSON-encoded) |

### Creates a task in the new version of Data Integration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-dijob` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DestinationDataSourceType | string | no | The type of the destination data source. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub,… |
| Description | string | no | The description of the task |
| SourceDataSourceType | string | no | The type of the source data source. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive,… |
| ProjectId | integer | no | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Name | string | no | The name of the task |
| MigrationType | string | no | The synchronization type. Valid values: FullAndRealtimeIncremental: full and real-time incremental synchronization for entire databases in… |
| JobType | string | no | The task type. Valid values: DatabaseRealtimeMigration: real-time migration of entire databases. Performs streaming synchronization of… |
| SourceDataSourceSettings | string | no | The list of source data source settings (JSON-encoded) |
| DestinationDataSourceSettings | string | no | The list of destination data source settings (JSON-encoded) |
| ResourceSettings | string | no | The resource settings (JSON-encoded) |
| TransformationRules | string | no | The list of synchronization object transformation rule definitions. [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename",… |
| TableMappings | string | no | The list of synchronization object transformation mappings. Each element describes a group of source object selection rules and the… |
| JobSettings | string | no | The task-level settings, including DDL handling policies, source-to-destination column data type mapping policies, and task runtime… |
| JobName | string | no | [Deprecated] Use the Name parameter instead |
| Owner | string | no | The owner of the task |
| FileSpec | string | no | The code content in script mode |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| Key | string | yes | The tag key |
| Values | string | no | The list of tag values (JSON-encoded) |
| Description | string | no | The tag description |
| ValueType | string | no | The tag value type. Valid values: Boolean Int String Double |
| Managers | string | no | The list of tag administrators (JSON-encoded) |

### Creates a data quality monitoring alert rule in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-data-quality-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The project ID |
| Condition | string | yes | The alert condition for the data quality monitoring alert rule |
| Target | string | yes | The target of the data quality monitoring alert rule (JSON-encoded) |
| Notification | string | yes | The list of alert channels (JSON-encoded) |

### Creates a data quality monitor
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-data-quality-scan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Description | string | no | The description of the data quality monitor |
| ProjectId | integer | no | The DataWorks workspace ID. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/overview) and go to the… |
| Owner | string | no | The ID of the user who owns of the data quality monitor |
| Spec | string | no | Spec code for the content of the data quality monitoring. For more information, see https://help.aliyun.com/document_detail/2963394.html |
| Parameters | string | no | The definition of execution parameters for the data quality monitoring (JSON-encoded) |
| RuntimeResource | string | no | The resource group used during execution of the data quality monitoring (JSON-encoded) |
| ComputeResource | string | no | The compute engine used at runtime. If not specified, the data source defined in the Spec is used (JSON-encoded) |
| Trigger | string | no | The trigger configurations of the data quality monitoring task (JSON-encoded) |
| Hooks | string | no | The Hook configurations after the data quality monitoring run ends (JSON-encoded) |
| Name | string | no | The data quality monitoring name |
| ClientToken | string | yes | The idempotency token |

### Triggers the execution of a specified data quality monitoring task and returns the run instance ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-data-quality-scan-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DataQualityScanId | integer | no | The ID of the data quality monitoring task |
| ProjectId | integer | no | The project ID |
| Parameters | string | no | The parameter settings used during the actual run. The `triggerTime` parameter is required (JSON-encoded) |
| RuntimeResource | string | no | The schedule resource group used when the data quality monitoring task runs. This shares the same data structure as the scheduling API… |

### Creates a data quality rule template in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-data-quality-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The project ID |
| Spec | string | no | The Spec code for the detailed configuration of the rule template. For more information, see… |
| Owner | string | no | The ID of the owner |

### Creates a data source in a specified workspace for the development or production environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/overview) and go to the… |
| Name | string | yes | The name of the data source. The name can contain letters, digits, and underscores (_), and cannot start with a digit or an underscore.… |
| Type | string | yes | The type of the data source. More than 70 data source types are supported. References: https://help.aliyun.com/document_detail/2852465.html |
| ConnectionPropertiesMode | string | yes | The category in which the data source is added. Different data source types have different subtypes and parameter constraints. For… |
| Description | string | no | The description of the data source. The description can be up to 3,000 characters in length |
| ConnectionProperties | string | yes | The specific connection configuration of the data source, including the endpoint, access identity, and environment context. The envType… |

### Creates a sharing rule for a data source to share it with other workspaces or RAM users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-data-source-shared-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DataSourceId | integer | yes | The data source ID |
| TargetProjectId | integer | yes | The ID of the workspace to which you want to share the data source. You cannot share the data source to the workspace with which the data… |
| SharedUser | string | no | The user with which you want to share the data source. If you do not configure this parameter, the data source is shared to an entire… |
| EnvType | string | yes | The environment of the target workspace to which the data source is shared. Valid values: Dev: development environment Prod: production… |

### Creates a dataset. You can create a dataset only in a workspace that you have joined. Only DataWorks…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace |
| Origin | string | no | The origin of the dataset. Only DataWorks is supported |
| Name | string | yes | The name of the dataset. The value must be a non-empty string that is up to 128 characters in length |
| Comment | string | no | The description of the dataset. The value can be up to 1024 characters in length |
| DataType | string | no | The data type. Valid values: COMMON: general-purpose (default). PIC: image. TEXT: text. TABLE: table. VIDEO: video. AUDIO: audio. INDEX:… |
| StorageType | string | yes | The storage type. Valid values: OSS: Object Storage Service. NAS: general-purpose NAS file storage. EXTREMENAS: extreme NAS file storage.… |
| InitVersion | string | yes | The initial version of the dataset (JSON-encoded) |

### Creates a dataset version. Currently, only DataWorks datasets are supported. The maximum number of versions…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-dataset-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DatasetId | string | yes | The dataset ID. Currently, only DataWorks datasets are supported |
| Comment | string | no | The description of the dataset version. The description can be up to 1024 characters in length |
| Url | string | yes | The URL |
| MountPath | string | no | The mount path. The path must start with /mnt/. Default value: /mnt/data |
| ImportInfo | string | no | The storage import configuration for the dataset. The required configuration varies depending on the storage type. NAS The values can be… |

### Creates a file in Data Studio. This operation does not support creating data integration node tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| FileFolderPath | string | no | The file path |
| ProjectId | integer | no | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| FileName | string | yes | The name of the file |
| FileDescription | string | no | The description of the file |
| FileType | integer | yes | The code type of the file. Different file types have different code formats. For more information, see… |
| Owner | string | no | The Alibaba Cloud user ID of the file owner. If this parameter is left empty, the Alibaba Cloud user ID of the caller is used by default |
| Content | string | no | The code content of the file. The code format varies based on the code type (fileType) of the file. You can find a task of the… |
| AutoRerunTimes | integer | no | The maximum number of automatic reruns after an error occurs. Maximum value: 10 |
| AutoRerunIntervalMillis | integer | no | The interval between automatic reruns after a failure, in milliseconds. Maximum value: 1800000 (30 minutes). This parameter corresponds to… |
| RerunMode | string | no | The rerun policy. Valid values: ALL_ALLOWED: The task can be rerun after it succeeds or fails. FAILURE_ALLOWED: The task cannot be rerun… |
| Stop | string | no | Specifies whether to pause scheduling. Valid values: true: Pauses scheduling. false: Does not pause scheduling. This parameter corresponds… |
| ParaValue | string | no | The scheduling parameters. Separate multiple parameters with spaces. This parameter corresponds to the Schedule Settings > Scheduling… |
| StartEffectDate | integer | no | The timestamp in milliseconds when automatic scheduling starts. This parameter corresponds to the start time in milliseconds configured in… |
| EndEffectDate | integer | no | The timestamp in milliseconds when automatic scheduling stops. This parameter corresponds to the end time in milliseconds configured in… |
| CronExpress | string | no | The cron expression for periodic scheduling. This parameter corresponds to the Schedule Settings > Time Property > Cron Expression setting… |
| CycleType | string | no | The type of the scheduling cycle. Valid values: NOT_DAY (minutes and hours) and DAY (days, weeks, and months). This parameter corresponds… |
| DependentType | string | no | The dependency on the previous cycle. Valid values: SELF: Depends on the current node. CHILD: Depends on the first-level child nodes.… |
| DependentNodeIdList | string | no | The IDs of the nodes on which the current file depends when the DependentType parameter settings are USER_DEFINE. Separate multiple node… |
| InputList | string | no | The output names of the upstream files on which the current file depends. Separate multiple output names with commas (,). This parameter… |
| OutputList | string | no | The output of the file. This parameter corresponds to the Output Name of Current Node setting in Schedule Settings > Scheduling… |
| ProjectIdentifier | string | no | The name of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| ResourceGroupIdentifier | string | no | The resource group used to run the task after the file is published as a task. You can log on to the DataWorks console… |
| ResourceGroupId | integer | no | [Deprecated] Do not use this field |
| ConnectionName | string | no | The data source connected when the task is run after the file is published as a task. You can call the… |
| AutoParsing | string | no | Specifies whether to enable automatic parsing for the file. Valid values: true: Automatically parses the code in the file. false: Does not… |
| SchedulerType | string | no | The scheduling type. Valid values: NORMAL: Normal scheduling task. MANUAL: Manual task. It is not run on a daily schedule and corresponds… |
| AdvancedSettings | string | no | The advanced settings of the task. This parameter corresponds to the Advanced Settings in the right-side navigation pane of the edit page… |
| StartImmediately | string | no | Specifies whether to start the task immediately after it is published. This parameter corresponds to the Configuration > Time Attributes >… |
| InputParameters | string | no | The context input parameters of the node. The parameter value is in JSON format. For the included fields, refer to the structure of the… |
| OutputParameters | string | no | The context output parameters of the node. The parameter value is in JSON format. For the included fields, refer to the structure of the… |
| IgnoreParentSkipRunningProperty | string | no | Specifies whether to inherit the dry-run property from the previous cycle. Valid values: true: Inherits the dry-run property from the… |
| CreateFolderIfNotExists | string | no | Specifies whether to automatically create the directory specified by the FileFolderPath parameter if the directory does not exist. Valid… |
| ApplyScheduleImmediately | string | no | Specifies whether the scheduling configuration takes effect immediately after the file is published |
| Timeout | integer | no | The timeout definition in the scheduling configuration |
| ImageId | string | no | The ID of the custom image |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either… |
| ProjectIdentifier | string | no | The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console.… |
| FolderPath | string | yes | The path of the folder |

### Creates a UDF function in Data Studio. The UDF function information is described in FlowSpec format
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Spec | string | yes | The FlowSpec information that describes the UDF function. For more information about the specifications, see FlowSpec… |

### Creates an identity credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-identify-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| IdentifyCredential | string | no | The user identity credential object (JSON-encoded) |

### Creates an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the image. The name can contain lowercase letters, digits, and underscores (_), and can be up to 128 characters in length |
| Description | string | no | The description of the image. The description can be up to 128 characters in length |
| Accessibility | string | no | The visibility of the image. Valid values: Public: The image is visible to all users. Private: The image is visible only to the creator |
| ProviderType | string | yes | The reference data type of the image. Valid values: ACR: ACR image repository. DataWorks: DataWorks official image |
| Namespace | string | yes | The namespace of the image. If you reference a DataWorks official image, set this parameter to DataWorks Default |
| RepositoryName | string | yes | The name of the image repository. If you reference a DataWorks official image, set this parameter to DataWorks Default |
| ProviderImageId | string | no | The ID of the image provided by the image provider. This parameter is required if you reference a DataWorks official image |
| AcrInstanceId | string | no | The ACR instance ID. This parameter is required if you reference an ACR image |
| ImageUri | string | no | The URI of the image. This parameter is required if you reference an ACR image |
| AcrAssociatedVpcId | string | no | The ID of the virtual private cloud (VPC) associated with the ACR instance. This parameter is required if you reference an ACR image |
| EnableSyncMaxCompute | string | no | Specifies whether to synchronize the image to MaxCompute. Specify this parameter when you reference an ACR image. Default value: false |
| Supported | string | yes | The sub-purpose of the image (JSON-encoded) |
| BuildConfig | string | no | The build configuration of the image (JSON-encoded) |
| ClientToken | string | yes | The client token that is used to ensure idempotence |

### Registers a data lineage relationship in DataWorks Data Map. You can use this operation to establish lineage…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-lineage-relationship` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SrcEntity | string | no | The source entity (JSON-encoded) |
| DstEntity | string | no | The destination entity (JSON-encoded) |
| Task | string | no | The task information (JSON-encoded) |

### Creates an MCP server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-mcp-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the MCP server. It must be unique at the tenant level. It must start with a lowercase letter and can contain only lowercase… |
| Config | string | no | The connection configuration of the MCP server (JSON-encoded) |
| Visibility | string | no | The visibility level |
| VisibilityScope | string | no | The visibility scope. Specify the corresponding fields based on the value of Visibility (JSON-encoded) |

### Creates a collection in Data Map. Collections include categories, subcategories, data albums, and categories…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-meta-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ParentId | string | no | The parent collection ID |
| Name | string | yes | The name of the collection |
| Type | string | yes | The collection type. Valid values: Category: category. Album: data album. AlbumCategory: album subcategory |
| Description | string | no | The collection description |

### Creates a metadata entity definition, including custom types and extended table types
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-meta-entity-def` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the type definition. Custom types must match `^[a-z0-9][a-z0-9_]*$`. Extended table types must match… |
| DisplayName | string | yes | The display name, up to 32 characters |
| Description | string | no | The description |
| Extend | string | no | The extension mode. Valid values: NONE: default value. Indicates a custom entity with freely defined attributes. TABLE: indicates an… |
| AttributeDefs | string | no | The attribute definition list for custom entities. This parameter cannot be specified when extend is set to TABLE (JSON-encoded) |

### Creates a network and associates the network with a general resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | yes | The ID of the serverless resource group |
| VpcId | string | yes | The ID of the virtual private cloud (VPC) |
| VswitchId | string | yes | The VSwitch ID |
| ClientToken | string | yes | The client token that is used to ensure the idempotence of the request |

### Creates a Data Studio node in the new version of Data Studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| ContainerId | string | no | The unique identifier of a container in which you want to create the node. The container can be a workflow or a container node. Specify… |
| Scene | string | yes | The scenario in which the node is created. This parameter determines whether the node is created in the manual node area or the Data… |
| Spec | string | yes | The FlowSpec information that describes the node. For more information about the specification, see FlowSpec… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the parameter. It must be unique within the workspace. It must start with "workspace.". The subsequent content must start with… |
| Properties | string | yes | The parameter value configurations. This parameter is required for the production environment. If duplicate environment configurations… |
| Type | string | yes | The type. Valid values: PlainConstant: plaintext constant. SecretConstant: ciphertext constant. Variable: variable |
| ProjectId | integer | yes | The workspace ID. This parameter is required when Scope is set to Project |
| Owner | string | yes | The account ID of the owner |
| Description | string | no | The description |
| Scope | string | no | The scope of the parameter. Default value: Project. Other types are currently not supported |

### Creates a deployment process for an entity in Data Studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Type | string | yes | Specifies the type of the deployment process. Valid values: Online: Goes online. Offline: Goes offline |
| ObjectIds | string | yes | The list of entity IDs to be deployed in this deployment process. Currently, only a single entity and its child entities can be deployed.… |
| Description | string | no | The description of the deployment process |
| RunMode | string | no | The running mode of the deployment process. Default value: Normal. If you set this parameter to Auto, the deployment process automatically… |
| AutoRunUntilStage | string | no | The code of the stage to which the deployment process runs. This parameter takes effect only when the RunMode parameter is set to Auto.… |

### Creates a new approval process definition, supporting custom configuration of approval rules and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-process-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the process definition |
| Description | string | yes | The description of the process definition |
| Type | string | no | The type of the process definition. Valid values: MaxCompute DataService Extension Hologres |
| SubType | string | no | The subtype. Valid values: Table Column Database Schema Default |
| Enabled | string | no | Specifies whether to enable the process definition |
| RuleConditions | string | yes | The list of condition rules (JSON-encoded) |
| NotificationServices | string | no | The notification service declarations (JSON-encoded) |
| ApprovalNodes | string | yes | The list of approval nodes (JSON-encoded) |
| ClientToken | string | no | The idempotency token. We recommend that you use a UUID |

### Creates a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The workspace name. Constraints: The workspace name must be unique within the region. The name must start with a letter and can contain… |
| DisplayName | string | yes | The display name of the workspace |
| Description | string | no | The description of the workspace |
| AliyunResourceGroupId | string | no | The ID of the Alibaba Cloud resource group to which the workspace belongs. You can log on to the Resource Management console… |
| PaiTaskEnabled | string | no | Specifies whether to enable PAI task scheduling. Valid values: true: You can create Machine Learning Platform for AI (PAI) nodes in the… |
| DevEnvironmentEnabled | string | no | Specifies whether to enable the development environment. Valid values: true: The development environment is enabled for the workspace,… |
| AliyunResourceTags | string | no | The list of tags (JSON-encoded) |
| DevRoleDisabled | string | no | Specifies whether to disable the development role. Valid values: false: The development role is enabled. This is the default value. true:… |

### Adds a workspace member and grants workspace roles to the member
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-project-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| UserId | string | yes | The ID of the DataWorks account. You can log on to the DataWorks console - Management Center… |
| RoleCodes | string | yes | The list of workspace role codes. You can call https://help.aliyun.com/document_detail/2853930.html to obtain the role codes. This… |

### Creates a custom role for a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-project-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to… |
| Name | string | yes | The role name |
| ModulePermissions | string | no | The list of DataWorks module permissions (JSON-encoded) |
| ClientToken | string | no | The client token |

### Creates a file resource for Data Studio. The file resource information is defined in FlowSpec format
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Spec | string | yes | The FlowSpec information that describes the resource file. For more information about the specification, see FlowSpec… |
| ResourceFile | string | no | The file stream or Object Storage Service (OSS) download URL of the resource file. This field allows you to specify a file stream or an… |

### Supports users in specifying their own files (such as JAR, PY, archive, or file) to create Data Studio…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-resource-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console, go to the workspace configuration page, and obtain the… |
| FileFolderPath | string | yes | The path of the file |
| FileName | string | yes | The name of the file |
| FileType | integer | yes | The code type of the file. Different file types correspond to different code types. For more information, see… |
| FileDescription | string | no | The description of the file |
| Owner | string | no | The Alibaba Cloud User ID of the file owner. If this parameter is empty, the Alibaba Cloud User ID of the caller is used by default |
| Content | string | no | The code content of the file. The code format varies depending on the code type (fileType). You can locate a job of the corresponding type… |
| ResourceFile | string | no | The OSS URL for file upload provided by POP |
| OriginResourceName | string | yes | The name of the original resource file |
| UploadMode | string | no | The upload mode for the resource file. This parameter currently applies only to File-type files in MaxCompute. Valid values: true:… |
| RegisterToCalcEngine | string | yes | Indicates whether to synchronize and upload the resource to the compute engine |
| StorageURL | string | no | The Storage Path of the resource file on the compute engine. This field is currently used only by EMR and CDH. The EMR format is… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the general-purpose resource group. It must start with a letter and can contain letters, digits, and underscores (_). It can… |
| Remark | string | no | The remark of the general-purpose resource group. It can contain letters, Chinese characters, digits, and underscores (_). It can be up to… |
| PaymentType | string | yes | The billing method of the resource group. PrePaid indicates subscription, and PostPaid indicates pay-as-you-go |
| PaymentDurationUnit | string | no | The unit of the billing duration. Month indicates months, and Year indicates years |
| PaymentDuration | integer | no | The billing duration |
| AutoRenewEnabled | string | no | Specifies whether to enable auto-renewal |
| Spec | integer | no | The specifications of the resource group. Unit: CU. This parameter is required when the billing method of the resource group is PrePaid |
| VpcId | string | yes | The ID of the default VPC |
| VswitchId | string | yes | The ID of the default vSwitch |
| ClientToken | string | yes | The client token that is used to ensure the idempotence of the request |
| AliyunResourceGroupId | string | no | The ID of the Alibaba Cloud resource group |
| AliyunResourceTags | string | no | The list of Alibaba Cloud tags (JSON-encoded) |

### Creates a route for a network
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NetworkId | integer | yes | The network ID |
| DestinationCidr | string | yes | The CIDR blocks of the destination-based route |
| ResourceGroupId | string | no | Unique identifier of the serverless resource group |

### Creates a new security control policy and supports the configuration of multiple modules and submodules.…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-security-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The policy name |
| Description | string | no | The description of the policy |
| SchemaName | string | yes | The name of the schema template |
| ControlModule | string | yes | The control module |
| ControlSubModule | string | no | The control submodule |
| ControlDwScope | string | yes | The control scope |
| Workspaces | string | no | The list of associated workspace IDs (JSON-encoded) |
| Content | string | yes | The policy content. The content is constrained by SecurityStrategySchema (JSON-encoded) |
| ClientToken | string | no | The idempotency parameter. This parameter is used to prevent duplicate operations caused by multiple calls |

### Saves a reusable semantic job definition. If you use a single-file source, apply for and complete the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-semantic-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The semantic job name, which also serves as the job identifier for subsequent calls to RunSemanticJob, DeleteSemanticJob,… |
| ProjectId | integer | no | The DataWorks workspace ID. This parameter is required for all Source.type values except singleTableFile. The Data.ProjectId in the… |
| ResourceGroupId | string | yes | The ID of the resource group used to run the semantic job. RunSemanticJob does not accept this parameter and instead uses the resource… |
| Source | string | yes | The input datasource config for the semantic node. The type field is required. This parameter specifies the data to be analyzed and is not… |
| ReferenceFileIds | string | no | The list of uploaded reference file IDs. When Source.type=singleTableFile, use either this parameter or ReferenceFileUris, and the… |
| ReferenceFileUris | string | no | The list of reference file URIs accessible by the caller. When Source.type=singleTableFile, use either this parameter or ReferenceFileIds,… |

### Creates a personal development environment instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-server-ide-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The DataWorks workspace ID |
| ResourceGroupId | string | yes | The DataWorks resource group identifier. You can specify the numeric ID of the resource group or the full identifier in the… |
| Cu | integer | no | The number of CUs used by the instance |
| Owner | string | no | The Alibaba Cloud account ID of the user who owns the instance. If this parameter is not specified, the current caller is used by default |
| ImageId | string | no | The image ID. You can call ListServerIdeImages to obtain the image ID |
| ImageUrl | string | no | The image URL. This parameter is required when you use a non-official DataWorks image |
| InstanceName | string | yes | The name of the personal development environment instance |
| UserVpc | string | no | The Virtual Private Cloud (VPC) configuration used by the instance (JSON-encoded) |
| Datasets | string | no | The list of datasets mounted to the instance (JSON-encoded) |
| CredentialConfig | string | no | The credential injection configuration for the instance. After this feature is enabled, you can use the default RAM role chain or specify… |
| UserCommand | string | no | The user command configuration to be executed when the instance starts (JSON-encoded) |

### Creates a skill in DataWorks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The skill name. The name must be unique within the current account |
| Description | string | no | The skill description |
| Visibility | string | no | The visibility level. Valid values: TENANT (visible to the entire tenant), PROJECT (visible to specific projects), and USER (visible to… |
| VersionNote | string | no | The version note |
| SkillMdOverride | string | no | The content of the SKILL.md file. This parameter and BundleUrl are mutually exclusive. If you do not provide a bundle, use this parameter… |
| BundleUrl | string | no | The download URL of the bundle.zip file (HTTP or HTTPS). This parameter and SkillMdOverride are mutually exclusive |
| Extra | string | no | The extended metadata in key-value pairs (JSON-encoded) |
| VisibilityScope | string | no | The visibility scope. Specify the corresponding field based on the value of Visibility (JSON-encoded) |

### Creates a file for a function in Data Studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-udf-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| FileFolderPath | string | yes | The path to the folder containing the function file |
| ProjectId | integer | no | The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page |
| FileName | string | yes | The function name |
| FunctionType | string | yes | The function category, corresponding to the function type field in the Create Function form. Valid values: MATH (mathematical functions),… |
| ClassName | string | yes | The class name where the function is defined, corresponding to the class name field in the Create Function form |
| Resources | string | yes | A comma-separated list of resource names referenced by the function, corresponding to the resource list field in the Create Function form |
| UdfDescription | string | no | The function purpose description, corresponding to the description field in the Create Function form |
| CmdDescription | string | no | The command format for invoking the function, corresponding to the command format field in the Create Function form |
| ParameterDescription | string | no | The function parameter description, corresponding to the parameter description field in the Create Function form |
| ReturnValue | string | no | The return value description, corresponding to the return value field in the Create Function form |
| Example | string | no | An example demonstrating how to call the function, corresponding to the example field in the Create Function form |
| ProjectIdentifier | string | no | The unique identifier of the DataWorks workspace, which is the English identifier at the top of the Data Studio page where you switch… |
| CreateFolderIfNotExists | string | no | Specifies whether to automatically create the directory if the specified path (FileFolderPath) does not exist. Valid values: true:… |

### Creates a workflow in a specified directory in Data Studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-workflow-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Spec | string | yes | The FlowSpec information that describes the workflow. For more information about the specifications, see FlowSpec… |

### Creates a workflow instance based on configurations, such as a data backfill workflow instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/create-workflow-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The project ID |
| EnvType | string | no | The project environment. Valid values: Prod: production Dev: development |
| WorkflowId | integer | yes | The ID of the workflow. The WorkflowId of a scheduled task is always 1 |
| Name | string | yes | The name |
| Periods | string | no | The data backfill period settings (JSON-encoded) |
| Type | string | yes | The type of the workflow instance. Valid values: SupplementData: data backfill. The methods for specifying RootTaskIds and IncludeTaskIds… |
| WorkflowParameters | string | no | The workflow parameters. This parameter takes effect only when a specific workflow is specified (WorkflowId != 1). For a periodic workflow… |
| TaskParameters | string | no | The task parameters, which are used to set parameters for specific tasks. The value is in JSON format. The key is the task ID, and the… |
| AutoStartEnabled | string | no | Specifies whether to run the workflow instance immediately after it is created. Default value: true |
| DefaultRunProperties | string | no | The runtime configurations (JSON-encoded) |
| Comment | string | no | The reason for creation |
| Tags | string | no | The list of task tags (JSON-encoded) |
| TagCreationPolicy | string | no | The tag creation policy. Valid values: Append: Append mode. Inherits existing tags from the manual workflow and appends new tags.… |

### Deletes an Agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Agent to delete |

### Deletes a custom monitoring alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | no | The ID of the custom rule |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must… |
| ProjectIdentifier | string | no | The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to query the… |
| BusinessId | integer | yes | The workflow ID. You can call the https://help.aliyun.com/document_detail/173945.html operation to query the ID of a workflow by name |

### Deletes a scheduling calendar
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-calendar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the scheduling calendar |

### Deletes a certificate file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the certificate file, which is the unique identifier of the certificate file |
| ProjectId | integer | yes | The ID of the project to which the certificate file to be deleted belongs |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| ComponentId | string | yes | The ID of the component. You can use this ID as a request parameter to query the component list or modify a component |

### Deletes the specified computing resource based on the computing resource ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-compute-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The computing resource ID, the unique identifier of the data source |
| ProjectId | integer | yes | The workspace ID |

### Deletes a specified metadata crawler
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-crawler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the metadata crawler. You can call ListCrawlers to query the ID |

### Deletes a custom attribute definition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-custom-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The ID of the custom attribute |

### Deletes an alert rule configured for a synchronization task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-dialarm-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | no | The alert rule ID |
| DIJobId | integer | no | The ID of the synchronization task |
| DIAlarmRuleId | integer | no | This parameter is deprecated. Use the Id parameter instead |

### Deletes a new-version synchronization task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-dijob` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | no | The ID of the synchronization task |
| ProjectId | integer | no | The DataWorks workspace ID |
| DIJobId | integer | no | This parameter is deprecated. Use the Id parameter instead |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| Key | string | yes | The tag key |
| Values | string | no | The tag values (JSON-encoded) |

### Deletes a data quality monitoring alert rule based on the specified ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-data-quality-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | no | The ID of the data quality rule template |

### Deletes a data quality monitoring rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-data-quality-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The rule ID |
| ProjectId | integer | no | The DataWorks workspace ID |

### Deletes a data quality monitor
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-data-quality-scan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Description | string | no | The deprecated parameter. No configuration is required |
| Id | integer | no | The ID of the data quality monitor |

### Deletes a data quality rule template by ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-data-quality-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | no | The ID of the custom rule template |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The data source ID |

### Deletes a data source sharing rule by its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-data-source-shared-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the data source sharing rule. You can call the ListDataSourceSharedRules operation to query existing sharing rules and their IDs |

### Deletes a dataset. Only DataWorks datasets are supported. The corresponding dataset versions are cascade…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The dataset ID. Only DataWorks datasets are supported |

### Deletes a dataset version. Only non-v1 DataWorks dataset versions can be deleted by using this operation. To…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-dataset-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The dataset version ID. Only DataWorks datasets are supported |

### Deletes a file from Data Studio. If the file has been committed, an asynchronous process is triggered to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace… |
| ProjectIdentifier | string | no | The name of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| FileId | integer | yes | The file ID. You can call the https://help.aliyun.com/document_detail/173942.html operation to obtain the file ID |

### Invoke DeleteFolder to delete a folder on the Data Studio page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must… |
| ProjectIdentifier | string | no | The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to query the… |
| FolderId | string | yes | The folder ID. You can call the https://help.aliyun.com/document_detail/173955.html operation to obtain the folder ID |

### Deletes a user-defined function (UDF) in Data Studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace… |
| Id | string | yes | The unique identifier of the UDF. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions… |

### Deletes an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The image ID |

### Deletes a specified data lineage relationship from DataWorks Data Map
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-lineage-relationship` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The ID of the lineage relationship. You can obtain this ID from the response of the ListLineageRelationships operation. The ID is in the… |

### Delete MCP Server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-mcp-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the MCP Server to delete |

### Delete a collection object in the specified Data Map, including Data Map categories and data albums. When…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-meta-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The collection ID |

### Deletes a metadata entity definition, including custom entity types and extension table types
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-meta-entity-def` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EntityType | string | yes | The entity type |
| Force | string | no | Specifies whether to force delete the entity definition. Default value: false. Valid values: true: Automatically deletes all entity… |

### Disassociates and deletes a network resource from a general-purpose resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the network resource to delete |

### Deletes a specified Data Studio node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Id | string | yes | The unique identifier of the Data Studio node. <notice>This field was of the Long type in SDK versions earlier than 8.0.0 and is of… |

### Deletes a specified parameter
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-parameter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the parameter |

### Deletes a process definition by the specified ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-process-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The ID of the process definition to delete |

### Deletes a DataWorks workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to… |

### Removes a workspace member and the workspace roles granted to the member
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-project-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| UserId | string | yes | The ID of the DataWorks account. You can log on to the DataWorks console - Management Center… |

### Deletes a custom role from a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-project-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to… |
| Code | string | yes | The unique identifier of the custom role |

### Deletes a file resource from Data Studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace… |
| Id | string | yes | The unique identifier of the resource file. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK… |

### Deletes a general-purpose resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The unique identifier of the resource group |

### Deletes a route from a network resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The route ID |

### Deletes a security strategy by its ID. To call this operation, you must have DataWorks tenant administrator…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-security-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The ID of the security strategy |

### Deletes a semantic job definition by the Name of a created job. If the job is currently running, call…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-semantic-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the job to delete. Use the Data.Name value from the CreateSemanticJob response or the Name value from a ListSemanticJobs list… |

### Deletes a specified personal development environment instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-server-ide-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | The ID of the personal development environment instance. You can call ListServerIdeInstances to obtain the ID |

### Delete Skill
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | yes | The name of the Skill to delete |

### Deletes a specified task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The task ID |
| ProjectEnv | string | no | The project environment |

### Deletes a specified workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | integer | yes | The unique identifier of the workflow |
| EnvType | string | no | The project environment. Valid values: Prod: production Dev: development |
| ClientUniqueCode | string | no | The client unique code of the workflow, which is used to implement asynchronous operations and idempotence. If you do not specify this… |

### Deletes a specified workflow in Data Studio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/delete-workflow-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Id | string | yes | The unique identifier of the Data Studio workflow. <notice>This field was of the Long type in SDK versions earlier than 8.0.0 and is… |

### Deploys a file to the production environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/deploy-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the… |
| ProjectIdentifier | string | no | The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the… |
| FileId | integer | no | The ID of the file. You can call https://help.aliyun.com/document_detail/173942.html to query the file ID. You need to specify only one of… |
| Comment | string | no | The description of the deployment |
| NodeId | integer | no | The ID of the node in the scheduling system that corresponds to the file to be published. You need to specify only one of this parameter… |

### Disables an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/disable-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The image ID |

### Disables the specified approval process definition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/disable-process-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | no | The process definition ID |
| ClientToken | string | no | An idempotence token used to make the request idempotent. A universally unique identifier (UUID) is recommended |

### Disassociates an image from a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/dissociate-project-from-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The ID of the image |
| ProjectId | integer | yes | The ID of the workspace |

### Disassociates a resource group from a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/dissociate-project-from-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | yes | The unique identifier of the resource group |
| ProjectId | integer | yes | The ID of the workspace to disassociate |

### Returns the download URL of artifacts by job name and an optional run ID after a run completes. If JobRunId…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/download-semantic-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobName | string | yes | The job name. You can obtain this value from Data.Name in the CreateSemanticJob response, Name in the ListSemanticJobs response, or… |
| JobRunId | string | no | The optional run ID. If you specify the JobRunId from the RunSemanticJob response (Data.JobRunId) or the ListSemanticJobRuns response,… |

### Enables an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/enable-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | yes | The image ID |

### Enables a process definition with the specified ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/enable-process-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Id | string | no | process definition ID |
| ClientToken | string | no | The idempotence token. A UUID is recommended |

### Imports a table to a workflow. Calling this operation is equivalent to right-clicking a workflow on the Data…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/establish-relation-table-to-business` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | no | The ID of the DataWorks workspace. You can click the wrench icon in the top-right corner to access the workspace management page and view… |
| ProjectIdentifier | string | no | The unique identifier of the DataWorks workspace. This is the identifier shown in the workspace switcher at the top of the Data Studio… |
| BusinessId | string | yes | The workflow ID. You can call the https://help.aliyun.com/document_detail/173945.html operation to obtain the workflow ID |
| TableGuid | string | yes | The UUID of the table. You can call the https://help.aliyun.com/document_detail/173919.html operation to obtain the table UUID |
| FolderId | string | no | The ID of the folder. You can call the https://help.aliyun.com/document_detail/173952.html or… |

### Executes a cross-workspace deployment flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/exec-cross-project-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The workspace ID |
| PipelineRunId | string | yes | The ID of the cross-workspace deployment flow |

### Executes a specified stage of a deployment process
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/exec-pipeline-run-stage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProjectId | integer | yes | The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the… |
| Id | string | yes | The unique identifier of the deployment process |
| Code | string | yes | The code of the deployment process stage. For the specific value, see the response of the GetPipelineRun operation |

### Creates a temporary workflow instance based on the specified configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/execute-adhoc-workflow-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EnvType | string | no | The project environment. Valid values: Prod: production. Dev: development |
| Name | string | yes | The name |
| ProjectId | integer | yes | The project ID |
| Owner | string | yes | The account ID of the owner |
| BizDate | integer | no | The business date. The value is a timestamp |
| Tasks | string | yes | The list of tasks (JSON-encoded) |

…and 262 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/abolish-cross-project-pipeline-run" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud DataWorks API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dataworks-public/abolish-cross-project-pipeline-run with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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