All Products
Search
Document Center

DataWorks:API overview

Last Updated:Oct 20, 2026

API standards and multilingual preset SDKs

The OpenAPI of this product (dataworks-public/2020-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.

Tenant

API

Title

Description

ListCalcEngines ListCalcEngines Queries a list of compute engines that are associated with a DataWorks workspace.
CreateDataSource CreateDataSource Adds a data source to DataWorks.
ListDataSources ListDataSources Queries the data sources added to a DataWorks workspace.
UpdateDataSource UpdateDataSource Updates a data source.
DeleteDataSource DeleteDataSource Removes a data source.
ListResourceGroups List resource groups Queries a list of resource groups of a specified type.
GetProject Query workspace details Queries the details of a DataWorks workspace.
AddProjectMemberToRole Add a workspace user to a role Adds a DataWorks workspace user to a role. Before calling this operation, you must first add the target account as a member of the DataWorks workspace.
CreateProjectMember Add a user to a workspace Adds a user to a DataWorks workspace.
DeleteProjectMember Remove a user from a DataWorks workspace Removes a user from a DataWorks workspace.
ListProjectRoles Retrieve all roles in a workspace Retrieves a list of all roles in a workspace.
RemoveProjectMemberFromRole Remove a user from a role in a workspace Removes a user from a DataWorks role in a DataWorks workspace.
ListProjectMembers List workspace members Queries the list of existing members in a DataWorks workspace.
ListProjects List workspaces Queries a list of DataWorks workspaces in the tenant to which the user belongs.
ListProjectIds List DataWorks workspace IDs for an account Queries the IDs of the workspaces on which a specific Alibaba Cloud account or RAM user has permissions in a specific region.
CreateProject Create a DataWorks workspace Creates a DataWorks workspace.
ChangeResourceManagerResourceGroup Change the resource group of a resource Changes the resource group of a resource.
ListMeasureData ListMeasureData Queries the statistics on the number of phone call-based alerts or text message-based alerts reported within the tenant to which your account belongs during the previous 30 days.

Metadata

API

Title

Description

ListTables ListTables Obtains tables of different data source types within a tenant by page.
GetMetaDBInfo Retrieve basic metadata of an engine instance Retrieves the basic metadata information of an engine instance.
GetMetaDBTableList Get tables in an engine instance Retrieves tables in the specified Engine Instance.
CheckMetaTable Check whether a table exists Checks whether a table exists.
CheckMetaPartition CheckMetaPartition Checks whether a partition in a MaxCompute metatable exists.
SearchMetaTables SearchMetaTables Queries metatables based on specific conditions.
GetMetaTableBasicInfo GetMetaTableBasicInfo Queries the basic information about a metatable.
GetMetaTableColumn GetMetaTableColumn Queries the field information of a metatable.
GetMetaTablePartition Retrieve the partitions of a table Retrieves the partitions of a table.
GetMetaTableOutput Retrieve table output information Retrieves the output information of a table.
GetMetaTableChangeLog Retrieve table change log Retrieves the change log of a table.
GetMetaTableIntroWiki Retrieve table usage instructions Retrieves the usage instructions for a table.
CreateMetaCategory CreateMetaCategory Creates a category.
DeleteMetaCategory DeleteMetaCategory Deletes a category.
UpdateMetaCategory UpdateMetaCategory Updates a category.
GetMetaCategory Query the category tree Queries the category tree.
GetMetaTableListByCategory GetMetaTableListByCategory Queries metatables in a specified category.
AddToMetaCategory AddToMetaCategory Adds a metatable to a specified category.
DeleteFromMetaCategory DeleteFromMetaCategory Removes a table from a specified category.
UpdateMetaTable UpdateMetaTable This operation updates the metadata of a table.
UpdateMetaTableIntroWiki Update table description Updates the description of a table. If the data does not exist, the description is added.
ListMetaDB List databases Queries the list of databases.
UpdateTableModelInfo Modify table model information Modifies the theme, hierarchy, and physical classification of a table.
CreateTableTheme CreateTableTheme Creates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.
DeleteTableTheme DeleteTableTheme Deletes a table theme. This operation will be replaced soon. We recommend that you do not call this operation.
UpdateTableTheme UpdateTableTheme Updates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.
ListTableTheme ListTableTheme Lists table themes. This operation will be replaced soon. We recommend that you do not call this operation.
GetMetaTableThemeLevel Query theme and level information of a table Queries the theme and level information of a table.
CreateTableLevel CreateTableLevel Creates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.
UpdateTableLevel UpdateTableLevel Updates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.
DeleteTableLevel DeleteTableLevel Deletes a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.
ListTableLevel ListTableLevel Lists hierarchy levels. This operation will be replaced soon. We recommend that you do not call this operation.
UpdateMetaCollection Update a collection object Updates the name and comment of a collection object.
ListMetaCollections Query collection information Queries collection information. Collections include albums and subcategories within albums on the Data Map page. You can call this operation to query collection information by specifying a collection type.
ListMetaCollectionEntities Query entities in a collection Queries entities in a collection.
DeleteMetaCollection Delete a collection Deletes a collection.
GetMetaCollectionDetail Query collection details Queries the details of a collection.
DeleteMetaCollectionEntity Delete an entity from a collection Deletes an entity from a collection.
AddMetaCollectionEntity Add an entity to a collection Adds an entity to a collection.
CreateMetaCollection Create a collection object Creates a collection object.
ListLineage Query entity lineage Queries the upstream and downstream lineage relationships of an entity.
DeleteLineageRelation DeleteLineageRelation Deletes lineage relationships between entities. Only custom lineage relationships registered by users can be deleted.
RegisterLineageRelation Register lineage relationship Registers entity relationships. You can register custom entity relationships.
GetMetaTableLineage Query table lineage Queries the data lineage of a table.
GetMetaColumnLineage Get column lineage Queries the lineage of a column by calling GetMetaColumnLineage.

Data Studio

API

Title

Description

CreateFile Create a file in Data Studio Creates a file in Data Studio. This operation does not support creating data integration node tasks.
CreateUdfFile Create a function file in Data Studio Creates a function file in Data Studio.
CreateBusiness Create a workflow Creates a workflow in Data Studio.
DeleteBusiness DeleteBusiness Deletes a workflow.
CreateFolder CreateFolder Creates a folder.
UpdateBusiness UpdateBusiness Updates a workflow.
ListFiles List files Queries a list of files.
EstablishRelationTableToBusiness Import a table to a workflow Imports a table to a workflow. This is equivalent to right-clicking a workflow on the Data Studio page and selecting Import Table.
SubmitFile Submit a file to the scheduling system development environment Submits a file to the development environment of the scheduling system to create a corresponding task.
ListBusiness List business processes Queries a list of workflows.
GetFileVersion Get file version details Queries the information about a file version.
DeleteFolder Delete a folder from Data Studio Deletes a folder from the Data Studio page.
DeleteFile Delete a file from Data Studio Deletes a file from Data Studio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process.
GetDeployment Get deployment package details Queries the information about a deployment package.
UpdateFile Update an existing file node Updates an existing file.
GetFolder Retrieve folder details Retrieves the details of a folder.
ListFileVersions List file versions Queries a list of file versions.
GetFile Get file information Queries the information about a file.
ListFolders List folders Call the ListFolders operation to query for folders.
DeployFile Deploy a file Deploys a file to the production environment.
UpdateUdfFile Update function file information Updates the file information of a function.
GetBusiness Get workflow information Queries the information about a workflow.
UpdateFolder Update a folder Updates a folder.
ListDeployments List deployment packages Queries a list of deployment packages. This operation is equivalent to viewing a list of deployment packages on the Deployment Packages page of the DataWorks console.
UpdateIDEEventResult Update an extension point event check result Returns the check result of an extension point event to Data Studio after the extension point event is triggered during data development and checked by an extension.
GetIDEEventDetail Query data snapshot when an extension point event is triggered Queries the extension point data snapshot at the time an extension point event was triggered, based on the message ID of a DataWorks open message.
CreateResourceFile Create a resource file Creates or uploads a resource file in Data Studio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE).

