All Products
Search
Document Center

DataWorks:API overview

Last Updated:Oct 27, 2026

API standards and multilingual preset SDKs

The OpenAPI of this product (dataworks-public/2024-05-18) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Data Agent

API

Title

Description

MCP server management MCP server management
CreateMcpServer Create an MCP server Creates an MCP server.
DeleteMcpServer Delete MCP Server Delete MCP Server
UpdateMcpServer Update an MCP server Updates an MCP server.
GetMcpServer GetMcpServer Returns the details of an MCP Server.
ListMcpServers ListMcpServers Retrieves a paginated list of MCP servers.
Skill management Skill management
CreateSkill Create a skill Creates a skill in DataWorks.
UpdateSkill Update a skill Updates a specified Skill and generates a new version.
DeleteSkill Delete Skill Delete Skill
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.
ListSkills List skills Performs a paging query to list skills under the current account.
Agent management Agent management
CreateAgent Create an agent Creates an agent.
ListCustomAgents List custom agents Lists custom agents with pagination.
DeleteAgent Delete an agent Deletes an Agent.
GetAgent Retrieve agent details Retrieves the details of an agent.
ListAgents Query agent list Queries the list of agents available to the current tenant, with support for filtering by name and pagination.
Agent session management Agent session management
PromptAgentSession Send session prompt Sends a user prompt to an existing session and returns the Agent response in streaming mode.
ReplyAgentSession Reply to session request input Replies to a pending user interaction in a DataAgent session.
LoadAgentSession Load and restore agent session details Loads the historical messages of an existing session and returns them in a Server-Sent Events (SSE) stream. If the session does not exist, a JSONRPCResponse.error with a code of 400 is output through SSE. The Content-Type is text/event-stream. This operation applies to session context restoration scenarios.
ListAgentSessions List sessions Retrieves the conversation history list of agent sessions.
ListAgentSessionArtifacts Query session artifact list Queries the list of artifact files produced by a specified session.
GetAgentSessionTokenUsage GetAgentSessionTokenUsage Retrieves the cumulative AI token usage for a specified session.
GetAgentSessionArtifactMeta GetAgentSessionArtifactMeta Retrieves the metadata and content of an artifact based on a session ID and artifact path.
CreateAgentSession Create an agent session Creates an agent session and returns the session ID.
CancelAgentSession Cancel a session Interrupts the Agent call for a specified session, supporting interruption during streaming responses.

Workspace management

API

Title

Description

Workspaces Workspaces
CreateProject Create a workspace Creates a workspace.
DeleteProject Delete a workspace 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 Get workspace details Queries the details of a DataWorks workspace.
Workspace roles Workspace roles
CreateProjectRole CreateProjectRole Creates a custom role for a workspace.
DeleteProjectRole DeleteProjectRole Deletes a custom role from a workspace.
UpdateProjectRole Update a workspace custom role Updates the permissions of a custom role in a workspace.
GetProjectRole GetProjectRole Queries the details of a workspace role.
ListProjectRoles List workspace role details Queries the details of workspace roles by paging.
Workspace members Workspace members
CreateProjectMember Create a workspace member Adds a workspace member and grants workspace roles to the member.
DeleteProjectMember Remove a workspace member Removes a workspace member and the workspace roles granted to the member.
GrantMemberProjectRoles GrantMemberProjectRoles Assigns roles to members in a workspace.
RevokeMemberProjectRoles Revoke workspace roles from a workspace member Revokes roles from a workspace member.
GetProjectMember GetProjectMember Retrieves the details of a specific member in a Workspace.
ListProjectMembers ListProjectMembers Gets a paginated list of workspace member details.

Data sources

API

Title

Description

UpdateDataSource Update a data source Modifies a specified data source based on the data source ID.
TestDataSourceConnectivity Test the connectivity of a data source Test the connectivity of a data source on a resource group.
CreateDataSource Create a data source Creates a data source in a specified workspace for the development or production environment.
DeleteDataSource DeleteDataSource Deletes a data source by data source ID.
CloneDataSource Clone a data source Clones an existing data source to create a new one.
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 Delete a data source sharing rule Deletes a data source sharing rule by its ID.
ListDataSourceSharedRules List data source sharing rules Retrieves a list of sharing rules for a data source.

Compute resources

API

Title

Description

DeleteComputeResource Delete a compute resource 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 Update a compute resource Modifies a specified compute resource based on the compute resource ID.
ListComputeResources ListComputeResources Queries the list of computing resources that meet the specified business information.
CreateComputeResource Create a compute resource Creates a compute resource in a specified workspace. The compute resource can be used in the development or production environment.
GetComputeResourceAuthUserMappings Retrieve account mappings for compute resources Queries the user mappings for compute resources, supporting EMR and Serverless Spark resource types.
UpdateComputeResourceAuthUserMappings Update compute resource account mapping Updates the account mapping of a compute resource. Currently supports EMR and Serverless Spark resource types.

