API overview-DataWorks(DataWorks)-阿里云帮助中心

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	Query resource group list	Queries the 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	Query workspace member list	Queries the list of existing members in a DataWorks workspace.
ListProjects	Query workspace list	Queries the list of DataWorks workspaces under the tenant to which the current user belongs.
ListProjectIds	ListProjectIds	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	ChangeResourceManagerResourceGroup	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	GetMetaDBTableList	Retrieves all 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	GetMetaTablePartition	Retrieves a list of partitions for 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 tree categories	Queries the tree categories.
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	Query databases	Queries a list of databases.
UpdateTableModelInfo	Modify table model information	Modifies the topic, level, and physical category information 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	Delete lineage, supports deleting user-defined lineage relationships
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 field lineage	Queries the lineage of a field by calling GetMetaColumnLineage.

Data Studio

API	Title	Description
CreateFile	Create a file in dataStudio	Creates a file in DataStudio. This operation does not support creating Data Integration node tasks.
CreateUdfFile	Create a function type file in dataStudio	Creates a function type file in DataStudio.
CreateBusiness	Create a business process	Creates a business process in DataStudio for data development.
DeleteBusiness	DeleteBusiness	Deletes a workflow.
CreateFolder	CreateFolder	The operation that you want to perform. Set the value to \\\\CreateFolder\\\\.
UpdateBusiness	UpdateBusiness	Updates a workflow.
ListFiles	ListFiles	Queries a list of files.
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.
SubmitFile	SubmitFile	Submits a file to the development environment to create a corresponding task.
ListBusiness	ListBusiness	Queries a list of workflows.
GetFileVersion	GetFileVersion	Queries the information about a file version.
DeleteFolder	DeleteFolder	Deletes a folder from the Data Development page.
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.
GetDeployment	GetDeployment	Queries the information about a deployment package.
UpdateFile	Update an existing file node	Updates a created file.
GetFolder	GetFolder	You can call GetFolder to retrieve the details of a folder.
ListFileVersions	ListFileVersions	Queries a list of file versions.
GetFile	GetFile	Queries the information about a file.
ListFolders	ListFolders	Call the ListFolders operation to query for folders.
DeployFile	DeployFile	Deploys a file to the production environment.
UpdateUdfFile	Update file information of a function	Updates the file information of a function.
GetBusiness	GetBusiness	Queries the information about a workflow.
UpdateFolder	UpdateFolder	Updates a folder.
ListDeployments	ListDeployments	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	UpdateIDEEventResult	Returns the check result of an extension point event to DataStudio 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	CreateResourceFile	Creates or uploads a resource file in DataStudio. 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	CreateDISyncTask	Creates a data synchronization task.
DeleteDISyncTask	DeleteDISyncTask	Deletes a real-time synchronization task.
UpdateDISyncTask	UpdateDISyncTask	Updates a data synchronization task.
TestNetworkConnection	TestNetworkConnection	Tests the network connectivity between a data source and a resource group.
GetDataSourceMeta	GetDataSourceMeta	Queries the metadata of a specified data source.
ListDIProjectConfig	ListDIProjectConfig	Queries the default global configurations of synchronization solutions in a specified DataWorks workspace.
UpdateDIProjectConfig	UpdateDIProjectConfig	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	DeployDISyncTask	Deploys a real-time synchronization task.
GetDISyncInstanceInfo	GetDISyncInstanceInfo	Queries the status of a real-time synchronization task or a data synchronization solution.
TerminateDISyncInstance	TerminateDISyncInstance	Undeploys a real-time synchronization task.
GenerateDISyncTaskConfigForCreating	GenerateDISyncTaskConfigForCreating	Generates an ID for an asynchronous thread that is used to create a synchronization task in Data Integration.
GenerateDISyncTaskConfigForUpdating	GenerateDISyncTaskConfigForUpdating	Generates the configuration for updating a real-time synchronization task in Data Integration.
StartDISyncInstance	StartDISyncInstance	Starts a real-time synchronization task or a synchronization solution.
StopDISyncInstance	StopDISyncInstance	Stops a real-time synchronization task.
QueryDISyncTaskConfigProcessResult	QueryDISyncTaskConfigProcessResult	Queries the result of an asynchronous task for generating synchronization task configurations.
CreateDIJob	CreateDIJob	Creates a new-version synchronization task. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres and batch synchronization of all data in a MySQL database to Hive.
DeleteDIJob	DeleteDIJob	Deletes a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a 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 data synchronization from a 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 synchronization task.
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 data synchronization from a MySQL database to Hologres.
GetDIAlarmRule	GetDIAlarmRule	Retrieves the details of an alert rule configured for a synchronization task.
ListDIAlarmRules	List alert rules for 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	UpdateDIAlarmRule	Updates an alert rule for a synchronization task.

