API overview-DataWorks(DataWorks)-阿里云帮助中心

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (dataworks-public/2024-05-18) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

Space Management

API	Title	Description
Workspace	Workspace
CreateProject	CreateProject	Creates a workspace.
DeleteProject	DeleteProject	Deletes a DataWorks workspace.
UpdateProject	UpdateProject	This operation updates a DataWorks workspace.
ListProjects	ListProjects	Queries a list of DataWorks workspaces of the tenant to which your account belongs.
GetProject	GetProject	Queries the information about a DataWorks workspace.
Workspace Role	Workspace Role
CreateProjectRole	CreateProjectRole	Creates a custom role for a workspace.
DeleteProjectRole	DeleteProjectRole	Deletes a custom role from a workspace.
UpdateProjectRole	UpdateProjectRole	Updates the permissions of a custom role in a workspace.
GetProjectRole	GetProjectRole	Queries the details of a workspace role.
ListProjectRoles	ListProjectRoles	Returns a paginated list of roles in a workspace.
Workspace Member	Workspace Member
CreateProjectMember	CreateProjectMember	Adds a workspace member and assigns a workspace-level role to the member.
DeleteProjectMember	DeleteProjectMember	Removes a workspace member and the workspace-level roles that are assigned to the member.
GrantMemberProjectRoles	GrantMemberProjectRoles	Assigns roles to members in a workspace.
RevokeMemberProjectRoles	RevokeMemberProjectRoles	Revokes roles that are assigned to a member in a workspace.
GetProjectMember	GetProjectMember	Retrieves the details of a specific member in a Workspace.
ListProjectMembers	ListProjectMembers	Gets a paginated list of workspace member details.

Data source

API	Title	Description
UpdateDataSource	UpdateDataSource	Modifies a data source by ID.
TestDataSourceConnectivity	Test the connectivity of a data source	Test the connectivity of a data source on a resource group.
CreateDataSource	CreateDataSource	Adds a data source to the development environment or production environment of a workspace.
DeleteDataSource	DeleteDataSource	Deletes a data source by data source ID.
CloneDataSource	CloneDataSource	Clones a data source to create a new data source with the same configurations.
ListDataSources	ListDataSources	Retrieves a list of data sources that match the specified filter conditions.
Data Source Sharing Rules	Data Source Sharing Rules
CreateDataSourceSharedRule	CreateDataSourceSharedRule	Creates a sharing rule for a data source to share it with other workspaces or RAM users.
DeleteDataSourceSharedRule	DeleteDataSourceSharedRule	Deletes a data source sharing rule by rule ID.
ListDataSourceSharedRules	ListDataSourceSharedRules	Retrieves a list of sharing rules for a data source.

Computing Resource

API	Title	Description
DeleteComputeResource	DeleteComputeResource	Deletes the specified computing resource based on the computing resource ID.
GetComputeResource	GetComputeResource	Queries the specified computing resource based on the computing resource ID.
UpdateComputeResource	UpdateComputeResource	Modifies the specified computing resource based on the computing resource ID.
ListComputeResources	ListComputeResources	Queries the list of computing resources that meet the specified business information.
CreateComputeResource	CreateComputeResource	Creates a computing resource in the specified workspace. The resource can be for a development environment or a production environment.

Resource Group Management

API	Title	Description
Resource Group	Resource Group
CreateResourceGroup	CreateResourceGroup	Creates a resource group.
DeleteResourceGroup	DeleteResourceGroup	Deletes a resource group.
UpdateResourceGroup	UpdateResourceGroup	Updates basic information about a resource group.
GetResourceGroup	GetResourceGroup	Queries the information about a resource group based on its ID.
ListResourceGroups	ListResourceGroups	Retrieves a list of resource groups.
DissociateProjectFromResourceGroup	Disassociate a resource group from a workspace	Disassociates a resource group from a workspace.
AssociateProjectToResourceGroup	AssociateProjectToResourceGroup	Associates a resource group with a workspace.
ListResourceGroupAssociateProjects	ListResourceGroupAssociateProjects	Query the list of workspaces with which a resource group is associated
ListResourceGroupMetricData	ListResourceGroupMetricData	Queries the metric data of a resource group.
Routing	Routing
CreateRoute	CreateRoute	Creates a route for a network.
DeleteRoute	DeleteRoute	Deletes a route from a network resource.
UpdateRoute	UpdateRoute	Updates the information about a route.
GetRoute	GetRoute	Queries the information about a route based on its ID.
ListRoutes	ListRoutes	Retrieves a list of routes for a network resource.
Network	Network
CreateNetwork	CreateNetwork	Creates a network and associates the network with a general resource group.
DeleteNetwork	DeleteNetwork	Disassociates and deletes a network from a general resource group.
GetNetwork	GetNetwork	Queries the information about a network resource.
ListNetworks	ListNetworks	Retrieves a list of network resources for a serverless resource group.