Resource group management

API

Title

Description

Resource groups Resource groups
CreateResourceGroup Create a resource group Creates a resource group.
DeleteResourceGroup Delete a general-purpose resource group Deletes a general-purpose resource group.
UpdateResourceGroup UpdateResourceGroup Updates basic information about a resource group.
GetResourceGroup Retrieve resource group details by ID Retrieves the details of a specified resource group by ID.
ListResourceGroups List resource groups Retrieves a list of resource groups.
DissociateProjectFromResourceGroup Disassociate a resource group from a workspace Disassociates a resource group from a workspace.
AssociateProjectToResourceGroup Associate a resource group with a workspace 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.
Routes Routes
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 Get route list of a network resource Retrieves the route list of a network resource.
Networks Networks
CreateNetwork CreateNetwork Creates a network and associates the network with a general resource group.
DeleteNetwork Disassociate and delete a network resource from a general-purpose resource group Disassociates and deletes a network resource from a general-purpose resource group.
GetNetwork Retrieve network resource details Retrieves the details of a network resource.
ListNetworks Query network resources in a resource group Queries the network resources in a resource group.

Image management

API

Title

Description

CreateImage Create an image Creates an image.
UpdateImage Update image Updates an image.
RunImageTest Run image test Runs an image test.
ListImageTestResults Retrieve image test results Queries a list of image test results.
GetImageTestResult Retrieve the result of a specified image test task Retrieves the details of an image test result.
CancelImageTest Cancel image test Cancels an image test.
PublishImage Publish an image Publishes an image.
BuildImage Build an image Builds an image.
RollbackImage Roll back an image Rolls back an image.
EnableImage Enable an image Enables an image.
DisableImage Disable an image Disables an image.
GetImage Retrieve image details by ID Retrieves the details of a specified image by image ID.
ListImages Retrieve a list of images Retrieves a list of images.
ListImageVersions Get image version details Gets the details of a specified image version.
DeleteImage Delete an image Deletes an image.
AssociateProjectToImage Associate an image with a workspace Associates an image with a workspace.
DissociateProjectFromImage Disassociate an image from a workspace Disassociates an image from a workspace.
ListImageAssociatedProjects List workspaces associated with an image Lists the workspaces associated with an image.

Data Studio (new version)

API

Title

Description

