API standard and pre-built SDKs in multi-language
This product (dataworks-public/2024-05-18) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
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.
Authentication File Management
| API | Title | Description |
|---|---|---|
| ImportCertificate | ImportCertificate | Imports a certificate file. |
| GetCertificate | GetCertificate | Queries a certificate file. |
| ListCertificates | ListCertificates | Queries a list of certificate files. |
| DeleteCertificate | DeleteCertificate | Deletes a certificate file. |
Space Management
| API | Title | Description |
|---|---|---|
| Workspace | Workspace | |
| CreateProject | CreateProject | Creates a workspace. |
| UpdateProject | UpdateProject | Updates a DataWorks workspace. |
| DeleteProject | DeleteProject | Deletes a DataWorks workspace. |
| GetProject | GetProject | Queries the information about a DataWorks workspace. |
| ListProjects | ListProjects | Queries a list of DataWorks workspaces of the tenant to which your account belongs. |
| Workspace Role | Workspace Role | |
| GetProjectRole | GetProjectRole | Queries the information about a role in a DataWorks workspace. |
| ListProjectRoles | ListProjectRoles | Queries the information about roles in a DataWorks workspace by page. |
| 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 | Queries the details about a member in a workspace. |
| ListProjectMembers | ListProjectMembers | Queries details about members in a workspace. |
Data Source
| API | Title | Description |
|---|---|---|
| TestDataSourceConnectivity | TestDataSourceConnectivity | Tests the connectivity between a data source and a resource group. |
| CreateDataSource | CreateDataSource | Adds a data source to the development environment or production environment of a workspace. |
| DeleteDataSource | DeleteDataSource | Removes a data source by ID. |
| UpdateDataSource | UpdateDataSource | Modifies a data source by ID. |
| CloneDataSource | CloneDataSource | Clones an existing data source. |
| GetDataSource | GetDataSource | Queries a data source by ID. |
| ListDataSources | ListDataSources | Queries a list of data sources based on the business information of data sources. |
| Data Source Sharing Rules | Data Source Sharing Rules | |
| CreateDataSourceSharedRule | CreateDataSourceSharedRule | Creates a rule for sharing a data source to other workspaces or RAM users. |
| DeleteDataSourceSharedRule | DeleteDataSourceSharedRule | Deletes a sharing rule of a data source by ID. |
| ListDataSourceSharedRules | ListDataSourceSharedRules | Queries a list of sharing rules of a data source. |
Computing Resource
| API | Title | Description |
|---|---|---|
| DeleteComputeResource | DeleteComputeResource | Deletes the specified computing resource based on the computing resource ID. |
| DeleteComputeResource | DeleteComputeResource | |
| 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 serverless resource group. |
| DeleteResourceGroup | DeleteResourceGroup | Deletes a serverless 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 | Queries a list of resource groups. |
| DissociateProjectFromResourceGroup | DissociateProjectFromResourceGroup | Disassociates a resource group from a workspace. |
| AssociateProjectToResourceGroup | AssociateProjectToResourceGroup | Associates a resource group with a workspace. |
| ListResourceGroupAssociateProjects | ListResourceGroupAssociateProjects | Gets the list of workspaces bound to a resource group. |
| 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 | Queries a list of routes of 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 | Queries a list of network resources of a serverless resource group. |
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 | Queries a list of nodes in DataStudio. You can also specify filter conditions to query specific nodes. |
| ListNodeDependencies | ListNodeDependencies | Queries a list of descendant nodes of a node in DataStudio. |
| 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. |
| DeleteResource | DeleteResource | |
| 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. |
| MoveResource | MoveResource | Moves a file resource to a path in DataStudio. |
| RenameResource | RenameResource | Renames a file resource in DataStudio. |
| 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. |
| 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. |
| UpdateFunction | UpdateFunction | |
| 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 | Queries the information about a process for deploying or undeploying an entity. |
| ListPipelineRuns | ListPipelineRuns | Queries a list of processes that are used to deploy or undeploy entities in DataStudio. You can also specify filter conditions to query specific processes. |
| 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 | CreateResourceFile | Creates a resource file in DataStudio. The following types are supported: JAR, Archive, File, and Python. |
| CreateUdfFile | CreateUdfFile | Creates a file for a function in DataStudio. |
| DeleteFile | DeleteFile | Deletes a file from DataStudio. 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. |
| UpdateFile | UpdateFile | Updates a file. |
| UpdateUdfFile | UpdateUdfFile | Updates the file information about a function. |
| GetFile | GetFile | Queries the information about 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 | |
| Folder | Folder | |
| CreateFolder | CreateFolder | Creates a folder. |
| DeleteFolder | DeleteFolder | |
| UpdateFolder | UpdateFolder | |
| 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 | GetFileVersion | Queries the information about a file version. |
| 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 | Creates a new-version synchronization task. |
| UpdateDIJob | UpdateDIJob | Updates a synchronization 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 | Queries the information about a synchronization task. |
| GetDIJobLog | GetDIJobLog | Obtains logs generated for a synchronization task. |
| ListDIJobs | ListDIJobs | Queries a list of new-version synchronization tasks in Data Integration. A new-version synchronization task can be a real-time synchronization task used to synchronize full or incremental data in a database, a batch synchronization task used to synchronize full or incremental data in a database, or a real-time synchronization task used to synchronize incremental data in a single table. |
| 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. |
| Schema | Schema | |
| ListSchemas | ListSchemas | Queries a list of schemas in a database or a MaxCompute project in Data Map. Only schemas of the MaxCompute and Hologres metadata crawler types are supported. |
| GetSchema | GetSchema | Queries the information about a schema in Data Map. You can call this API operation to query the information only about MaxCompute and Hologres schemas. |
| Table | Table | |
| ListTables | ListTables | Queries a list of tables in Data Map. For data source types that do not support schemas, you can call this API operation to query a list of tables in a specific database. For data source types that support schemas, you can call this API operation to query a list of tables in a specific database, MaxCompute project, or schema. Only the basic information about tables is returned. The information about technical metadata and business metadata is not returned. |
| GetTable | GetTable | Queries the information about a specific table in Data Map. |
| UpdateTableBusinessMetadata | UpdateTableBusinessMetadata | Updates the business metadata of a table in Data Map. Currently, only the usage notes of a table can be updated. |
| Column | Column | |
| ListColumns | ListColumns | Queries a list of fields in a data 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 of a column in a table in Data Map. Only the business description of a column can be updated. |
| 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 lineage between two entities, such as tables, fields, and Object Storage Service (OSS) files, in Data Map. |
| GetLineageRelationship | GetLineageRelationship | Queries the information about a lineage in Data Map. |
| DeleteLineageRelationship | DeleteLineageRelationship | Deletes a lineage in Data Map. |
| CreateLineageRelationship | CreateLineageRelationship | Creates a lineage between a source entity and a destination entity. Either the source or destination entity must be a custom entity. |
| ListLineages | ListLineages | Queries a list of ancestor and descendant entities of an entity in Data Map. You can specify whether to return the lineage between the entities. |
| 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 | UpdateMetaCollection | Updates the information about a collection in Data Map, including the collection name, description, and administrator. Collections include categories and data albums. If you want to update the information about a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator. |
| DeleteMetaCollection | DeleteMetaCollection | Deletes a collection in Data Map. Collections include categories and data albums. If you want to delete a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator. |
| 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 | RemoveEntityFromMetaCollection | Removes an entity from a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to remove an entity from a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator. |
Operation Center
| API | Title | Description |
|---|---|---|
| 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 | Queries a list of operation logs of a task by page. |
| Task Instances | Task Instances | |
| UpdateTaskInstances | UpdateTaskInstances | Modifies properties configured for multiple instances at a time. The properties include the priority, resource group for scheduling, and data source. |
| 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 | Queries a list of operation logs of an instance by page. |
| 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. |
| UpdateWorkflow | UpdateWorkflow | Updates a specified workflow in full update mode. |
| GetWorkflow | GetWorkflow | Queries the information about a workflow. |
| ListWorkflows | ListWorkflows | Queries a list of workflows by page. You can also specify filter conditions to query workflows. |
| Workflow Instances | Workflow Instances | |
| GetRerunWorkflowInstancesResult | GetRerunWorkflowInstancesResult | Query the result of asynchronous workflow instance reruns. |
| RerunWorkflowInstances | RerunWorkflowInstances | Reruns workflow instances. |
| 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 | Queries a list of workflow instances by page. You can also specify filter conditions to query workflow instances. |
| StartWorkflowInstances | StartWorkflowInstances | Starts multiple workflow instances at a time. |
| 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 | Queries the details of a data quality rule template by 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 | Queries the details of a data quality monitoring and alerting rule by alert rule ID. |
| DeleteDataQualityAlertRule | DeleteDataQualityAlertRule | Deletes a data quality alert rule by ID. |
| Data Quality ScanRun | Data Quality ScanRun | |
| CreateDataQualityScanRun | CreateDataQualityScanRun | Triggers a data quality monitoring task and returns the run instance ID. |
| ListDataQualityScanRuns | ListDataQualityScanRuns | Queries the execution records of data quality scans in a 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. |