API overview
Updated at:
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 new 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 | ListSkills | Lists the Skills in your account. |
| Agent management | Agent management | |
| CreateAgent | Create an agent | Creates an Agent. |
| ListCustomAgents | ListCustomAgents | Retrieves a paginated list of custom agents. |
| DeleteAgent | Delete an agent | Deletes an Agent. |
| GetAgent | GetAgent | Retrieves agent details by name. |
| 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. |
| 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 | Query session list | Loads the conversation history list of an Agent Session. |
| 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 a session | Creates a new agent session and returns the session ID. |
| CancelAgentSession | Cancel a session | Interrupts the Agent call for a specified session, supporting interruption during streaming responses. |
Space management
|
API |
Title |
Description |
| Workspace | Workspace | |
| 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. |
| Space role | Space role | |
| 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 | ListProjectRoles | Returns a paginated list of roles in a workspace. |
| Space member | Space member | |
| 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 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 | Create a data source | Creates a data source in a specified project workspace for the development or production environment. |
| DeleteDataSource | DeleteDataSource | Deletes a data source by data source ID. |
| CloneDataSource | Clone a data source | Clones a new data source based on an existing data source. |
| 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 | Create a compute resource | Creates a compute resource in a specified workspace. The compute resource can be in the development environment or production environment. |
| GetComputeResourceAuthUserMappings | Get compute resource account mapping information | Queries the user mappings of a compute resource. Supports 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 group | Resource group | |
| CreateResourceGroup | Create a resource group | Creates a resource group. |
| DeleteResourceGroup | DeleteResourceGroup | Deletes a resource group. |
| UpdateResourceGroup | UpdateResourceGroup | Updates basic information about a resource group. |
| GetResourceGroup | Get resource group information by ID | Retrieves the information of a specified resource group by 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 | 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. |
| 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 | Get route list of a network resource | Retrieves the route list of a network resource. |
| Network | Network | |
| 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 | 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 |
| CreateImage | Create an image | Creates an image. |
| UpdateImage | Update an image | Updates an image. |
| RunImageTest | Run image test | Runs an image test. |
| ListImageTestResults | Retrieve image test results | Retrieves the 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 | ListImages | Retrieves a list of images. |
| ListImageVersions | ListImageVersions | 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 | DissociateProjectFromImage | Disassociates an image from a workspace. |
| ListImageAssociatedProjects | ListImageAssociatedProjects | Lists the workspaces associated with an image. |
Data development (new version)
|
API |
Title |
Description |
| Snapshot | Snapshot | |
| GetSnapshot | Retrieve version snapshot details | Retrieves the details of a version snapshot. |
| ListSnapshots | Retrieve version snapshot list | Retrieves a list of version snapshots. |
| Component | Component | |
| CreateComponent | Create a component | Creates a component. |
| DeleteComponent | Delete a component | Deletes a component. |
| GetComponent | GetComponent | Gets component information. |
| UpdateComponent | UpdateComponent | Updates components. |
| ListComponents | ListComponents | Retrieves a list of components. |
| Node | Node | |
| CreateNode | Create a data development node | Creates a data development node in the new version of DataStudio. |
| DeleteNode | Delete a data development node | Deletes a specified data development node. |
| 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 | List data development nodes | Retrieves a list of data development nodes with paging, and supports filtered query by specified conditions. |
| ListNodeDependencies | Get dependency nodes of a dataStudio node | Retrieves the dependency nodes of a specified DataStudio node with pagination. |
| Workflow definition | Workflow definition | |
| CreateWorkflowDefinition | Create a dataStudio workflow | Creates a workflow in a specified folder in DataStudio. |
| ImportWorkflowDefinition | Import a dataStudio workflow | Imports a workflow node defined by FlowSpec and its internal child nodes into DataStudio. |
| DeleteWorkflowDefinition | Delete a data development workflow | Deletes a specified workflow in data development. |
| 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 | Create a data development file resource | Creates a file resource for data development. The file resource information is defined in FlowSpec format. |
| 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 | List data development file resources | Queries resource files with pagination and filtering support. |
| MoveResource | MoveResource | Moves a file resource to a path in DataStudio. |
| RenameResource | RenameResource | Renames a file resource in DataStudio. |
| Function | Function | |
| CreateFunction | Create a dataStudio function | Creates a UDF function in DataStudio. The UDF function information is described in FlowSpec format. |
| 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 | List data development functions | Retrieves a paginated list of UDF functions in DataStudio. You can also use filter conditions to filter UDF functions. |
| Publish process | Publish process | |
| CreatePipelineRun | Create a publish process | Creates a publish process for an entity in the new-version DataStudio. |
| 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 publish flow | Executes a specified stage of a publish flow. |
| GetPipelineRun | Retrieve deployment process details | Retrieves 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. |
| Personal development environment | Personal development environment | |
| ListServerIdeInstances | Query personal development environment instances | Queries a paged query list of personal development environment instances with paging support. |
| 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 development (legacy)
|
API |
Title |
Description |
| File | File | |
| CreateFile | Create a file in dataStudio | Creates a file in DataStudio. This operation does not support creating 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 | Query file list | Queries a list of files by calling ListFiles. |
| SubmitFile | SubmitFile | 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. |
| 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 | Query folder list | Queries a list of folders. |
| Business flow | Business flow | |
| CreateBusiness | Create a business process | Creates a business process in DataStudio for data development. |
| DeleteBusiness | DeleteBusiness | Deletes a workflow. |
| UpdateBusiness | UpdateBusiness | Updates a workflow. |
| GetBusiness | Query business process details | Queries the details of a business process by calling GetBusiness. |
| ListBusiness | ListBusiness | Queries a list of workflows. |
| Publish package | Publish package | |
| 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 version | File version | |
| 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 event | Extension point event | |
| UpdateIDEEventResult | Update the check result of an extension point event | Returns the check result of an extension point event message. |
| 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 | Create a data integration synchronization task | Creates a data integration task. |
| 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 | GetDIJob | View data integration tasks. |
| GetDIJobLog | View the run logs of a data integration synchronization task | Retrieves the task logs of a data integration node. |
| 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 | 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 attribute | Custom attribute | |
| 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 definition | Custom metadata entity definition | |
| 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 collector | Metadata collector | |
| 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 submit 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 entity | Metadata entity | |
| Custom entity | Custom entity | |
| ListMetaEntities | Query metadata entity list | Queries a list of metadata entities. Currently, only custom entity types are supported. |
| GetMetaEntity | GetMetaEntity | Retrieves the details of a custom entity. |
| 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 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 | Get data catalog details in data map | Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks catalog types 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 | Retrieve data map table details | Retrieves the details of a specified table in 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 | Get batch table owner transfer status | Queries the status of a batch table owner transfer task. |
| Field | Field | |
| ListColumns | Query columns of a data map table | Queries the column list of a specified 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 | 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 | 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 | 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 version | Dataset version | |
| 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 |
| Partition | Partition | |
| 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 | GetPartition | Retrieves partition details for a data map table. Currently supports MaxCompute and HMS (EMR cluster) types only. |
| Lineage | Lineage | |
| ListLineageRelationships | Query data lineage relationship list in data map | Queries the list of data lineage relationships between two specified entities (tables, fields, OSS files, etc.) in DataWorks Data Map. |
| GetLineageRelationship | Get data lineage relationship details | 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 data lineage list of a data map entity | Queries the upstream and downstream lineage entities for a specified entity in DataWorks Data Map, with an option to include detailed lineage relationship information. |
| Metadata collection | Metadata collection | |
| 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 | 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 | 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 |
| 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 | 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. |
| Task | Task | |
| GetUpdateTaskResult | Get the result of an update node task | Queries the result of asynchronously creating a workflow instance. |
| UpdateTaskAsync | Update a node | Updates a specified node and synchronizes the changes to DataStudio to create a new saved version. |
| 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 | 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 | ListTaskOperationLogs | Retrieves a paginated list of operation logs for a task. |
| Task instance | Task instance | |
| 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 instances | Lists node instances by paging and supports filtered query by conditions. |
| ListUpstreamTaskInstances | List upstream instances | Retrieves the upstream instances of a specified instance by page. |
| ListTaskInstanceOperationLogs | ListTaskInstanceOperationLogs | 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 instances | Stops multiple instances in a batch. |
| 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 | Delete a workflow | Deletes a specified 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 | 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 paging list of workflow instances, with optional filtered query by conditions. |
| StartWorkflowInstances | Start workflow instances | Starts multiple workflow instances in a batch. |
| StopWorkflowInstances | StopWorkflowInstances | Stops multiple workflow instances at a time. |
| ExecuteAdhocWorkflowInstance | Run a temporary workflow instance | Creates a temporary workflow instance based on the specified configuration. |
Data quality
|
API |
Title |
Description |
| Data quality rule template | Data quality rule template | |
| CreateDataQualityTemplate | Create a data quality rule template | Creates a data quality rule template in a specified project. |
| UpdateDataQualityTemplate | UpdateDataQualityTemplate | 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 | 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 | 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 | 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 | Delete a data quality alert rule | Deletes a data quality monitoring alert rule based on the specified ID. |
| Data quality run | Data quality run | |
| CreateDataQualityScanRun | Create a data quality scan run | Triggers the execution of a specified data quality monitoring task and returns the run instance ID. |
| ListDataQualityScanRuns | ListDataQualityScanRuns | Queries the run history of data quality scans in a specified project. |
| GetDataQualityScanRunLog | Get data quality scan run logs | Queries the log content of a specified data quality monitoring task instance. |
| 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 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 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 | Create an identity credential | Creates an identity credential. |
Tag management
|
API |
Title |
Description |
| CreateDataAssetTag | Create a label | Creates a label. |
| DeleteDataAssetTag | DeleteDataAssetTag | Deletes a tag. |
| UpdateDataAssetTag | Update a label | Updates a label. |
| 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 | 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 watchtasks | Queries a paged list of quality monitoring nodes by using paging. |
| 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 validation task. |
| CreateDataQualityEvaluationTaskInstance | Create a data quality check monitoring instance | Creates a data quality check task instance. |
| CreateDataQualityEvaluationTask | Create a data quality monitor | Creates a DataWorks data quality monitor. |
| 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 data quality rule | Creates a data quality rule. |
| UpdateDataQualityRule | Updates a data quality rule | Updates a data 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 | GetCertificate | You can view authentication files. |
| GetDataSource | View data source details | Queries a specified 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). |
| 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 publish flow | Executes a cross-workspace publish 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. |
| ReplyAgentSession | Reply to a session input request | Replies to a pending user interaction in a DataAgent session. |
Is this page helpful?