Snapshots Snapshots
GetSnapshot Retrieve version snapshot details Retrieves the details of a version snapshot.
ListSnapshots Retrieve version snapshot list Retrieves a list of version snapshots.
Components Components
CreateComponent Create a component Creates a component.
DeleteComponent Delete a component Deletes a component.
GetComponent GetComponent Gets component information.
UpdateComponent Update a component Updates components.
ListComponents List components Retrieves a list of components.
Nodes Nodes
CreateNode Create a Data Studio node Creates a Data Studio node in the new version of Data Studio.
DeleteNode Delete a Data Studio node Deletes a specified Data Studio node.
UpdateNode UpdateNode Updates the basic information about a node in Data Studio. This API operation performs an incremental update. The update information is described by using FlowSpec.
MoveNode MoveNode Moves a node to a path in Data Studio.
RenameNode RenameNode Renames a node in Data Studio.
GetNode GetNode Queries the information about a node in Data Studio.
ListNodes List data development nodes Retrieves a list of data development nodes with paging. You can also perform a filtered query on the list by using specified conditions.
ListNodeDependencies Retrieve dependent nodes of a data development node Retrieves the dependent nodes of a specified data development node in a paginated manner.
Workflow definitions Workflow definitions
CreateWorkflowDefinition Create a Data Studio workflow Creates a workflow in a specified directory in Data Studio.
ImportWorkflowDefinition Import a Data Studio workflow Imports a workflow node defined by FlowSpec and its internal child nodes into Data Studio.
DeleteWorkflowDefinition Delete a Data Studio workflow Deletes a specified workflow in Data Studio.
UpdateWorkflowDefinition UpdateWorkflowDefinition Updates the basic information about a workflow in Data Studio. This API operation performs an incremental update. The update information is described by using FlowSpec.
MoveWorkflowDefinition MoveWorkflowDefinition Moves a workflow to a path in Data Studio.
RenameWorkflowDefinition Rename a Data Studio workflow Renames a workflow in Data Studio.
GetWorkflowDefinition Get Data Studio workflow details Queries the information about a workflow.
ListWorkflowDefinitions List data development workflows Queries a paginated list of data development workflows. You can also filter workflows based on specified conditions.
Resources Resources
CreateResource Create a Data Studio file resource Creates a file resource for Data Studio. The file resource information is defined in FlowSpec format.
DeleteResource DeleteResource Deletes a file resource from Data Studio.
UpdateResource Update Data Studio file resource information Updates the basic information about a file resource in Data Studio. This API operation performs an incremental update. The update information is described by using FlowSpec.
GetResource Get Data Studio file resource details Queries the information about a file resource.
ListResources Retrieve data development file resources Retrieves a paginated list of resource files and filters resources.
MoveResource Move Data Studio file resource Moves a specified Data Studio file resource to a specified Data Studio folder.
RenameResource Rename a Data Studio file resource Renames a file resource in Data Studio.
Functions Functions
CreateFunction Create a Data Studio function Creates a UDF function in Data Studio. The UDF function information is described in FlowSpec format.
DeleteFunction DeleteFunction Deletes a user-defined function (UDF) in Data Studio.
UpdateFunction Update Data Studio function information Updates the basic information about a user-defined function (UDF) in Data Studio. This API operation performs an incremental update. The update information is described by using FlowSpec.
MoveFunction Move a Data Studio function Moves a user-defined function (UDF) to a path in Data Studio.
RenameFunction Rename a Data Studio function Renames a user-defined function (UDF) in Data Studio.
GetFunction Get Data Studio function details Queries the information about a user-defined function (UDF) in Data Studio.
ListFunctions List Data Studio functions Retrieves a paginated list of UDF functions in Data Studio. You can also use filter conditions to filter UDF functions.
Deployment workflows Deployment workflows
CreatePipelineRun Create a deployment process Creates a deployment process for an entity in Data Studio.
AbolishPipelineRun Stop a deployment process Calls this operation to change the status of a specified deployment process to terminated. The deployment process is not deleted and can still be queried through query operations.
ExecPipelineRunStage Execute a specified stage of a deployment process Executes a specified stage of a deployment process.
GetPipelineRun Retrieve deployment process details Retrieves the details of a deployment process.
ListPipelineRuns List deployment processes Retrieve a paginated list of deployment processes. You can also filter this list based on specific criteria.
ListPipelineRunItems Get deployment contents Queries the information about deployment objects by deployment process ID.
Personal development environments Personal development environments
ListServerIdeInstances List personal development environment instances Performs a paging query of personal development environment instances. When you invoke this operation, use the DataWorks endpoint that corresponds to the region of the target workspace.
GetServerIdeInstance Query personal development environment instance Queries the details of a specified personal development environment instance.
ListServerIdeImages Query images for personal development environments Queries the list of available images for personal development environments by using paging.
ListServerIdeEcsSpecs Query ECS instance types for personal development environments Queries the list of available ECS instance types for personal development environments.
CreateServerIdeInstance Create a personal development environment instance Creates a personal development environment instance.
UpdateServerIdeInstance Update a personal development environment instance Updates the configuration of a specified personal development environment instance.
StopServerIdeInstance Stop a personal development environment instance Stops a specified personal development environment instance.
StartServerIdeInstance Start a personal development environment instance Starts a specified personal development environment instance.
DeleteServerIdeInstance Delete a personal development environment instance Deletes a specified personal development environment instance.

Data Studio (legacy)

API

Title

Description

Files Files
CreateFile Create a file in dataStudio Creates a file in DataStudio. This operation does not support creating data integration node tasks.
CreateResourceFile Create Resource File Supports users in specifying their own files (such as JAR, PY, archive, or file) to create Data Studio resource files.
CreateUdfFile Create a function file in Data Studio Creates a file for a function in Data Studio.
UpdateFile Update an existing file node Updates an existing file.
UpdateUdfFile Update function file information Updates the file information of a function.
GetFile Obtain the details of a file Retrieves the details of a file.
ListFiles Query file list Queries a list of files by calling ListFiles.
SubmitFile Submit a file to the scheduling system development environment Commits a file to the development environment of the scheduling system to generate a task.
DeployFile Deploy file Deploys a file to the production environment.
Folders Folders
CreateFolder Create a folder Creates a folder.
DeleteFolder Delete a folder in Data Studio Invoke DeleteFolder to delete a folder on the Data Studio page.
UpdateFolder Update folder information Invoke UpdateFolder to update the folder information.
GetFolder Get folder details Queries the information about a folder.
ListFolders Query folder list Queries a list of folders.
Business flows Business flows
CreateBusiness Create a business process Creates a business process in Data Studio for data development.
DeleteBusiness Delete a business process Deletes a workflow.
UpdateBusiness UpdateBusiness Updates a workflow.
GetBusiness Query business flow details Queries the details of a business flow.
ListBusiness ListBusiness Queries a list of workflows.
Deployment packages Deployment packages
GetDeploymentPackage Retrieve deployment package details Retrieves the details of a deployment package.
ListDeploymentPackages Query deployment packages Queries a list of deployment packages.
ListDeploymentPackageFiles Get file versions pending deployment Retrieves the list of file versions pending deployment.
File versions File versions
GetFileVersion Get file version details Retrieves the version details of a file.
ListFileVersions Query file versions Queries the version list of a file.
Extension point events Extension point events
UpdateIDEEventResult Update the check result of an extension point event Reports the check result of an extension point event message through a callback.
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.
Tables Tables
EstablishRelationTableToBusiness EstablishRelationTableToBusiness Imports a table to a workflow. Calling this operation is equivalent to right-clicking a workflow on the Data Studio page and selecting Import Table.