Data Integration

API

Title

Description

CreateDISyncTask Create a data integration synchronization task Creates a Data Integration synchronization task.
DeleteDISyncTask DeleteDISyncTask Deletes a real-time synchronization task.
UpdateDISyncTask Update a Data Integration synchronization task Updates a data synchronization task.
TestNetworkConnection Test data source network connectivity Tests the network connectivity between the destination data source and the resource group.
GetDataSourceMeta Get data source metadata Queries the metadata of a specified data source.
ListDIProjectConfig List default Data Integration project configuration Queries the default global configurations of synchronization solutions in a specified DataWorks workspace.
UpdateDIProjectConfig Update default Data Integration project configuration Modifies the default global configuration of synchronization solutions in a DataWorks workspace.
GetDISyncTask GetDISyncTask Retrieves the details of a synchronization task or a data synchronization solution.
DeployDISyncTask Deploy and publish a synchronization task Publishes a real-time synchronization task.
GetDISyncInstanceInfo Get Data Integration synchronization instance information Queries the status of a real-time synchronization task or a data synchronization solution.
TerminateDISyncInstance Terminate a Data Integration synchronization instance Undeploys a real-time synchronization task.
GenerateDISyncTaskConfigForCreating Asynchronously generate the JSON configuration for a synchronization task Asynchronously generates the JSON configuration for a synchronization task.
GenerateDISyncTaskConfigForUpdating Asynchronously generate the configuration for updating a synchronization task Asynchronously generates the JSON configuration for updating a synchronization task.
StartDISyncInstance StartDISyncInstance Starts a real-time synchronization task or a synchronization solution.
StopDISyncInstance StopDISyncInstance Stops a real-time synchronization task.
QueryDISyncTaskConfigProcessResult Query the result of an asynchronous task Queries the result of an asynchronous task.
CreateDIJob CreateDIJob Creates a task in the new version of Data Integration. Currently, supported task types include the real-time full-database synchronization solution from MySQL to Hologres.
DeleteDIJob DeleteDIJob Deletes a Data Integration task of a new version. Only the following type of task is supported: real-time synchronization of an entire MySQL database to Hologres.
GetDIJob GetDIJob Queries the information about a new-version synchronization task created in Data Integration. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres.
ListDIJobs ListDIJobs Queries the list of new-version data integration tasks. Currently supported task types include MySQL-to-Hologres full-database real-time synchronization tasks.
StartDIJob StartDIJob Starts a synchronization task of a new version. Only the following type of task is supported: real-time synchronization of an entire MySQL database to Hologres.
StopDIJob StopDIJob Stops a new-version synchronization task. The following type of synchronization task is supported: real-time synchronization of all data in a MySQL database to Hologres.
UpdateDIJob UpdateDIJob Updates a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.
CreateDIAlarmRule CreateDIAlarmRule Creates an alert rule for a task in the new version of Data Integration. Currently, supported task types include the real-time full-database synchronization solution from MySQL to Hologres.
DeleteDIAlarmRule DeleteDIAlarmRule Deletes an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time synchronization of an entire MySQL database to Hologres.
GetDIAlarmRule Get an alert rule for a new-version Data Integration task Retrieves an alert rule for a new-version Data Integration task. Currently, the supported task type is the MySQL-to-Hologres real-time database synchronization solution.
ListDIAlarmRules List alert rules for new-version data integration tasks Queries the list of alerting rules for data integration new-version nodes. Currently supported node types include the MySQL-to-Hologres full-database real-time Solutions.
UpdateDIAlarmRule Update alert rules for new data integration tasks Updates the alert rules for new data integration tasks. Currently supported task types include the full-database real-time synchronization solution from MySQL to Hologres.