Image management

API	Title	Description
GetImage	GetImage	Gets the details of an image by its ID.
ListImages	ListImages	Retrieves a list of images.
ListImageVersions	ListImageVersions	Gets the details of a specified image version.
AssociateProjectToImage	AssociateProjectToImage	Associates an image with a workspace.
DissociateProjectFromImage	DissociateProjectFromImage	Disassociates an image from a workspace.
ListImageAssociatedProjects	ListImageAssociatedProjects	Lists the workspaces associated with an image.

Data Development

API	Title	Description
Component	Component
CreateComponent	CreateComponent	Creates components.
DeleteComponent	DeleteComponent	Deletes a component.
GetComponent	GetComponent	Gets component information.
UpdateComponent	UpdateComponent	Updates components.
ListComponents	ListComponents	Retrieves a list of components.
Node	Node
CreateNode	CreateNode	Creates a node in DataStudio. The information about the node is described by using FlowSpec.
DeleteNode	DeleteNode	Deletes a node from DataStudio.
UpdateNode	UpdateNode	Updates the basic information about a node in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.
MoveNode	MoveNode	Moves a node to a path in DataStudio.
RenameNode	RenameNode	Renames a node in DataStudio.
GetNode	GetNode	Queries the information about a node in DataStudio.
ListNodes	ListNodes	Retrieves a paginated list of data development nodes that can be filtered by specified criteria.
ListNodeDependencies	ListNodeDependencies	Gets a paginated list of dependent nodes for a specified data development node.
Workflow Definition	Workflow Definition
CreateWorkflowDefinition	CreateWorkflowDefinition	Creates a workflow in a directory of DataStudio.
ImportWorkflowDefinition	ImportWorkflowDefinition	Imports a workflow and its child nodes that are specified by the FlowSpec field to DataStudio.
DeleteWorkflowDefinition	DeleteWorkflowDefinition	Deletes a workflow from DataStudio.
UpdateWorkflowDefinition	UpdateWorkflowDefinition	Updates the basic information about a workflow in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.
MoveWorkflowDefinition	MoveWorkflowDefinition	Moves a workflow to a path in DataStudio.
RenameWorkflowDefinition	RenameWorkflowDefinition	Renames a workflow in DataStudio.
GetWorkflowDefinition	GetWorkflowDefinition	Queries the information about a workflow.
ListWorkflowDefinitions	ListWorkflowDefinitions	Queries a list of workflows in DataStudio. You can also specify filter conditions to query specific workflows.
Resource	Resource
CreateResource	CreateResource	\\> You cannot use this API operation to create multiple file resources at a time. If you specify multiple file resources by using FlowSpec, the system creates only the first specified resource.
DeleteResource	DeleteResource	Deletes a file resource from DataStudio.
UpdateResource	UpdateResource	Updates the basic information about a file resource in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.
GetResource	GetResource	Queries the information about a file resource.
ListResources	ListResources	Queries a list of file resources in DataStudio. You can also specify filter conditions to query specific file resources.
MoveResource	MoveResource	Moves a file resource to a path in DataStudio.
RenameResource	RenameResource	Renames a file resource in DataStudio.
Function	Function
CreateFunction	CreateFunction	Creates a user-defined function (UDF) in DataStudio. The information about the UDF is described by using FlowSpec.
DeleteFunction	DeleteFunction	Deletes a user-defined function (UDF) in DataStudio.
UpdateFunction	UpdateFunction	Updates the basic information about a user-defined function (UDF) in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.
MoveFunction	MoveFunction	Moves a user-defined function (UDF) to a path in DataStudio.
RenameFunction	RenameFunction	Renames a user-defined function (UDF) in DataStudio.
GetFunction	GetFunction	Queries the information about a user-defined function (UDF) in DataStudio.
ListFunctions	ListFunctions	Queries a list of user-defined functions (UDFs) in DataStudio. You can also specify filter conditions to query specific UDFs.
Deployment	Deployment
CreatePipelineRun	CreatePipelineRun	Creates a deployment process for entities in the Data Studio (new version).
AbolishPipelineRun	AbolishPipelineRun	Terminates the specified deployment process. This operation changes the status of the process to Terminated but does not delete the process. You can still query the process.
ExecPipelineRunStage	ExecPipelineRunStage	Executes a stage in a process.
GetPipelineRun	GetPipelineRun	Gets the details of a Deployment Process.
ListPipelineRuns	ListPipelineRuns	Retrieve a paginated list of deployment processes. You can also filter this list based on specific criteria.
ListPipelineRunItems	ListPipelineRunItems	Queries the information about deployment objects by deployment process ID.