Data Integration

API

Title

Description

Synchronization tasks Synchronization tasks
CreateDIJob Create a data integration synchronization task Creates a task in the new version of Data Integration.
UpdateDIJob UpdateDIJob Update a Data Integration task.
DeleteDIJob DeleteDIJob Deletes a new-version synchronization task.
StopDIJob Stop a data integration sync task Aborts a data integration task.
StartDIJob StartDIJob Starts a new-version synchronization task.
GetDIJob View data integration synchronization task configuration details Queries the details of a data integration task.
GetDIJobLog View the run logs of a data integration synchronization task Retrieves the logs of a data integration task.
ListDIJobs List Data Integration synchronization task configurations Lists new-version Data Integration tasks, including real-time database synchronization tasks, batch database synchronization tasks, and real-time single-table synchronization tasks.
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 alerts Task alerts
CreateDIAlarmRule Create an alert rule for a data integration synchronization task Creates an alert rule for a data integration 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

Semantic analysis Semantic analysis
ListSemanticJobs List semantic jobs Queries the semantic node definitions of the current tenant with paging. The Name, ProjectId, and Source fields in the list items can be used for running/deleting nodes, querying run details, and verifying input scope, respectively.
CreateSemanticJob Create a semantic job Saves a reusable semantic job definition. If you use a single-file source, apply for and complete the attachment upload first. After creation, call RunSemanticJob with the returned Name.
DeleteSemanticJob Delete a semantic job Deletes a semantic job definition by the Name of a created job. If the job is currently running, call KillSemanticJob with the ExecutorJobId of that run and confirm the stop before deletion.
DownloadSemanticResults Get semantic job result download URL Returns the download URL of artifacts by job name and an optional run ID after a run completes. If JobRunId is not specified, the results of the most recent run of the job are returned.
GetSemanticJobDetail Query semantic job run details Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.
RunSemanticJob Run a semantic job Submits a saved semantic job for execution by name and returns the run and executor identifiers. A successful call indicates that the job has been submitted, not that the semantic model results have been generated.
ListSemanticJobRuns Query semantic job run records Queries the run records of a created node by Name with paging. The JobRunId in each record is active for retrieving the results of a specific run, and the ExecutorJobId is active for querying details, retrieving logs, or stopping the run.
GetSemanticJobLog Query semantic job run logs Queries execution logs by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. The current POP contract exposes only the task and workspace identifiers and returns default log segments.
KillSemanticJob Stop a semantic job run Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A successful call indicates only that the stop request has been accepted. Query the final status by calling GetSemanticJobDetail.
UploadSemanticFile Request an upload URL for semantic task attachments Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires, then pass the returned FileId to the ReferenceFileIds parameter of CreateSemanticJob.
Custom properties Custom properties
ListCustomAttributes List custom attributes Queries the list of custom attribute definitions.
GetCustomAttribute GetCustomAttribute Retrieves a custom attribute definition.
CreateCustomAttribute Create a custom attribute Creates a custom attribute definition.
UpdateCustomAttribute UpdateCustomAttribute Updates a custom attribute.
DeleteCustomAttribute DeleteCustomAttribute Deletes a custom attribute definition.
Custom metadata entity definitions Custom metadata entity definitions
ListMetaEntityDefs Query metadata entity definition list Queries the list of custom entity definitions, including custom entity types and extension table types.
GetMetaEntityDef GetMetaEntityDef Retrieves the details of a custom entity definition.
CreateMetaEntityDef Create a metadata entity type definition Creates a metadata entity definition, including custom types and extended table types.
UpdateMetaEntityDef Update metadata entity definition Updates a metadata entity definition, including custom entity types and extension table types.
DeleteMetaEntityDef Delete a metadata entity definition Deletes a metadata entity definition, including custom entity types and extension table types.
Metadata collectors Metadata collectors
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.
GetCrawlerTypeCapabilities Query crawler type capabilities Queries the crawler types supported in the current region, along with their collection scope, scheduling, and extension configuration capabilities.
CreateCrawler Create a metadata crawler Creates a metadata crawler and configures the data source, collection scope, resource group, and scheduling method.
ListCrawlers List metadata crawlers Queries metadata crawlers by paged query, and supports filtering by workspace, data source, type, environment, owner, and name.
GetCrawler Query metadata crawler details Queries the configuration, status, and latest run information of a specified metadata crawler.
UpdateCrawler Update a metadata crawler Updates the resource group, collection scope, scheduling, and extension configurations of a specified metadata crawler.
RunCrawler Run a metadata crawler Triggers a specified metadata crawler to run and returns the acceptance status and associated task instance information.
StopCrawler Stop a metadata crawler run Stops the currently running task of a specified metadata crawler.
ListCrawlerRuns Query crawler run records Queries the run records of a specified metadata crawler by paging, with optional filtering by time range and run status.
DeleteCrawler Delete a metadata crawler Deletes a specified metadata crawler.
Metadata entities Metadata entities
Custom entities Custom entities
ListMetaEntities Query metadata entity list Queries a list of metadata entities. Currently, only custom entity types are supported.
GetMetaEntity GetMetaEntity Retrieves metadata entity details. Currently, only pure custom entity types are supported.
BatchCreateMetaEntities Batch create metadata entities Creates metadata entities in batches. All entities in the same batch must be of the same type. Currently, only custom entity types and extension table types (corresponding to Database/Table) are supported.
UpdateMetaEntity UpdateMetaEntity Updates a metadata entity. You can update custom entities or objects of the extended table type, such as databases, tables, and columns.
BatchDeleteMetaEntities Batch delete metadata entities Deletes metadata entity objects in batches. Supports deleting custom entities and extension table type objects (Database/Table). Does not support deleting columns individually. You can delete associated Column objects by deleting the Table.
Data catalogs Data catalogs
ListCatalogs List data catalogs in Data Map 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 Retrieve data catalog details in dataWorks data map Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks types are supported.
Databases Databases
ListDatabases List databases in Data Map 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 only in the Internal Catalog. For other types of data sources, you can call this API operation to query databases in an instance or cluster.
GetDatabase Get database details in Data Map Queries the information about a specific database in Data Map.
Schemas Schemas
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 Get database schema information in Data Map Retrieves the details of a specified schema in Data Map. Only MaxCompute and Hologres schemas are supported.
Tables Tables
ListTables List data tables in dataWorks data map Queries a list of data tables in DataWorks Data Map. For data source types that do not support the schema level, this operation queries data tables in a specified database. For data source types that support the schema level, this operation queries data tables in a specified database, MaxCompute project, or schema. The response includes only basic information about the data tables and excludes technical and business metadata. For non-MaxCompute data sources, the response is not real-time and may be delayed by up to one hour compared to the metadata collection results.
GetTable Retrieve table details in dataWorks data map Queries the details of a specified table in DataWorks Data Map. You can choose whether to return business metadata.
UpdateTableBusinessMetadata Update business metadata of a data map table Updates the business metadata of a table in Data Map. Currently, only the table usage description and custom attributes can be updated.
SubmitBatchChangeTableOwner Batch update table owner Submits a batch request to transfer table ownership.
GetBatchChangeTableOwnerStatus Retrieve batch table owner transfer status Queries the status of a batch table owner transfer task.
Columns Columns
ListColumns Query table columns in DataWorks Data Map Queries the columns of a specified table in DataWorks Data Map.
GetColumn Retrieve column information for a data map table Retrieves the details of a specified column in a Data Map table.
UpdateColumnBusinessMetadata UpdateColumnBusinessMetadata Updates the business metadata for a column in a data map. This operation can only update the business description and custom attributes.
Datasets Datasets
ListDatasets List datasets Queries a list of datasets. Currently, DataWorks datasets and PAI datasets are supported.
GetDataset GetDataset Gets the details of a dataset.
CreateDataset Create a dataset Creates a dataset. You can create a dataset only in a workspace that you have joined. Only DataWorks datasets are supported. The maximum number of datasets per tenant is 2000.
UpdateDataset Update a dataset 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 Delete a dataset Deletes a dataset. Only DataWorks datasets are supported. The corresponding dataset versions are cascade deleted. The operator must be the creator of the dataset or an administrator of the workspace to which the dataset belongs.
Dataset versions Dataset versions
ListDatasetVersions ListDatasetVersions Retrieves the version list for a given dataset.
GetDatasetVersion GetDatasetVersion Gets information for a given dataset version.
CreateDatasetVersion Create a dataset version Creates a dataset version. Currently, only DataWorks datasets are supported. The maximum number of versions is 20.
UpdateDatasetVersion UpdateDatasetVersion Updates dataset version information. Only DataWorks datasets are supported. Requires dataset creator or workspace administrator permissions.
DeleteDatasetVersion Delete a dataset version Deletes a dataset version. Only non-v1 DataWorks dataset versions can be deleted by using this operation. To delete a v1 dataset version, use the DeleteDataset operation. The operator must be the creator of the dataset or an administrator of the workspace to which the dataset belongs.
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
Partitions Partitions
ListPartitions Query partitions of a data map table Queries the partition list of a specified table in DataWorks Data Map. Currently supports MaxCompute and HMS (EMR cluster) types.
GetPartition Get table partition details in Data Map Retrieves partition details for a data map table. Currently supports MaxCompute and HMS (EMR cluster) types only.
Lineage Lineage
ListLineageRelationships Query data lineage relationships in DataWorks Data Map Queries the list of data lineage relationships between two given entities (such as tables, fields, or OSS files) in DataWorks Data Map.
GetLineageRelationship Retrieve a lineage relationship in dataWorks data map Retrieves the details of a specified lineage relationship in DataWorks Data Map.
DeleteLineageRelationship Delete a data lineage relationship Deletes a specified data lineage relationship from DataWorks Data Map.
CreateLineageRelationship Register data lineage relationship in data map Registers a data lineage relationship in DataWorks Data Map. You can use this operation to establish lineage relationships between metadata entities managed by DataWorks, including table-to-table, column-to-column, table-to-column, and dataset-to-table scenarios. You can also establish lineage relationships between managed entities and custom entity objects registered by users. This operation is compatible with non-managed custom objects, but this approach is no longer recommended. Before calling this operation, make sure that the managed entities involved in the lineage registration already exist on the DataWorks platform.
ListLineages Query lineage entities for a Data Map entity Queries the upstream and downstream lineage entities for a specified entity in Data Map, with an option to include detailed lineage relationship information.
Metadata collections Metadata collections
ListMetaCollections Query data map collection list Queries the list of Data Map collections. Supports querying both Data Map 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 Get Data Map collection information 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 List entities in a Data Map collection Queries a list of entities in a collection in Data Map. Collections include categories and data albums. Entities can only be tables.
AddEntityIntoMetaCollection Add an entity object to a data map collection Adds a specified entity object to a Data Map collection. The collection object can be a Data Map category or a data album. The entity object currently supports only the data table type. To add an entity to a data album, the caller must have the AliyunDataWorksFullAccess permission, or be the creator or administrator of the album.
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