Data Modeling

API

Title

Description

QueryPublicModelEngine QueryPublicModelEngine Queries information about the Data Modeling engine by using FML statements.

Operation Center

API

Title

Description

GetAlertMessage GetAlertMessage Queries alert information based on the alert ID that is specified by the AlertId parameter.
ListAlertMessages ListAlertMessages Queries a list of alerts.
GetBaselineConfig Retrieve baseline configuration details Retrieves the configuration details of a baseline by calling GetBaselineConfig.
ListNodesByBaseline Retrieve nodes in a baseline Retrieves the nodes in a baseline, excluding their upstream nodes.
ListBaselineConfigs ListBaselineConfigs Queries a list of baselines.
GetBaselineKeyPath Retrieve the critical path of a baseline instance Retrieves the critical path of a baseline instance.
GetBaselineStatus Retrieve baseline instance details Retrieves the details of a baseline instance.
ListBaselineStatuses Retrieve baseline instance list Retrieves a list of baseline instances.
DeleteRemind Delete a custom monitoring alert rule Deletes a custom monitoring alert rule.
UpdateRemind Update a custom alert rule Updates a custom alert rule.
CreateRemind Create a custom alert rule Creates a custom alert rule by calling CreateRemind.
GetRemind GetRemind Queries the information about a custom alert rule.
ListReminds ListReminds Queries a list of custom alert rules.
ListTopics Query or search for events Queries or searches for a list of events.
GetTopic Retrieve event details Queries the details of an event.
GetTopicInfluence Retrieve the list of baseline instances affected by an event Retrieves the list of baseline instances affected by an event.
GetNode Get node details Retrieves the details of a node.
ListNodeInputOrOutput Query node input and output information Queries the input and output information of the current node.
ListNodes List nodes Queries a list of nodes.
GetNodeCode GetNodeCode Retrieves the code of a node.
GetInstance GetInstance Queries the information about an instance.
ListInstances Retrieve a list of instances Queries a list of instances.
GetInstanceLog Retrieve instance logs Retrieves the logs of an instance.
StopInstance Terminate an instance Terminates an instance.
RestartInstance Restart an instance Restarts an instance.
SetSuccessInstance SetSuccessInstance Sets the state of a failed instance to successful.
SuspendInstance Suspend an instance Suspends an instance.
ResumeInstance ResumeInstance Resumes a paused instance.
RunCycleDagNodes Create a data backfill workflow Creates a data backfill workflow.
RunSmokeTest RunSmokeTest Creates a smoke test workflow by calling the RunSmokeTest operation.
ListSuccessInstanceAmount Retrieve the count of successfully completed instances Retrieves the trend of successfully completed instance counts at different hours on the business date for periodic instances generated on that date.
ListInstanceAmount ListInstanceAmount Queries the trend of the number of auto triggered node instances within a specified period of time.
TopTenElapsedTimeInstance Retrieve the ranking of yesterday's longest-running tasks Retrieves the ranking of instances by execution duration.
TopTenErrorTimesInstance TopTenErrorTimesInstance Queries the ranking of nodes on which errors occur over the past month.
GetFileTypeStatistic Get node task type distribution Queries the distribution of node task types.
GetInstanceStatusStatistic Retrieve instance running status statistics Retrieves the number of instance tasks in each running status.
ListFileType ListFileType Queries the information about node types, such as the code and name.
RunManualDagNodes Run a manual workflow Triggers a manual workflow to run. The manual workflow must have been submitted and published in the environment page before it appears in the Operation Center and can be triggered by this operation.
ListManualDagInstances ListManualDagInstances Queries the information about instances in a manually executed business flow.
GetDag GetDag Queries DAG details for manual business flows, manual tasks, and data backfill. DAG details for regularly scheduled tasks are not supported.
ListDags List dAGs Queries the details of all DAGs for a single data backfill based on OpSeq, the unique identifier of the data backfill.
ListNodesByOutput ListNodesByOutput Queries nodes by an exact match on the output of the nodes.
RunTriggerNode Run a trigger node Runs a trigger node.
GetNodeParents Retrieve upstream node list Calls GetNodeParents to retrieve the list of upstream nodes.
GetNodeChildren Retrieve downstream nodes Retrieves the downstream nodes of a node.
UpdateNodeRunMode UpdateNodeRunMode Freezes or unfreezes a specified node.
UpdateNodeOwner Update node owner Updates the owner of a specified node.
UpdateWorkbenchEventResult Update the processing result of an extension Returns the processing result of an extension to Operation Center. Call this operation when an Operation Center process is blocked by the extension.
ListShiftPersonnels Retrieve the list of on-call personnel for a shift schedule Retrieves the list of on-call personnel for a shift schedule.
ListShiftSchedules ListShiftSchedules Queries a list of shift schedules in Operation Center.
ListInstanceHistory Retrieve all instance history records Retrieves all history records of an instance. A history record is generated each time a node is rerun.
ListInnerNodes ListInnerNodes Retrieves a list of inner nodes within a node group or do-while node. This operation does not support querying the inner nodes of a PAI node.
OfflineNode OfflineNode Undeploys a node.
GetBaseline Retrieve baseline configuration Retrieves the baseline configuration by baseline ID.
UpdateBaseline Update baseline configurations Updates a baseline.

