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 | CreateMcpServer | Creates an MCP Server. |
| DeleteMcpServer | Delete MCP Server | Delete MCP Server |
| UpdateMcpServer | UpdateMcpServer | 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 | |
| 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 | ListSkills | Lists the Skills in your account. |
| Agent management | Agent management | |
| CreateAgent | Create Agent | Create Agent |
| ListCustomAgents | ListCustomAgents | Retrieves a paginated list of custom agents. |
| GetAgent | GetAgent | Retrieves agent details by name. |
| ListAgents | ListAgents | Lists agents for the current tenant and supports filtering by name and pagination. |
| Agent session management | Agent session management | |
| PromptAgentSession | PromptAgentSession | Sends a prompt to an existing session and streams the agent response. |
| 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. |
| ListAgentSessions | ListAgentSessions | Retrieves the conversation history for the agent session. |
| ListAgentSessionArtifacts | ListAgentSessionArtifacts | Retrieves a list of artifacts from 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 | CreateAgentSession | Creates a new agent session and returns a session ID. |
| CancelAgentSession | CancelAgentSession | Cancels an agent call in a specified session. This operation also supports interrupting an ongoing streaming response. |
Workspace 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 rule | Data source sharing rule | |
| 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. |
Compute 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. |
| Route | Route | |
| 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 (new version)
|
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 | Import a dataStudio workflow | Imports a workflow node defined by FlowSpec and its child nodes into 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. |
| Publish process | Publish process | |
| CreatePipelineRun | Create a publish process | Creates a publish process for an entity in the new-version DataStudio. |
| 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 (legacy)
|
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 process | Business process | |
| 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. |
| Publish package | Publish 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. |
| Extension point event | Extension point 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 |
| Custom property | Custom property | |
| ListCustomAttributes | ListCustomAttributes | Retrieves a list of custom attribute definitions. |
| GetCustomAttribute | GetCustomAttribute | Retrieves a custom attribute definition. |
| CreateCustomAttribute | CreateCustomAttribute | Creates a custom attribute definition. |
| UpdateCustomAttribute | UpdateCustomAttribute | Updates a custom attribute. |
| DeleteCustomAttribute | DeleteCustomAttribute | Deletes a custom attribute definition. |
| Custom metadata entity definition | Custom metadata entity definition | |
| ListMetaEntityDefs | ListMetaEntityDefs | Retrieves a list of custom entity definitions, including custom entity types and extended table types. |
| GetMetaEntityDef | GetMetaEntityDef | Retrieves the details of a custom entity definition. |
| CreateMetaEntityDef | CreateMetaEntityDef | Creates a metadata entity definition. The definition can be for a pure custom type or an extended table type. |
| UpdateMetaEntityDef | UpdateMetaEntityDef | Updates a meta entity definition. This operation supports both custom and extended table entity types. |
| 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 | |
| Custom entity | Custom entity | |
| ListMetaEntities | ListMetaEntities | Lists metadata entities. Support is currently limited to custom types. |
| GetMetaEntity | GetMetaEntity | Retrieves the details of a custom entity. |
| 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. |
| 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 | 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. |
| Data catalog | Data 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. |
| Database | Database | |
| 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 | 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. |
| Data table | Data table | |
| ListTables | Query data tables in data map | Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata. |
| GetTable | Get data table details in data map | Retrieves the details of a specified data table in DataWorks Data Map. You can specify whether to return business metadata. |
| 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. |
| Field | Field | |
| ListColumns | Query columns of a data table in data map | Queries the column list of a specified data table in DataWorks Data Map. |
| GetColumn | Get data map table column information | 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. |
| 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 | Lineage | |
| 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 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 | ListLineages | Queries the upstream and downstream entities for a specified entity in Data Map. You can optionally include detailed lineage relationship information. |
| Metadata collection | Metadata 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. |
O&M 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 and alerting | Monitoring and alerting | |
| 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. |
| Node | Node | |
| DeleteTask | DeleteTask | Deletes a task. |
| UpdateTask | Update a node | Updates a specified node. The modifications are synchronized to DataStudio, where a new saved version is created. |
| 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. |
| Node instance | Node instance | |
| 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 | 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. |
| Workflow | Workflow | |
| DeleteWorkflow | DeleteWorkflow | Deletes a workflow. |
| Workflow instance | Workflow instance | |
| 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 rule template | Data quality rule 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 monitoring | Data quality monitoring | |
| 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. |
| Alert rule | Alert rule | |
| 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 run | Data quality run | |
| 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 |
| Permission request and approval | Permission request and approval | |
| ApplyResourceAccessPermission | Submit a Resource Access Permission Application | Submits an application for access permissions on a specific resource. |
| 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 policy | Query result control policy | |
| CreateSecurityStrategy | CreateSecurityStrategy | Creates a new security control policy to configure various modules and submodules. Requires both DataWorks tenant administrator and security administrator permissions. |
| DeleteSecurityStrategy | DeleteSecurityStrategy | 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 | GetSecurityStrategy | Retrieves the details of a security policy by its ID. This operation requires both DataWorks tenant administrator and security administrator permissions. |
| ListSecurityStrategies | ListSecurityStrategies | Retrieves a paginated list of security policies based on specified conditions. This operation requires DataWorks tenant administrator or security administrator permissions. |
| FindBestMatchSecurityStrategy | Match Best Security Policy | Find the security policy that best matches the given conditions. |
| Approval policy | Approval policy | |
| CreateProcessDefinition | CreateApprovalProcessDefinition | 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 | CreateIdentifyCredential | Creates an identity credential. |
Tag 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 | Query data assets associated with tags | Queries DataWorks data assets that are associated with tags by paging. |
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 |
| ListDataQualityEvaluationTasks | List quality watchtasks | Lists quality monitoring nodes by paging query. |
| ListDataQualityRules | Queries the list of data quality rules. | Paginated query of data quality monitoring rules. |
| 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 a data quality monitoring task | Associates data quality rules with a data quality monitoring task. |
| UpdateDataQualityEvaluationTask | Update data quality monitoring | Updates a data quality validation task. |
| CreateDataQualityEvaluationTaskInstance | Creates a data quality evaluation monitoring instance | Creates a data quality evaluation task instance. |
| CreateDataQualityEvaluationTask | Creates a data quality monitor | Creates a DataWorks data quality monitor. |
| UpdateDataQualityRuleTemplate | Updates a data quality rule template | Updates a data quality rule template. |
| CreateDataQualityRuleTemplate | Create a data 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 data quality rule | Creates a data quality rule. |
| UpdateDataQualityRule | Updates a data quality rule | Updates a data quality rule. |
| GetDataQualityRule | Queries the details of a data quality rule | Queries the details of a data quality rule. |
| ListDataQualityRuleTemplates | Queries a list of data quality rule templates | Queries a list of data quality rule templates. |
| DeleteCertificate | DeleteCertificate | Deletes a certificate file. |
| GetCertificate | GetCertificate | You can view authentication files. |
| GetDataSource | GetDataSource | Retrieves the details of a data source by data source ID. |
| ImportCertificate | ImportCertificate | Imports a certificate file. |
| ListCertificates | ListCertificates | Retrieves a list of certificate files. |
| 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. |
| 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. |
| UpdateWorkflow | Update a workflow | Updates a specified workflow by using the full update method. Fields that can be synchronously updated to DataStudio include: owner, data source, schedule resource group, description, and trigger run mode (Normal, Skip, or Pause). |
| DeleteDataQualityRule | DeleteDataQualityRule | Deletes a data quality monitoring rule. |