Data Development (Old)

API	Title	Description
File	File
CreateFile	CreateFile	Creates a file in DataStudio. You cannot call this operation to create Data Integration nodes.
CreateResourceFile	Create Resource File	Supports users in specifying their own files (such as JAR, PY, archive, or file) to create Data Development resource files.
CreateUdfFile	CreateUdfFile	Creates a file for a function in DataStudio.
UpdateFile	UpdateFile	Updates a file.
UpdateUdfFile	UpdateUdfFile	Updates the file information about a function.
GetFile	Obtain the details of a file	Retrieves the details of a file.
ListFiles	ListFiles	Queries a list of files.
SubmitFile	SubmitFile	Commits a file to the development environment of the scheduling system to generate a task.
DeployFile	DeployFile	Publish a file to the production environment.
Folder	Folder
CreateFolder	CreateFolder	Creates a folder.
DeleteFolder	DeleteFolder	Invoke DeleteFolder to delete a folder on the Data Development page.
UpdateFolder	UpdateFolder	Invoke UpdateFolder to update the folder information.
GetFolder	GetFolder	Queries the information about a folder.
ListFolders	ListFolders	Queries a list of folders.
Business	Business
CreateBusiness	CreateBusiness	Creates a workflow in DataStudio.
DeleteBusiness	DeleteBusiness	Deletes a workflow.
UpdateBusiness	UpdateBusiness	Updates a workflow.
GetBusiness	GetBusiness	Queries the information about a workflow.
ListBusiness	ListBusiness	Queries a list of workflows.
Deployment Package	Deployment Package
GetDeploymentPackage	GetDeploymentPackage	Queries the information about a deployment package.
ListDeploymentPackages	ListDeploymentPackages	Queries a list of deployment packages.
ListDeploymentPackageFiles	ListDeploymentPackageFiles	Queries a list of versions of files to be deployed.
File Version	File Version
GetFileVersion	Obtain the details of a file version	Invoke GetFileVersion to obtain the version details of a file.
ListFileVersions	ListFileVersions	Queries a list of file versions.
IDE Event	IDE Event
UpdateIDEEventResult	UpdateIDEEventResult	Recalls the check result of the message of an extension point event.
GetIDEEventDetail	GetIDEEventDetail	Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered.
Table	Table
EstablishRelationTableToBusiness	EstablishRelationTableToBusiness	Imports a table to a workflow. The call to this API operation is equivalent to performing the following operations: Go to the DataStudio page, find the desired workflow, and then click the workflow name. Right-click Table under the desired folder and select Import Table.

Data Integration

API	Title	Description
Synchronization Task	Synchronization Task
CreateDIJob	CreateDIJob	Create a new version of a data integration task.
UpdateDIJob	UpdateDIJob	Update a Data Integration task.
DeleteDIJob	DeleteDIJob	Deletes a new-version synchronization task.
StopDIJob	StopDIJob	Stops a synchronization task.
StartDIJob	StartDIJob	Starts a new-version synchronization task.
GetDIJob	GetDIJob	View data integration tasks.
GetDIJobLog	GetDIJobLog	Obtains logs generated for a synchronization task.
ListDIJobs	ListDIJobs	Lists Data Integration jobs.
ListDIJobRunDetails	ListDIJobRunDetails	Queries the running information about a synchronization task.
ListDIJobMetrics	ListDIJobMetrics	Queries metrics for a synchronization task.
ListDIJobEvents	ListDIJobEvents	Queries events for a synchronization task.
Task Alert	Task Alert
CreateDIAlarmRule	CreateDIAlarmRule	Creates an alert rule for a synchronization task.
UpdateDIAlarmRule	UpdateDIAlarmRule	Updates an alert rule configured for a synchronization task.
DeleteDIAlarmRule	DeleteDIAlarmRule	Deletes an alert rule configured for a synchronization task.
ListDIAlarmRules	ListDIAlarmRules	Views alert rules configured for a synchronization task.

Data Map