Data Quality

API

Title

Description

UpdateQualityFollower UpdateQualityFollower Updates a subscription relationship.
UpdateQualityRule Update rule Calls UpdateQualityRule to update the information of a quality check rule.
GetQualityRule Get quality rule information Gets information about a quality rule.
ListQualityRules Retrieve rules by partition expression Queries the list of quality rules based on a partition expression.
CreateQualityRule Create a quality monitoring rule Call CreateQualityRule to create a Quality Rule.
DeleteQualityFollower DeleteQualityFollower Deletes a subscriber of a partition expression. After the subscriber is deleted, the subscriber no longer receives notifications when a data quality monitoring rule is triggered.
DeleteQualityRule DeleteQualityRule Deletes a data quality rule.
GetQualityFollower Get subscribers of a partition expression Retrieves the subscribers of a partition expression.
CreateQualityFollower CreateQualityFollower Creates a subscriber for a partition expression by calling CreateQualityFollower.
DeleteQualityEntity DeleteQualityEntity Deletes a partition expression.
GetQualityEntity Retrieve a partition expression Retrieves a partition expression.
CreateQualityEntity CreateQualityEntity Creates a partition expression for data quality.
CreateQualityRelativeNode CreateQualityRelativeNode Creates a Partition Expression Association.
DeleteQualityRelativeNode DeleteQualityRelativeNode DeleteQualityRelativeNode deletes a scheduling association.
ListQualityResultsByEntity ListQualityResultsByEntity Use `ListQualityResultsByEntity` to retrieve validation results based on a partition expression.
ListQualityResultsByRule ListQualityResultsByRule Validates the quality of a Data Source against Validation Rules and returns the Validation Results.