Scheduling calendars Scheduling calendars
UpdateCalendar Update a scheduling calendar Updates a scheduling calendar. This is a full update that requires you to submit the complete editable configuration.
ListCalendarVersions List scheduling calendar versions Queries the versions of a specified scheduling calendar.
ListCalendars List scheduling calendars Queries a list of scheduling calendars.
GetCalendar Retrieve a specified scheduling calendar Retrieves the current configuration of a specified scheduling calendar.
DeleteCalendar Delete a scheduling calendar Deletes a scheduling calendar.
CreateCalendar Create a scheduling calendar Creates a scheduling calendar.
Parameters Parameters
CreateParameter Create a parameter Creates a parameter.
DeleteParameter Delete a parameter Deletes a specified parameter.
UpdateParameter Update a parameter Updates a parameter. This operation performs an incremental update and modifies only the specified fields.
RollbackParameter Roll back a parameter Rolls back a specified parameter.
GetParameter GetParameter Gets the details of a parameter by its ID.
ListParameters Retrieve parameter list Queries the list of query parameters.
ListParameterVersions List parameter versions Lists parameter versions.
Monitoring and alerting Monitoring and alerting
ListAlertRules ListAlertRules Queries a list of custom monitoring alert rules.
GetAlertRule Retrieve a custom monitoring alert rule Retrieves a custom monitoring alert rule.
UpdateAlertRule UpdateAlertRule Updates the information about a custom alert monitoring rule.
DeleteAlertRule Delete a custom rule Deletes a custom monitoring alert rule.
CreateAlertRule Create a custom monitoring alert rule Creates a custom monitoring alert rule.
Tasks Tasks
GetUpdateTaskResult Get the result of an update node task Queries the result of asynchronously creating a workflow instance.
UpdateTaskAsync Asynchronously update a node Asynchronously updates a specified node and syncs the changes to Data Studio as a new saved version.
DeleteTask Delete a task Deletes a specified task.
UpdateTask Update a node Updates a specified node. The modifications are synchronized to Data Studio, where a new saved version is created.
BatchUpdateTasks Batch update nodes Updates multiple nodes in batches by using incremental updates.
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 Retrieve operation logs for a task Queries a paginated list of operation logs for a specified 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 Retrieve task instance details Retrieves the details of a specified task instance.
GetTaskInstanceLog GetTaskInstanceLog Queries the run log generated during a specific run of an instance.
ListTaskInstances List task instances Retrieves a paged list of task instances. You can also perform a filtered query based on conditions.
ListUpstreamTaskInstances List upstream instances Retrieves the upstream instances of a specified instance by page.
ListTaskInstanceOperationLogs List task instance operation logs Retrieves a paginated list of operation logs for a task instance.
ListDownstreamTaskInstances List downstream instances Retrieves a paginated list of downstream instances for a specified instance.
SuspendTaskInstances SuspendTaskInstances Suspends multiple instances at a time.
ResumeTaskInstances ResumeTaskInstances Resumes multiple suspended instances at a time.
StopTaskInstances Stop task instances Stops multiple task instances.
SetSuccessTaskInstances SetSuccessTaskInstances Sets the statuses of multiple instances to successful at a time.
RerunTaskInstances Rerun node instances Reruns multiple node instances in a batch.
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.
Workflows Workflows
DeleteWorkflow Delete a workflow Deletes a specified 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 Reruns a workflow instance.
CreateWorkflowInstances Create a workflow instance Creates a workflow instance based on configurations, such as a data backfill workflow instance.
GetCreateWorkflowInstancesResult GetCreateWorkflowInstancesResult Queries the result of asynchronously creating a workflow instance.
GetWorkflowInstance GetWorkflowInstance Queries the information about a workflow instance.
ListWorkflowInstances List workflow instances Retrieves a list of workflow instances by using paging. You can also perform a filtered query based on conditions.
StartWorkflowInstances Start workflow instances Starts multiple workflow instances in a batch.
StopWorkflowInstances Terminate workflow instances Terminates multiple workflow instances in batches.
ExecuteAdhocWorkflowInstance Run a temporary workflow instance Creates a temporary workflow instance based on the specified configurations.