Data modeling

API	Title	Description
QueryPublicModelEngine	QueryPublicModelEngine	Retrieves information about Data Modeling objects created by using fast modeling language (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 the upstream nodes of these nodes).
ListBaselineConfigs	ListBaselineConfigs	Queries a list of baselines.
GetBaselineKeyPath	Get 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	DeleteRemind	Deletes a custom monitoring alert rule.
UpdateRemind	Update a custom alert rule	Updates a custom monitoring 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	Get event details	Retrieves the details of an event.
GetTopicInfluence	GetTopicInfluence	Queries 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	ListNodes	The ID of the workspace.
GetNodeCode	GetNodeCode	Retrieves the code of a node.
GetInstance	GetInstance	Queries the information about an instance.
ListInstances	List instances	Retrieves a list of instances.
GetInstanceLog	GetInstanceLog	Queries the logs of an instance.
StopInstance	Stop an instance	Stops an instance.
RestartInstance	Restart an instance	Restarts an instance.
SetSuccessInstance	SetSuccessInstance	Sets the state of a failed instance to successful.
SuspendInstance	Pause an instance	Pauses an instance.
ResumeInstance	ResumeInstance	Resumes a paused instance.
RunCycleDagNodes	Create a data backfill workflow	Creates a data backfill workflow by calling RunCycleDagNodes.
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	TopTenElapsedTimeInstance	Queries the ranking of the running durations of instances.
TopTenErrorTimesInstance	TopTenErrorTimesInstance	Queries the ranking of nodes on which errors occur within the previous month.
GetFileTypeStatistic	GetFileTypeStatistic	Queries the distribution of node types.
GetInstanceStatusStatistic	GetInstanceStatusStatistic	Queries the number of instances that are in each state.
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 triggered workflow.
GetDag	GetDag	Queries the information about a directed acyclic graph (DAG). You can call the GetDag operation to query the information about the DAG for a manually triggered workflow, a manually triggered node, or a data backfill instance. However, you cannot query the information about the DAG for an auto triggered node or an auto triggered workflow.
ListDags	ListDags	Calls the ListDags operation to retrieve the details of all DAGs for a single data backfill instance based on the OpSeq (unique identifier of the data backfill instance).
ListNodesByOutput	ListNodesByOutput	Queries nodes based 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 node list	Calls GetNodeChildren to retrieve the downstream node list of a node.
UpdateNodeRunMode	UpdateNodeRunMode	Freezes or unfreezes a specified node.
UpdateNodeOwner	UpdateNodeOwner	Changes the owner of a node.
UpdateWorkbenchEventResult	UpdateWorkbenchEventResult	Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension.
ListShiftPersonnels	Retrieve on-duty personnel of a shift schedule	Retrieves the list of on-duty 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 based on a baseline ID.
DeleteBaseline	DeleteBaseline	Deletes a baseline based on its ID. You can delete a baseline only if the nodes in the baseline does not have ancestor nodes. You can call the UpdateBaseline operation to delete the relationships between the nodes and their ancestor nodes.
ListBaselines	ListBaselines	Obtains a list of baselines.
CreateBaseline	CreateBaseline	Creates a baseline.
UpdateBaseline	Update baseline configuration	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	GetQualityRule	Gets information about a quality rule.
ListQualityRules	ListQualityRules	Call ListQualityRules to retrieve quality rules that match a partition expression.
CreateQualityRule	CreateQualityRule	Call CreateQualityRule to create a Quality Rule.
DeleteQualityFollower	DeleteQualityFollower	Deletes a Follower from a partition expression.
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 by calling CreateDataServiceApi.
PublishDataServiceApi	PublishDataServiceApi	Publishes an API.
DeleteDataServiceApi	DeleteDataServiceApi	Deletes a DataService API.
ListDataServiceApis	ListDataServiceApis	Queries a list of APIs in the development state.
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	Retrieve aPIs authorized to others	Retrieves the list of APIs that have been 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	GetDataServiceApplication	Retrieves the details of an application.
ListDataServiceApplications	ListDataServiceApplications	Retrieves a list of applications.
CreateDataServiceFolder	CreateDataServiceFolder	Creates a folder in DataService Studio.
GetDataServiceFolder	GetDataServiceFolder	Queries a folder.
ListDataServiceFolders	Query data service folders	Queries the list of Data Service folders.
CreateDataServiceGroup	CreateDataServiceGroup	Creates a business process.
GetDataServiceGroup	GetDataServiceGroup	Retrieves the details of a business process.
ListDataServiceGroups	Query data service business processes	Queries the list of Data Service business processes.
CreateDataServiceApiAuthority	CreateDataServiceApiAuthority	Grants the access permissions on an API in DataService Studio.
DeleteDataServiceApiAuthority	DeleteDataServiceApiAuthority	Revokes the access permissions on an 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	TestDataServiceApi	Tests a DataService Studio API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result.
GetDataServiceApiTest	GetDataServiceApiTest	Queries the test results of an API in DataService Studio.
SubmitDataServiceApi	SubmitDataServiceApi	Submits an API in DataService Studio.
SaveDataServiceApiTestResult	SaveDataServiceApiTestResult	Saves the test results of an API.