Data Service

API

Title

Description

CreateDataServiceApi Create a data service API Creates a data service API.
PublishDataServiceApi Publish data service API Publishes a data service API.
DeleteDataServiceApi DeleteDataServiceApi Deletes a DataService API.
ListDataServiceApis List data service aPIs in development Queries a list of data service APIs in development.
GetDataServiceApi GetDataServiceApi Retrieves the details of a DataService Studio API in the development state.
UpdateDataServiceApi UpdateDataServiceApi Updates the information about an API in the development state in DataService Studio.
GetDataServicePublishedApi GetDataServicePublishedApi Retrieves the details of a published DataService Studio API.
ListDataServicePublishedApis List published Data Service APIs Queries the list of published Data Service APIs by calling ListDataServicePublishedApis.
ListDataServiceApiAuthorities Query APIs authorized to other users Queries the list of APIs authorized to other users.
ListDataServiceAuthorizedApis List authorized APIs in dataService Retrieves a list of authorized APIs in DataService.
AbolishDataServiceApi AbolishDataServiceApi Unpublishes a DataService Studio API.
GetDataServiceApplication Get Data Service application details Retrieves the details of a Data Service application.
ListDataServiceApplications ListDataServiceApplications Retrieves a list of applications.
CreateDataServiceFolder CreateDataServiceFolder Creates a folder in DataService Studio.
GetDataServiceFolder Get data service folder Queries a data service folder.
ListDataServiceFolders List data service folders Queries data service folders.
CreateDataServiceGroup CreateDataServiceGroup Creates a business process.
GetDataServiceGroup Query a data service business flow Queries a Data Service business flow.
ListDataServiceGroups Query data service business processes Queries the list of Data Service business processes.
CreateDataServiceApiAuthority Grant data service API authorization Grants authorization for a data service API.
DeleteDataServiceApiAuthority Revoke data service API authorization Revokes the authorization of a data service API.
ListDataServiceApiTest List dataService API test records Lists the test records of a DataService API. Only data from the last month can be queried.
TestDataServiceApi Test a Data Service API Tests a Data Service API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result.
GetDataServiceApiTest Get API test results Queries the test results of an API in Data Service.
SubmitDataServiceApi Submit a Data Service API Submits an API in Data Service.
SaveDataServiceApiTestResult Save API test results Saves the test results of an API.