Data Quality

API

Title

Description

Data quality rule templates Data quality rule templates
CreateDataQualityTemplate Create a data quality rule template Creates a data quality rule template in a specified project.
UpdateDataQualityTemplate Update a data quality rule template Updates a data quality rule template in a project
ListDataQualityTemplates List data quality rule templates Queries the list of data quality rule templates in a specified 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 monitoring Data quality monitoring
CreateDataQualityScan CreateDataQualityScan Creates a data quality monitor.
UpdateDataQualityScan Update a data quality monitor Updates a data quality monitor.
ListDataQualityScans List data quality scan tasks 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.
Alert rules Alert rules
CreateDataQualityAlertRule Create a data quality alert rule Creates a data quality monitoring alert rule in a specified project.
UpdateDataQualityAlertRule Update a data quality alert rule Updates a specified data quality monitoring alert rule.
ListDataQualityAlertRules List data quality alert rules 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 Delete a data quality alert rule Deletes a data quality monitoring alert rule based on the specified ID.
Data quality runs Data quality runs
CreateDataQualityScanRun Create a data quality scan run Triggers the execution of a specified data quality monitoring task and returns the run instance ID.
ListDataQualityScanRuns Query data quality scan run records Queries the data quality scan run records of a specified project.
GetDataQualityScanRunLog Get data quality scan run logs Queries the log content of a specified data quality monitoring task instance.
GetDataQualityScanRun GetDataQualityScanRun Queries the run details of a data quality scan task by its ID.