Data Security Guard

API	Title	Description
DsgQueryRowDetail	Data protection umbrella - data access - export detailed list query	Exports a row-level detailed list query.
DsgQueryDetails	Data shield - data access - export query	Exports detailed query results.
DsgGetVisitStat	Query data access behavior records	Queries access records for data access.
DsgGetVisitDetail	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	GetOpSensitiveData	Queries the records that are generated on a specified date for access to sensitive data in all the DataWorks workspaces of a tenant.
DesensitizeData	Mask data	Submits data for masking and returns the masked result.
GetOpRiskData	GetOpRiskData	Queries the records that are generated on a specified date for access to the high-risk sensitive data in all the DataWorks workspaces of a tenant.
GetSensitiveData	GetSensitiveData	Queries the latest sensitive data in all the DataWorks workspaces of a tenant.
ScanSensitiveData	ScanSensitiveData	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 template	Queries the default data classification template defined by Data Security Guard.
DsgStopSensIdentify	DsgStopSensIdentify	Stops a sensitive data identification task.
QuerySensClassification	QuerySensClassification	Queries data categories.
QuerySensLevel	QuerySensLevel	Queries data sensitivity levels in Data Security Guard.
QueryRecognizeRulesType	QueryRecognizeRulesType	Queries the built-in sensitive data identification rule that is used to configure a sensitive field.
DsgRunSensIdentify	DsgRunSensIdentify	Starts a sensitive data identification task in Data Security Guard.
DeleteRecognizeRule	DeleteRecognizeRule	Deletes sensitive field types.
QuerySensNodeInfo	QuerySensNodeInfo	Queries sensitive data identification rules.
AddRecognizeRule	AddRecognizeRule	Adds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.
EditRecognizeRule	EditRecognizeRule	Edits a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.
QueryRecognizeDataByRuleType	Query the list of sensitive field recognition methods	Queries the list of sensitive field recognition methods in Data Protection Umbrella by calling the QueryRecognizeDataByRuleType operation.
QueryRecognizeRuleDetail	QueryRecognizeRuleDetail	Retrieves the details of a specified sensitive field in Data Security Guard.
DsgUserGroupGetOdpsRoleGroups	DsgUserGroupGetOdpsRoleGroups	Queries a list of MaxCompute roles that can be selected by the members of a user group when the user group is created or modified by the tenant in Data Security Guard.
DsgDesensPlanAddOrUpdate	DsgDesensPlanAddOrUpdate	Call the `DsgDesensPlanAddOrUpdate` API to create or edit a data desensitization 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 a data masking whitelist.
DsgSceneAddOrUpdateScene	DsgSceneAddOrUpdateScene	Adds or modifies a level-2 data masking scenario.
DsgSceneQuerySceneListByName	DsgSceneQuerySceneListByName	Call the `DsgSceneQuerySceneListByName` API to retrieve a list of data masking scenarios.
DsgUserGroupAddOrUpdate	DsgUserGroupAddOrUpdate	Creates or updates a user group in Data Security Guard.
DsgUserGroupQueryList	DsgUserGroupQueryList	Call `DsgUserGroupQueryList` to query user groups in Data Security Guard (DSG).
DsgUserGroupQueryUserList	DsgUserGroupQueryUserList	Queries a list of users or roles of the current tenant.
DsgDesensPlanQueryList	DsgDesensPlanQueryList	Call the `DsgDesensPlanQueryList` API to query Data Security Guard's (DSG) data masking rules.
DsgWhiteListAddOrUpdate	DsgWhiteListAddOrUpdate	Adds or modifies a data masking whitelist.
DsgQueryDefaultTemplates	DsgQueryDefaultTemplates	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. The import task contains the import packages of data sources, nodes, 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	ListMigrations	Queries a list of 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 order	Queries the details of a permission application order. Note: The 2020 version of OpenAPI will be discontinued. Migrate to the 2024 version of OpenAPI as soon as possible: GetApplicationContents/GetProcessInstance.
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 request order	Approves a permission request order. Note: The 2020 edition of OpenAPI will be discontinued. Migrate to the 2024 edition of OpenAPI as soon as possible — ApproveProcessInstance.
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 program for an extension point event	Returns the check result of an extension program for an extension point event to the DataWorks platform by calling the CallbackExtension operation when an extension point is triggered during the use of the DataWorks platform.
ListCheckProcesses	Query the check list of extension events	Queries the check list of extension events.