Data Security Guard

API

Title

Description

DsgQueryRowDetail Data Security Guard - data access - export detailed list query Queries row-level export details.
DsgQueryDetails Data Security Guard - data access - export query Queries export details.
DsgGetVisitStat Data Security Guard - Query data access behavior records Queries access records for data access.
DsgGetVisitDetail Data Security Guard - Query access behavior details Queries access behavior details.
DsgUpdateDesensStatusList Update the status of data masking switches Update the status of data masking switches
DsgQueryDesensStatusList Query data masking switch Query data masking switch status
GetOpSensitiveData Retrieve sensitive data access records Retrieves sensitive data access records for a specified date across all DataWorks workspaces under a tenant.
DesensitizeData Mask data Submits data for masking and returns the masked result.
GetOpRiskData Retrieve access records of risky sensitive data Retrieves the access records of risky sensitive data on a specified date across all DataWorks workspaces under a tenant.
GetSensitiveData Get sensitive data identification results Queries the latest sensitive data identification results in all the DataWorks workspaces of a tenant.
ScanSensitiveData Scan sensitive data Checks whether input data contains sensitive data.
DsgQuerySensResult Retrieve sensitive data identification results Retrieves the sensitive data identification results from Data Security Guard.
QueryDefaultTemplate Query default data classification and grading template Queries the default data classification and grading template defined by Data Security Guard.
DsgStopSensIdentify Stop a sensitive data classification and grading identification task Stops a sensitive data identification task.
QuerySensClassification Query classification nodes in data classification and grading Queries the classification nodes in the data classification and grading feature of Data Security Guard.
QuerySensLevel Query data sensitivity levels Queries data sensitivity levels in Data Security Guard.
QueryRecognizeRulesType Query built-in sensitive field identification rule types Queries the built-in identification rule types for sensitive fields defined in Data Security Guard.
DsgRunSensIdentify Start a sensitive data identification task Starts a sensitive data identification task in Data Security Guard.
DeleteRecognizeRule Delete data classification and grading rules Deletes a data classification and grading rule defined in Data Security Guard.
QuerySensNodeInfo Query data classification and grading identification rules Queries the data classification and grading identification rules in Data Security Guard.
AddRecognizeRule Add a sensitive field defined by classification and grading rules Adds a sensitive field defined by the data classification and grading rules of Data Security Guard.
EditRecognizeRule Edit sensitive fields defined in classification and grading rules Modifies the sensitive fields defined in the classification and grading rules of Data Security Guard.
QueryRecognizeDataByRuleType Query the list of sensitive field recognition methods Queries the list of sensitive field recognition methods in Data Security Guard by calling the QueryRecognizeDataByRuleType operation.
QueryRecognizeRuleDetail QueryRecognizeRuleDetail Retrieves the details of a specified sensitive field in Data Security Guard.
DsgUserGroupGetOdpsRoleGroups List available MaxCompute roles Queries the MaxCompute roles available for selection as user group members when a tenant creates or modifies a user group in Data Security Guard.
DsgDesensPlanAddOrUpdate Create or update a data masking rule Creates or updates a data masking rule.
DsgPlatformQueryProjectsAndSchemaFromMeta DsgPlatformQueryProjectsAndSchemaFromMeta Queries a list of compute engines of different types in the current tenant.
DsgUserGroupDelete DsgUserGroupDelete Deletes a user group configured in Data Security Guard.
DsgWhiteListDeleteList DsgWhiteListDeleteList Deletes a data masking whitelist configured in Data Security Guard.
DsgScenedDeleteScene DsgScenedDeleteScene Deletes a level-2 data masking scenario created in Data Security Guard.
DsgDesensPlanDelete DsgDesensPlanDelete Deletes a data masking rule created in Data Security Guard.
DsgDesensPlanUpdateStatus DsgDesensPlanUpdateStatus Modifies the status of a data masking rule.
DsgWhiteListQueryList DsgWhiteListQueryList Queries data masking whitelists configured in Data Security Guard.
DsgSceneAddOrUpdateScene Create or modify a level-2 masking scenario Creates or modifies a level-2 masking scenario.
DsgSceneQuerySceneListByName Query masking scenarios Queries the list of masking scenarios.
DsgUserGroupAddOrUpdate Add or modify a user group in Data Security Guard Adds or modifies a user group in Data Security Guard.
DsgUserGroupQueryList List user groups in Data Security Guard Queries the list of user groups in Data Security Guard.
DsgUserGroupQueryUserList DsgUserGroupQueryUserList Queries a list of users or roles of the current tenant.
DsgDesensPlanQueryList List data masking rules Call the `DsgDesensPlanQueryList` API to query Data Security Guard's (DSG) data masking rules.
DsgWhiteListAddOrUpdate Create or modify a data masking whitelist Creates or modifies a data masking whitelist.
DsgQueryDefaultTemplates Query available sensitive data type templates and details Retrieves available Sensitive Data Type Templates and the Desensitization Rules they support. Use the response from this API to configure your Desensitization Rules.