API	Title	Description
Metadata Collector Type	Metadata Collector Type
ListCrawlerTypes	ListCrawlerTypes	Queries a list of metadata crawler types supported in Data Map. The subtypes of the types and the hierarchical relationship between the subtypes are also returned.
Metadata Entity	Metadata Entity
Catalog	Catalog
ListCatalogs	ListCatalogs	Queries a list of catalogs in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawler types are supported. For the DLF metadata crawler type, all supported data catalogs are returned. For the StarRocks metadata crawler type, data catalogs in a specific instance are returned.
GetCatalog	GetCatalog	Queries the information about a catalog in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawlers are supported.
Data Base	Data Base
ListDatabases	ListDatabases	Queries a list of databases in an instance, cluster, or data catalog in Data Map. For DLF or StarRocks data sources, you can call this API operation to query databases in a data catalog. For StarRocks data sources, you can call this API operation to query databases in internal catalogs. For other types of data sources, you can call this API operation to query databases in an instance or cluster.
GetDatabase	GetDatabase	Queries the information about a specific database in Data Map.
Mode	Mode
ListSchemas	Query the list of database schemas in Data Map	Queries the list of schemas under a specified database or MaxCompute project in Data Map. Currently supports MaxCompute and Holo types.
GetSchema	GetSchema	Retrieves the schema details of a specified table in Data Map. Only MaxCompute and Hologres schemas are supported.
Table	Table
ListTables	ListTables	Queries a list of tables in the data map. For data source types that do not support schemas, this operation queries tables within a specified database. For data source types that support schemas, you can query tables within a specified database, MaxCompute project, or schema. The response includes basic table information, technical metadata, and business metadata.
GetTable	GetTable	Queries the information about a specific table in Data Map.
UpdateTableBusinessMetadata	UpdateTableBusinessMetadata	Updates the business metadata for a data table in the data map. You can update only the table's Readme and custom attributes.
Column	Column
ListColumns	ListColumns	Queries the column list of a specified table in Data Map.
GetColumn	GetColumn	Queries the information about a specific field of a table in Data Map.
UpdateColumnBusinessMetadata	UpdateColumnBusinessMetadata	Updates the business metadata for a column in a data map. This operation can only update the business description and custom attributes.
Dataset	Dataset
ListDatasets	ListDatasets	Queries a list of datasets. Currently, DataWorks datasets and PAI datasets are supported.
GetDataset	GetDataset	Gets the details of a dataset.
CreateDataset	CreateDataset	Creates a dataset. This operation is supported only in workspaces that the user has joined. Currently, only DataWorks datasets are supported. The maximum number of datasets allowed per tenant is 2,000.
UpdateDataset	UpdateDataset	Updates dataset information. Only DataWorks datasets are supported. The operator must be the creator of the dataset or the administrator of the workspace where the dataset is located.
DeleteDataset	DeleteDataset	Delete a dataset. Only DataWorks datasets are supported. This operation cascades to delete all associated dataset versions. Requires dataset creator or workspace administrator permissions.
Dataset Version	Dataset Version
ListDatasetVersions	ListDatasetVersions	Retrieves the version list for a given dataset.
GetDatasetVersion	GetDatasetVersion	Gets information for a given dataset version.
CreateDatasetVersion	CreateDatasetVersion	Creates a dataset version. Currently supports DataWorks datasets only, with a maximum of 20 versions.
UpdateDatasetVersion	UpdateDatasetVersion	Updates dataset version information. Only DataWorks datasets are supported. Requires dataset creator or workspace administrator permissions.
DeleteDatasetVersion	DeleteDatasetVersion	Deletes a dataset version. Only non-v1 DataWorks datasets are supported. To delete v1 datasets, use the DeleteDataset operation. Requires dataset creator or workspace administrator permissions.
PreviewDatasetVersion	PreviewDatasetVersion	Previews the content of a specified dataset version. Currently only text file preview is supported for OSS-type datasets. Supported MIME types 1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream
Partition	Partition
ListPartitions	ListPartitions	Queries a list of partitions in a table in Data Map. Only tables of the MaxCompute and E-MapReduce (EMR)-type Hive Metastore Service (HMS) metadata crawlers are supported.
GetPartition	GetPartition	Retrieves partition details for a data map table. Currently supports MaxCompute and HMS (EMR cluster) types only.
Lineage Relationship	Lineage Relationship
ListLineageRelationships	ListLineageRelationships	Queries the data map for data lineage relationships between specified entities, such as tables, columns, and OSS objects.
GetLineageRelationship	GetLineageRelationship	Retrieves details for a specific lineage relationship in the data map.
DeleteLineageRelationship	DeleteLineageRelationship	Deletes a lineage in Data Map.
CreateLineageRelationship	Register data lineage relationship in data map	Registers a data lineage relationship in Data Map. You can use this operation to establish lineage connections between DataWorks-managed metadata entities (tables, fields, datasets, or user-registered custom entity objects) and non-managed custom objects. If the associated entity in the lineage relationship is a DataWorks-managed metadata entity, make sure the entity is already managed by the DataWorks platform before calling this operation.
ListLineages	ListLineages	Queries the upstream and downstream entities for a specified entity in Data Map. You can optionally include detailed lineage relationship information.
Meta Collection	Meta Collection
ListMetaCollections	ListMetaCollections	Queries a list of collections in Data Map. Collections include categories and data albums.
CreateMetaCollection	CreateMetaCollection	Creates a collection in Data Map. Collections include categories, subcategories, data albums, and categories that are created in the data albums.
GetMetaCollection	GetMetaCollection	Queries the information about a collection in Data Map. Collections include categories and data albums.
UpdateMetaCollection	Update Data Map Collection Object	Update Data Map collection objects, including Data Map categories and data albums. You can update the collection name, description, and administrator information. When updating a data album, the caller must have the AliyunDataWorksFullAccess permission or be the creator or an administrator of the album.
DeleteMetaCollection	Delete a Data Map collection object	Delete a collection object in the specified Data Map, including Data Map categories and data albums. When deleting a data album, the caller must have the AliyunDataWorksFullAccess permission or be the creator or administrator of the album.
ListEntitiesInMetaCollection	ListEntitiesInMetaCollection	Queries a list of entities in a collection in Data Map. Collections include categories and data albums. Entities can only be tables.
AddEntityIntoMetaCollection	AddEntityIntoMetaCollection	Adds an entity to a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to add an entity to a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.
RemoveEntityFromMetaCollection	Remove an entity object from a Data Map collection	Remove an entity object from a Data Map collection. The collection supports Data Map categories and data albums, and the entity currently supports only the Data Table type. When removing an entity from a data album, the caller must have the AliyunDataWorksFullAccess permission or be the creator or administrator of the album.