Others

API	Title	Description
UpdateTableAddColumn	Update table column information	Updates the column information of a MaxCompute table.
GetMetaTableFullInfo	Retrieve complete table information including field information	Retrieves the complete information about a table, including field information.
GetDDLJobStatus	Get DDL job status	Retrieves the status of tasks for creating, updating, and deleting tables.
DeleteTable	DeleteTable	Deletes a MaxCompute table.
UpdateTable	UpdateTable	Updates a MaxCompute table.
CreateTable	CreateTable	Creates a MaxCompute table.
CheckFileDeployment	Check file deployment	Returns the check result of a file pending deployment to DataWorks. After a file created on the DataWorks DataStudio page is submitted, the file enters the deployment check state. DataWorks returns a file deployment check event to you, and you need to determine whether the file can proceed with deployment verification based on the event content. You can call this operation to return the check result of the file pending deployment 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	Queries the configurations of submodules in a workspace. You can query information about SPARK parameters.
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 labels for an entity	Sets labels 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 O&M 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 dag information	Queries the information of upstream and downstream nodes. Only one level can be queried.
GetInstanceStatusCount	GetInstanceStatusCount	Queries the statistics of instances in different states.
ListProgramTypeCount	ListProgramTypeCount	Queries the distribution of different types of nodes.
GetManualDagInstances	Query information about manually triggered workflow instances	Queries information about instances of a manually triggered workflow.
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.