Migration Assistant

API

Title

Description

CreateImportMigration CreateImportMigration Creates an import task to import a DataWorks import and export package that contains objects such as data sources, tasks, and tables.
GetMigrationProcess GetMigrationProcess Queries the progress of a migration task.
StartMigration StartMigration Starts a migration task.
CreateExportMigration CreateExportMigration Creates an export task in DataWorks. This API operation only creates the export task and does not start the export task.
GetMigrationSummary GetMigrationSummary Queries the information about a migration task.
ListMigrations Retrieve migration tasks Retrieves a list of import and export migration tasks.

Security Center

API

Title

Description

CreatePermissionApplyOrder Create a permission request order Creates a permission request order. Note: The 2020 version of OpenAPI will be discontinued. Migrate to the 2024 version of OpenAPI — ApplyResourceAccessPermission as soon as possible.
GetPermissionApplyOrderDetail Query the details of a permission application ticket Queries the details of a permission application ticket. Note: The 2020 version of OpenAPI will be discontinued at a later date. Migrate to the 2024 version of OpenAPI (GetApplicationContents or GetProcessInstance) as soon as possible.
ListPermissionApplyOrders Query the list of permission application orders Queries a list of permission application orders. Note: The 2020 version of OpenAPI will be discontinued at a scheduled time. Please migrate to the 2024 version of OpenAPI as soon as possible — ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals.
ApprovePermissionApplyOrder Approve a permission application ticket Approves a permission application ticket. Note: The 2020 OpenAPI will be taken offline soon. Migrate to the 2024 OpenAPI ApproveProcessInstance as soon as possible.
RevokeTablePermission Revoke table permissions from a user Revokes table permissions from a user.

Open Platform

API

Title

Description

ListExtensions Get extension list Retrieves the list of extensions from the open platform.
GetExtension GetExtension Retrieves the details of an extension.
GetOptionValueForProject GetOptionValueForProject Queries the option settings of an extension in a workspace.
ListEnabledExtensionsForProject ListEnabledExtensionsForProject Queries a list of built-in and custom extensions that are enabled in a workspace.
CallbackExtension Return the check result of an extension for an extension point event Returns the check result of an extension for an extension point event to the DataWorks platform when the extension point is triggered.
ListCheckProcesses Query the check list of extension events Queries the check list of extension events.

Others

API

Title

Description