Operation Center

API	Title	Description
Parameter	Parameter
CreateParameter	CreateParameter	Creates a parameter.
DeleteParameter	DeleteParameter	Deletes a specified parameter.
UpdateParameter	UpdateParameter	Updates a parameter. This operation performs an incremental update and modifies only the specified fields.
RollbackParameter	RollbackParameter	Rolls back a specified parameter.
GetParameter	GetParameter	Gets the details of a parameter by its ID.
ListParameters	ListParameters	Query parameters.
ListParameterVersions	ListParameterVersions	Lists parameter versions.
Monitoring Alarm	Monitoring Alarm
ListAlertRules	ListAlertRules	Queries a list of custom monitoring alert rules.
GetAlertRule	GetAlertRule	Queries a custom alert monitoring rule.
UpdateAlertRule	UpdateAlertRule	Updates the information about a custom alert monitoring rule.
DeleteAlertRule	DeleteAlertRule	Deletes a custom monitoring alert rule.
CreateAlertRule	CreateAlertRule	Creates a custom monitoring alert rule.
Task	Task
DeleteTask	DeleteTask	Deletes a task.
UpdateTask	UpdateTask	Update a task. The changes are synchronized to Data Studio, which creates a new saved version.
BatchUpdateTasks	BatchUpdateTasks	Performs incremental updates on multiple tasks at a time.
GetTask	GetTask	Queries the information about a task.
ListTasks	ListTasks	Queries a list of tasks by page. You can also specify filter conditions to query tasks.
ListUpstreamTasks	ListUpstreamTasks	Queries a list of ancestor tasks of a task by page.
ListDownstreamTasks	ListDownstreamTasks	Queries a list of descendant tasks of a task by page.
ListTaskOperationLogs	ListTaskOperationLogs	Retrieves a paginated list of operation logs for a task.
Task Instances	Task Instances
UpdateTaskInstances	Modify Task Instance Properties	Modify the properties of multiple task instances in batch, including priority, resource group, data source, and more.
GetTaskInstance	GetTaskInstance	Queries the information about an instance.
GetTaskInstanceLog	GetTaskInstanceLog	Queries the run log generated during a specific run of an instance.
ListTaskInstances	ListTaskInstances	Queries a list of instances. You can also specify filter conditions to query specific instances.
ListUpstreamTaskInstances	ListUpstreamTaskInstances	Queries a list of ancestor instances of an instance by page.
ListTaskInstanceOperationLogs	ListTaskInstanceOperationLogs	Retrieves a paginated list of operation logs for a task instance.
ListDownstreamTaskInstances	ListDownstreamTaskInstances	Queries a list of descendant instances of an instance by page.
SuspendTaskInstances	SuspendTaskInstances	Suspends multiple instances at a time.
ResumeTaskInstances	ResumeTaskInstances	Resumes multiple suspended instances at a time.
StopTaskInstances	StopTaskInstances	Stops multiple instances at a time.
SetSuccessTaskInstances	SetSuccessTaskInstances	Sets the statuses of multiple instances to successful at a time.
RerunTaskInstances	RerunTaskInstances	Reruns multiple instances at a time.
RemoveTaskInstanceDependencies	RemoveTaskInstanceDependencies	Removes multiple upstream dependencies of an instance at a time.
TriggerSchedulerTaskInstance	TriggerSchedulerTaskInstance	Triggers a task to run by using an HTTP Trigger node at a specified time.
Workflow	Workflow
DeleteWorkflow	DeleteWorkflow	Deletes a workflow.
Workflow Instances	Workflow Instances
GetRerunWorkflowInstancesResult	Obtain the result of a rerun workflow instance	Query the result of an asynchronous rerun workflow instance
RerunWorkflowInstances	Rerun a workflow instance	Rerun a workflow instance
CreateWorkflowInstances	CreateWorkflowInstances	Creates a workflow instance, such as a data backfill workflow instance, based on configurations.
GetCreateWorkflowInstancesResult	GetCreateWorkflowInstancesResult	Queries the result of asynchronously creating a workflow instance.
GetWorkflowInstance	GetWorkflowInstance	Queries the information about a workflow instance.
ListWorkflowInstances	ListWorkflowInstances	Returns a paginated list of workflow instances that can be filtered by specific criteria.
StartWorkflowInstances	Start Workflow Instance	Start multiple workflow instances in batch.
StopWorkflowInstances	StopWorkflowInstances	Stops multiple workflow instances at a time.
ExecuteAdhocWorkflowInstance	ExecuteAdhocWorkflowInstance	Create a temporary workflow instance based on configurations.