Security Center

API

Title

Description

Permission requests and approvals Permission requests and approvals
ApplyResourceAccessPermission Submit a resource access permissions request Commits an access permissions request for specific resources.
StopProcessInstance StopProcessInstance Withdraws or terminates a specified process instance.
ApproveProcessInstance Approve a workflow instance Approves or rejects a specified approval process instance.
GetApplicationContents Get Resource Permission Application Details Queries the content of resource permission applications under the specified process instance ID.
GetProcessInstance GetProcessInstance Retrieves details for a specified approval process instance, including its approval nodes and task list.
ListPendingApprovals Query Pending Permission Request Orders Retrieves the list of pending permission request orders for which the current user is the approver.
ListMyRelatedApprovals Query permission application orders related to me Query all permission application orders where the current user is an approver or stakeholder.
ListMyApplications Query Permission Application Orders Initiated by Me Queries all resource access permission application orders initiated by the current user.
Query result control policies Query result control policies
CreateSecurityStrategy Create a security policy Creates a new security control policy and supports the configuration of multiple modules and submodules. Requires the permissions of a DataWorks tenant administrator and a security administrator.
DeleteSecurityStrategy Delete a security policy Deletes a security strategy by its ID. To call this operation, you must have DataWorks tenant administrator and security administrator permissions.
UpdateSecurityStrategy UpdateSecurityStrategy To modify the configuration of an existing security policy, you must be both a DataWorks tenant administrator and a security administrator.
GetSecurityStrategy Retrieve security policy details Retrieves the details of a security policy based on the provided security policy ID.
ListSecurityStrategies Retrieve security policies by page Retrieves a paginated list of security policies in the system based on specified conditions. This operation requires DataWorks tenant administrator and security administrator permissions.
FindBestMatchSecurityStrategy Match the best security policy Queries the best-matching security policy based on specified conditions.
Approval policies Approval policies
CreateProcessDefinition Create an approval process definition Creates a new approval process definition, supporting custom configuration of approval rules and notification services.
DeleteProcessDefinition DeleteProcessDefinition Deletes a process definition by the specified ID.
EnableProcessDefinition EnableProcessDefinition Enables a process definition with the specified ID.
DisableProcessDefinition DisableProcessDefinition Disables the specified approval process definition.
UpdateProcessDefinition UpdateProcessDefinition Updates an existing approval process definition.
GetProcessDefinition GetProcessDefinition Retrieves the approval policy for a given process definition ID.
ListProcessDefinitions ListProcessDefinitions Queries process definitions of a specified type.
CreateIdentifyCredential Create an identity credential Creates an identity credential.