UpdateTableAddColumn Update column information of a table Updates the column information of a MaxCompute table.
GetMetaTableFullInfo Retrieve complete table information including column information Retrieves the complete information about a table, including column information.
GetDDLJobStatus Get DDL job status Retrieves the status of tasks for creating, updating, and deleting tables.
DeleteTable Delete a MaxCompute table Deletes a MaxCompute table.
UpdateTable UpdateTable Updates a MaxCompute table.
CreateTable CreateTable Creates a MaxCompute table.
CheckFileDeployment Check file deployment Submits the publish check result of a file to DataWorks. After a file created on the DataWorks Data Studio page is successfully submitted, the file enters the publish check state and DataWorks returns a publish check event. You can determine whether the file can proceed with the publish check based on the event content and submit the check result of the file to be published to DataWorks.
ListRefDISyncTasks ListRefDISyncTasks Queries synchronization tasks in Data Integration that use a specific data source.
ExportDataSources ExportDataSources Exports a list of data sources.
ImportDataSources ImportDataSources Imports data sources from your on-premises machine to a specific DataWorks workspace.
UpdateClusterConfigs UpdateClusterConfigs Updates the submodule configurations of a cluster in a workspace. Currently, only Spark parameters are supported.
ListClusterConfigs ListClusterConfigs Lists the configurations of a cluster by module in a specific workspace. Currently, SPARK parameters are supported.
ListClusters ListClusters Queries clusters that are registered in DataWorks. E-MapReduce (EMR) clusters and Cloudera's Distribution Including Apache Hadoop (CDH) clusters are supported.

Deprecated APIs

API

Title

Description

ListEntitiesByTags List entities by tag Lists entities by tag. Currently, only entities of the maxcompute-table type are supported.
RemoveEntityTags Remove tags from an entity Removes tags from an entity. Currently, only entities of the maxcompute-table type are supported.
SetEntityTags Set tags for an entity Sets the tags for an entity. Currently, only entities of the maxcompute-table type are supported.
ListEntityTags List entity tags Lists the tags of an entity. Currently, only entities of the maxcompute-table type are supported.
SetDataSourceShare SetDataSourceShare Shares a data source to a specific DataWorks workspace or a specific user.
CreateConnection CreateConnection Adds a data source.
CreateDagComplement Create a data backfill workflow Creates a data backfill workflow by calling CreateDagComplement.
CreateDagTest Create a smoke test workflow Creates a smoke test workflow by calling CreateDagTest.
CreateManualDag Trigger manual business process execution Triggers the execution of a manual business process. The manual business process must have been submitted and published in the console, and the Operation Center must be able to find the corresponding manual business process before you can call this operation.
DeleteConnection DeleteConnection Removes a data source.
UpdateConnection UpdateConnection Updates a data source.
ListConnections ListConnections Queries a list of data sources.
GetProjectDetail Query workspace information Queries the information about a DataWorks workspace.
ListNodeIO Query upstream and downstream node information Queries the information about upstream and downstream nodes. Only one level of nodes can be queried.
GetInstanceStatusCount Retrieve instance status counts Retrieves the number of instances in different statuses.
ListProgramTypeCount Retrieve the distribution of node task types Retrieves the distribution of node task types.
GetManualDagInstances Query information about instances of a manually executed business flow Queries information about instances of a manually executed business flow.
SearchNodesByOutput Query nodes by output Queries nodes by exact match based on output.
GetNodeTypeListInfo GetNodeTypeListInfo Queries the information about node types, including the code and name of a node type.
GetNodeOnBaseline Query the nodes on a baseline Calls the GetNodeOnBaseline operation to query the nodes on a baseline.
GetSuccessInstanceTrend Retrieve hourly statistical trends of instances for the current day Retrieves the hourly statistical trends of instances for the current day.
GetInstanceCountTrend GetInstanceCountTrend Queries the quantity trend of auto triggered instances.
GetInstanceConsumeTimeRank Queries the ranking of instances by running duration Queries the ranking of instances by running duration.
GetInstanceErrorRank Obtains the error ranking of nodes in the last month Calls GetInstanceErrorRank to obtain the error ranking of nodes in the last month.