Data Quality

API	Title	Description
Data Quality Template	Data Quality Template
CreateDataQualityTemplate	CreateDataQualityTemplate	Creates a data quality template.
UpdateDataQualityTemplate	UpdateDataQualityTemplate	Updates a data quality rule template in a project
ListDataQualityTemplates	ListDataQualityTemplates	Queries the list of data quality rule templates in a project.
GetDataQualityTemplate	GetDataQualityTemplate	Retrieves the details of a data quality rule template by template ID.
DeleteDataQualityTemplate	DeleteDataQualityTemplate	Deletes a data quality rule template by ID.
Data Quality Scan	Data Quality Scan
CreateDataQualityScan	CreateDataQualityScan	Creates a data quality monitor.
UpdateDataQualityScan	UpdateDataQualityScan	Updates a data quality monitor.
ListDataQualityScans	ListDataQualityScans	Queries the list of data quality scan tasks in a project.
GetDataQualityScan	GetDataQualityScan	Gets data quality monitoring details.
DeleteDataQualityScan	DeleteDataQualityScan	Deletes a data quality monitor.
Data Quality Alert Rules	Data Quality Alert Rules
CreateDataQualityAlertRule	CreateDataQualityAlertRule	Creates a data quality monitoring alert rule in a project.
UpdateDataQualityAlertRule	UpdateDataQualityAlertRule	Updates a specified data quality monitoring alert rule.
ListDataQualityAlertRules	ListDataQualityAlertRules	Queries the list of data quality alert rules in a project.
GetDataQualityAlertRule	GetDataQualityAlertRule	Retrieves the details of a data quality alert rule by rule ID.
DeleteDataQualityAlertRule	DeleteDataQualityAlertRule	Deletes a data quality alert rule by ID.
Data Quality ScanRun	Data Quality ScanRun
CreateDataQualityScanRun	CreateDataQualityScanRun	Triggers the specified data quality scan and returns the run ID.
ListDataQualityScanRuns	ListDataQualityScanRuns	Queries the run history of data quality scans in a specified project.
GetDataQualityScanRunLog	GetDataQualityScanRunLog	Queries the log of a specific task instance that monitors data quality.
GetDataQualityScanRun	GetDataQualityScanRun	Creates a data quality monitoring run instance.

Security Center

API	Title	Description
CreateIdentifyCredential	CreateIdentifyCredential	Creates an identity credential.

Tags Management