Tag management

API

Title

Description

CreateDataAssetTag Create a tag Creates a tag.
DeleteDataAssetTag DeleteDataAssetTag Deletes a tag.
UpdateDataAssetTag Update a label Updates a label.
ListDataAssetTags List tags Queries a list of tags.
TagDataAssets Attach data asset tags Attaches tags to data assets.
UnTagDataAssets Disassociate tags from data assets Disassociates tags from data assets.
ListDataAssets List assets associated with tags Performs a paging query on DataWorks data assets associated with tags.

Open Platform

API

Title

Description

GetJobStatus Get asynchronous API running status Returns the status of an asynchronous task. After calling an asynchronous API, poll this API to obtain the success status.

Others

API

Title

Description

ListDataQualityEvaluationTasks List quality monitoring tasks Queries a paginated list of quality monitoring tasks.
ListDataQualityRules List quality rules Queries quality monitoring rules by paging.
ListDataQualityEvaluationTaskInstances Queries the list of quality monitoring task instances Performs a paginated query of the quality monitoring task instance list.
ListDataQualityResults Query data quality results Queries a list of data quality results by using paging.
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.
DeleteDataQualityEvaluationTask Delete a data quality monitor Deletes a data quality monitoring task.
GetDataQualityEvaluationTaskInstance Retrieve data quality check task instance details Retrieves the details of a data quality check task instance.
GetDataQualityEvaluationTask Query data quality monitoring details Query the details of a data quality validation task.
AttachDataQualityRulesToEvaluationTask Associate data quality rules with quality monitoring Associates data quality rules with a data quality check task.
UpdateDataQualityEvaluationTask Update data quality monitoring Updates a data quality check task.
CreateDataQualityEvaluationTaskInstance Create a data quality check monitoring instance Creates a data quality check task instance.
CreateDataQualityEvaluationTask Create data quality monitoring Creates a DataWorks data quality monitoring task.
DeleteDataQualityRule DeleteDataQualityRule Deletes a data quality monitoring rule.
UpdateDataQualityRuleTemplate Updates a data quality rule template Updates a data quality rule template.
CreateDataQualityRuleTemplate Create a quality rule template Creates a rule template.
DeleteDataQualityRuleTemplate Delete a custom data quality rule template Deletes a custom data quality rule template.
GetDataQualityRuleTemplate Queries the details of a data quality rule template Queries the details of a data quality rule template.
CreateDataQualityRule Create a quality rule Creates a quality rule.
UpdateDataQualityRule Update a quality rule Updates a quality rule.
GetDataQualityRule Query data quality rule details Queries the details of a data quality rule.
ListDataQualityRuleTemplates List data quality rule templates Queries a list of data quality rule templates.
DeleteCertificate Delete a certificate file Deletes a certificate file.
GetCertificate View a certificate file Retrieves a certificate file.
GetDataSource View data source details Queries a specified data source by data source ID.
ImportCertificate Import an authentication file Imports a certificate file.
ListCertificates ListCertificates Retrieves a list of certificate files.
DeleteFile Delete a file from Data Studio Deletes a file from Data Studio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process.
GetWorkflow GetWorkflow Queries the information about a workflow.
ListWorkflows List workflows Retrieves a list of workflows with paging, and supports filtered query by conditions.
UpdateWorkflow Update a workflow Updates a specified workflow by using the full update method. Fields that can be synchronously updated to Data Studio include: owner, data source, schedule resource group, description, and trigger run mode (Normal, Skip, or Pause).
AbolishCrossProjectPipelineRun Stop a cross-workspace publish flow Stops a cross-workspace publish flow.
CreateCrossProjectPipelineRun Create a cross-workspace deployment flow Creates a cross-workspace deployment flow.
ExecCrossProjectPipelineRun Execute a cross-workspace deployment flow Executes a cross-workspace deployment flow.
GetCrossProjectPipelineRun Query cross-workspace deployment flow details Queries the details of a cross-workspace deployment flow.
ListCrossProjectDeploymentCandidates Query cross-workspace deployment candidate objects Queries cross-workspace deployment candidate objects.
ListCrossProjectDeploymentEnvironments Query cross-workspace deployment environments Queries cross-workspace deployment environments.
ListCrossProjectPipelineRunItems Query cross-workspace publish pipeline items Queries the publish items of a cross-workspace publish pipeline.
ListCrossProjectPipelineRuns Query cross-workspace publish flows Queries the list of cross-workspace publish flows.
UpdateAgentSessionTitle Modify agent session title Modifies the title of an agent session accessible to the current identity without changing the task execution status.