API	Title	Description
CreateDataAssetTag	CreateDataAssetTag	Creates a tag.
DeleteDataAssetTag	DeleteDataAssetTag	Deletes a tag.
UpdateDataAssetTag	UpdateDataAssetTag	Updates a tag.
ListDataAssetTags	ListDataAssetTags	Queries a list of tags.
TagDataAssets	TagDataAssets	Adds tags to data assets.
UnTagDataAssets	UnTagDataAssets	Removes tags from data assets.
ListDataAssets	ListDataAssets	Queries the information about DataWorks data assets to which tags are added by page.

Open Platform

API	Title	Description
GetJobStatus	GetJobStatus	Queries the status information of an asynchronous task. After you call an asynchronous operation, an asynchronous task is generated. You can call the GetJobStatus operation to query the status of the asynchronous task.

Others

API	Title	Description
ApplyResourceAccessPermission	ApplyResourceAccessPermission	Submits a request for permissions on specific resources.
ApproveProcessInstance	ApproveProcessInstance	Approves or denies a specified approval process instance.
AttachDataQualityRulesToEvaluationTask	Associate data quality rules with a data quality monitoring task	Associates data quality rules with a data quality monitoring task.
BatchCreateMetaEntities	BatchCreateMetaEntities	Creates metadata entities in a batch. All entities within a batch must have the same entity type. This operation currently supports only custom types and extended table types, which represent databases and tables.
BatchDeleteMetaEntities	BatchDeleteMetaEntities	Deletes multiple meta entities in a batch. This operation deletes custom meta entities and extended table-based objects, such as databases and tables. You cannot delete a column individually. Instead, you must delete the entire table to remove its associated columns.
CancelAgentSession	CancelAgentSession	Cancels an agent call in a specified session. This operation also supports interrupting an ongoing streaming response.
CreateAgent	Create Agent	Create Agent
CreateAgentSession	CreateAgentSession	Creates a new agent session and returns a session ID.
CreateCustomAttribute	CreateCustomAttribute	Creates a custom attribute definition.
CreateDataQualityEvaluationTask	Creates a data quality monitor	Creates a DataWorks data quality monitor.
CreateDataQualityEvaluationTaskInstance	Creates a data quality evaluation monitoring instance	Creates a data quality evaluation task instance.
CreateDataQualityRule	Create a data quality rule	Creates a data quality rule.
CreateDataQualityRuleTemplate	Create a data quality rule template	Creates a rule template.
CreateMcpServer	CreateMcpServer	Creates an MCP Server.
CreateMetaEntityDef	CreateMetaEntityDef	Creates a metadata entity definition. The definition can be for a pure custom type or an extended table type.
CreateProcessDefinition	CreateApprovalProcessDefinition	Creates a new approval process definition, supporting custom configuration of approval rules and notification services.
CreateSecurityStrategy	CreateSecurityStrategy	Creates a new security control policy to configure various modules and submodules. Requires both DataWorks tenant administrator and security administrator permissions.
DeleteCustomAttribute	DeleteCustomAttribute	Deletes a custom attribute definition.
DeleteDataQualityEvaluationTask	Delete a data quality monitor	Deletes a data quality monitoring task.
DeleteDataQualityRule	DeleteDataQualityRule	Deletes a data quality monitoring rule.
DeleteDataQualityRuleTemplate	Delete a custom data quality rule template	Deletes a custom data quality rule template.
DeleteMcpServer	Delete MCP Server	Delete MCP Server
DeleteProcessDefinition	DeleteProcessDefinition	Deletes a process definition by the specified ID.
DeleteSecurityStrategy	DeleteSecurityStrategy	Deletes a security strategy by its ID. To call this operation, you must have DataWorks tenant administrator and security administrator permissions.
DeleteSkill	Delete Skill	Delete Skill
DetachDataQualityRulesFromEvaluationTask	Remove the association between a data quality rule and a monitoring task	Removes the association between a data quality rule and a data quality monitoring task.
DisableProcessDefinition	DisableProcessDefinition	Disables the specified approval process definition.
EnableProcessDefinition	EnableProcessDefinition	Enables a process definition with the specified ID.
FindBestMatchSecurityStrategy	Match Best Security Policy	Find the security policy that best matches the given conditions.
GetAgent	GetAgent	Retrieves agent details by name.
GetAgentSessionArtifactMeta	GetAgentSessionArtifactMeta	Retrieves the metadata and content of an artifact based on a session ID and artifact path.
GetAgentSessionTokenUsage	GetAgentSessionTokenUsage	Retrieves the cumulative AI token usage for a specified session.
GetApplicationContents	GetApplicationContents	Retrieves a resource permission request by its process instance ID.
GetCustomAttribute	GetCustomAttribute	Retrieves a custom attribute definition.
GetDataQualityEvaluationTask	Query data quality monitoring details	Query the details of a data quality validation task.
GetDataQualityEvaluationTaskInstance	Retrieve data quality check task instance details.	Retrieves the details of a data quality check task instance.
GetDataQualityRule	Queries the details of a data quality rule	Queries the details of a data quality rule.
GetDataQualityRuleTemplate	Queries the details of a data quality rule template	Queries the details of a data quality rule template.
GetMcpServer	GetMcpServer	Returns the details of an MCP Server.
GetMetaEntity	GetMetaEntity	Retrieves the details of a custom entity.
GetMetaEntityDef	GetMetaEntityDef	Retrieves the details of a custom entity definition.
GetProcessDefinition	GetProcessDefinition	Retrieves the approval policy for a given process definition ID.
GetProcessInstance	GetProcessInstance	Retrieves details for a specified approval process instance, including its approval nodes and task list.
GetSecurityStrategy	GetSecurityStrategy	Retrieves the details of a security policy by its ID. This operation requires both DataWorks tenant administrator and security administrator permissions.
GetSkill	GetSkill	Retrieves the details of a specified Skill by name, including the body of the SKILL.md file and the bundle's download link.
ListAgentSessionArtifacts	ListAgentSessionArtifacts	Retrieves a list of artifacts from a specified session.
ListAgentSessions	ListAgentSessions	Retrieves the conversation history for the agent session.
ListAgents	ListAgents	Lists agents for the current tenant and supports filtering by name and pagination.
ListCustomAgents	ListCustomAgents	Retrieves a paginated list of custom agents.
ListCustomAttributes	ListCustomAttributes	Retrieves a list of custom attribute definitions.
ListDataQualityEvaluationTaskInstances	Queries the list of quality monitoring task instances	Performs a paginated query of the quality monitoring task instance list.
ListDataQualityEvaluationTasks	List quality watchtasks	Lists quality monitoring nodes by paging query.
ListDataQualityRuleTemplates	Queries a list of data quality rule templates	Queries a list of data quality rule templates.
ListMcpServers	ListMcpServers	Retrieves a paginated list of MCP servers.
ListMetaEntities	ListMetaEntities	Lists metadata entities. Support is currently limited to custom types.
ListMetaEntityDefs	ListMetaEntityDefs	Retrieves a list of custom entity definitions, including custom entity types and extended table types.
ListMyApplications	ListMyApplications	Lists all resource access requests submitted by the current user.
ListMyRelatedApprovals	ListMyRelatedApprovals	Lists permission requests where the current user is an approver or stakeholder.
ListPendingApprovals	ListPendingApprovals	Retrieves pending permission requests awaiting approval by the current user.
ListProcessDefinitions	ListProcessDefinitions	Queries process definitions of a specified type.
ListSecurityStrategies	ListSecurityStrategies	Retrieves a paginated list of security policies based on specified conditions. This operation requires DataWorks tenant administrator or security administrator permissions.
ListSkills	ListSkills	Lists the Skills in your account.
LoadAgentSession	LoadAgentSession	Loads the message history of an existing session and returns it as an SSE stream. If the session does not exist, the server sends a JSONRPCResponse.error with a code of 400 through the SSE stream. The Content-Type is text/event-stream. Use this operation to restore session context.
PromptAgentSession	PromptAgentSession	Sends a prompt to an existing session and streams the agent response.
StopProcessInstance	StopProcessInstance	Withdraws or terminates a specified process instance.
UpdateCustomAttribute	UpdateCustomAttribute	Updates a custom attribute.
UpdateDataQualityEvaluationTask	Update data quality monitoring	Updates a data quality validation task.
UpdateDataQualityRuleTemplate	Updates a data quality rule template	Updates a data quality rule template.
UpdateMcpServer	UpdateMcpServer	Updates an MCP Server.
UpdateMetaEntity	UpdateMetaEntity	Updates a metadata entity. You can update custom entities or objects of the extended table type, such as databases, tables, and columns.
UpdateMetaEntityDef	UpdateMetaEntityDef	Updates a meta entity definition. This operation supports both custom and extended table entity types.
UpdateProcessDefinition	UpdateProcessDefinition	Updates an existing approval process definition.
UpdateSecurityStrategy	UpdateSecurityStrategy	To modify the configuration of an existing security policy, you must be both a DataWorks tenant administrator and a security administrator.