All Products
Search
Document Center

DataWorks:List of operations by function

Last Updated:Dec 03, 2024
This product(dataworks-public/2020-05-18) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Tenant

APITitleDescription
ListCalcEnginesListCalcEnginesQueries a list of compute engines that are associated with a DataWorks workspace.
CreateDataSourceCreateDataSourceAdds a data source to DataWorks.
ListDataSourcesListDataSourcesQueries the data sources added to a DataWorks workspace.
UpdateDataSourceUpdateDataSourceUpdates a data source.
DeleteDataSourceDeleteDataSourceRemoves a data source.
ListResourceGroupsListResourceGroupsQueries a list of resource groups of a specific type.
GetProjectGetProjectQueries the information about a DataWorks workspace.
AddProjectMemberToRoleAddProjectMemberToRoleAssigns a role to a member of a DataWorks workspace. Before you call this operation, you must add your account to a DataWorks workspace as a member.
CreateProjectMemberCreateProjectMemberAdds a user to a DataWorks workspace.
DeleteProjectMemberDeleteProjectMemberRemoves a user from a DataWorks workspace.
ListProjectRolesListProjectRolesQueries a list of roles in a DataWorks workspace.
RemoveProjectMemberFromRoleRemoveProjectMemberFromRoleRemoves a role from a user in a DataWorks workspace.
ListProjectMembersListProjectMembersQueries a list of existing members in a DataWorks workspace.
ListProjectsListProjectsQueries a list of DataWorks workspaces of the tenant to which a user belongs.
ListProjectIdsListProjectIdsQueries the IDs of the workspaces on which a specific Alibaba Cloud account or RAM user has permissions in a specific region.
CreateProjectCreateProjectCreates a DataWorks workspace.
ChangeResourceManagerResourceGroupChangeResourceManagerResourceGroupChanges the resource group to which a resource belongs.
ListMeasureDataListMeasureDataQueries 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

APITitleDescription
GetMetaDBInfoGetMetaDBInfoQueries the basic metadata information about a compute engine instance.
GetMetaDBTableListGetMetaDBTableListQueries metatables in a compute engine instance.
CheckMetaTableCheckMetaTableChecks whether a metatable exists.
CheckMetaPartitionCheckMetaPartitionChecks whether a partition in a MaxCompute metatable exists.
SearchMetaTablesSearchMetaTablesQueries metatables based on specific conditions.
GetMetaTableBasicInfoGetMetaTableBasicInfoQueries the basic information about a metatable.
GetMetaTableColumnGetMetaTableColumnQueries the field information of a metatable.
GetMetaTablePartitionGetMetaTablePartitionObtains a list of partitions in a metatable.
GetMetaTableOutputGetMetaTableOutputQueries the output information of a metatable.
GetMetaTableChangeLogGetMetaTableChangeLogQueries the change logs of a metatable.
GetMetaTableIntroWikiGetMetaTableIntroWikiQueries the instructions on how to use a table.
CreateMetaCategoryCreateMetaCategoryCreates a category.
DeleteMetaCategoryDeleteMetaCategoryDeletes a category.
UpdateMetaCategoryUpdateMetaCategoryUpdates a category.
GetMetaCategoryGetMetaCategoryQueries the information about a category tree.
GetMetaTableListByCategoryGetMetaTableListByCategoryQueries metatables in a specified category.
AddToMetaCategoryAddToMetaCategoryAdds a metatable to a specified category.
DeleteFromMetaCategoryDeleteFromMetaCategoryRemoves a table from a specified category.
UpdateMetaTableUpdateMetaTableUpdates the metadata information about a table. Only MaxCompute tables are supported.
UpdateMetaTableIntroWikiUpdateMetaTableIntroWikiUpdates the instructions on how to use a table. If no instruction on how to use the table is available, the instructions that are configured by calling this operation are added.
ListMetaDBListMetaDBQueries a list of metadatabases.
UpdateTableModelInfoUpdateTableModelInfoModifies the information about a table, such as the table folder, level, and category.
CreateTableThemeCreateTableThemeCreates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.
DeleteTableThemeDeleteTableThemeDeletes a table theme. This operation will be replaced soon. We recommend that you do not call this operation.
UpdateTableThemeUpdateTableThemeUpdates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.
ListTableThemeListTableThemeQueries a list of table themes. This operation will be replaced soon. We recommend that you do not call this operation.
GetMetaTableThemeLevelGetMetaTableThemeLevelQueries the information about the themes and levels of a metatable.
CreateTableLevelCreateTableLevelCreates a table level. This operation will be replaced soon. We recommend that you do not call this operation.
UpdateTableLevelUpdateTableLevelUpdates a table level. This operation will be replaced soon. We recommend that you do not call this operation.
DeleteTableLevelDeleteTableLevelDeletes a table level. This operation will be replaced soon. We recommend that you do not call this operation.
ListTableLevelListTableLevelQueries a list of table levels. This operation will be replaced soon. We recommend that you do not call this operation.
UpdateMetaCollectionUpdateMetaCollectionUpdates the name and comment of a collection.
ListMetaCollectionsListMetaCollectionsQueries information about collections. Collections include data albums that are displayed on the Data Map page and categories that are created in the data albums. You can call this API operation to query collections by type.
ListMetaCollectionEntitiesListMetaCollectionEntitiesQueries the entities in a collection.
DeleteMetaCollectionDeleteMetaCollectionDeletes a collection.
GetMetaCollectionDetailGetMetaCollectionDetailQueries the information about a collection.
DeleteMetaCollectionEntityDeleteMetaCollectionEntityDeletes an entity from a collection.
AddMetaCollectionEntityAddMetaCollectionEntityAdds an entity to a collection.
CreateMetaCollectionCreateMetaCollectionCreates a collection.
ListLineageListLineageQueries the ancestor or descendant lineage of an entity.
DeleteLineageRelationDeleteLineageRelationDeletes the lineage between entities. You can call this operation to delete only custom lineages that are registered by users.
RegisterLineageRelationRegisterLineageRelationRegisters the lineage between self-managed entities to DataWorks.

Data Development

APITitleDescription
CreateFileCreateFileCreates a file in DataStudio. You cannot call this operation to create files for Data Integration nodes.
CreateUdfFileCreateUdfFileCreates a file for a function in DataStudio.
DeleteBusinessDeleteBusinessDeletes a workflow.
CreateFolderCreateFolderThe operation that you want to perform. Set the value to \*\*CreateFolder\*\*.
UpdateBusinessUpdateBusinessUpdates a workflow.
ListFilesListFilesQueries a list of files.
EstablishRelationTableToBusinessEstablishRelationTableToBusinessImports 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.
SubmitFileSubmitFileCommits a file to the development environment of the scheduling system to generate a task.
ListBusinessListBusinessQueries a list of workflows.
GetFileVersionGetFileVersionQueries the information about a file version.
DeleteFolderDeleteFolderDeletes a folder from DataStudio.
DeleteFileDeleteFileDeletes 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.
GetDeploymentGetDeploymentQueries the information about a deployment package.
UpdateFileUpdateFileUpdates a file.
GetFolderGetFolderQueries the information about a folder.
ListFileVersionsListFileVersionsQueries a list of file versions.
GetFileGetFileQueries the information about a file.
ListFoldersListFoldersQueries a list of folders.
DeployFileDeployFileDeploys a file to the production environment.
UpdateUdfFileUpdateUdfFileUpdates the file information about a function.
GetBusinessGetBusinessQueries the information about a workflow.
UpdateFolderUpdateFolderUpdates a folder.
ListDeploymentsListDeploymentsQueries 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.
UpdateIDEEventResultUpdateIDEEventResultReturns 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.
GetIDEEventDetailGetIDEEventDetailQueries 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.

Data Integration

APITitleDescription
CreateDISyncTaskCreateDISyncTaskCreates a data synchronization task.
DeleteDISyncTaskDeleteDISyncTaskDeletes a synchronization task. You can call this operation to delete only a real-time synchronization task.
UpdateDISyncTaskUpdateDISyncTaskUpdates a data synchronization task.
TestNetworkConnectionTestNetworkConnectionTests the network connectivity between a data source and a resource group.
GetDataSourceMetaGetDataSourceMetaQueries the metadata of a specified data source.
ListDIProjectConfigListDIProjectConfigQueries the default global configurations of synchronization solutions in a specified DataWorks workspace.
UpdateDIProjectConfigUpdateDIProjectConfigModifies the default global configuration of synchronization solutions in a DataWorks workspace.
GetDISyncTaskGetDISyncTaskQueries the details of a real-time synchronization task or a data synchronization solution.
DeployDISyncTaskDeployDISyncTaskDeploys a real-time synchronization task.
GetDISyncInstanceInfoGetDISyncInstanceInfoQueries the status of a real-time synchronization task or a data synchronization solution.
TerminateDISyncInstanceTerminateDISyncInstanceUndeploys a real-time synchronization task.
GenerateDISyncTaskConfigForCreatingGenerateDISyncTaskConfigForCreatingGenerates an ID for an asynchronous thread that is used to create a synchronization task in Data Integration.
GenerateDISyncTaskConfigForUpdatingGenerateDISyncTaskConfigForUpdatingGenerates the JSON for an asynchronous thread that is used to update a real-time synchronization task in Data Integration.
StartDISyncInstanceStartDISyncInstanceStarts a real-time synchronization task or a synchronization solution.
StopDISyncInstanceStopDISyncInstanceStops a real-time synchronization task.
QueryDISyncTaskConfigProcessResultQueryDISyncTaskConfigProcessResultQueries the execution results of an asynchronous task.
CreateDIJobCreateDIJobCreates a synchronization task of a new version in Data Integration. 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.
DeleteDIJobDeleteDIJobDeletes 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.
GetDIJobGetDIJobQueries 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.
ListDIJobsListDIJobsQueries a list of new-version synchronization tasks. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.
StartDIJobStartDIJobStarts 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.
StopDIJobStopDIJobStops 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.
UpdateDIJobUpdateDIJobUpdates a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.
CreateDIAlarmRuleCreateDIAlarmRuleCreates 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.
DeleteDIAlarmRuleDeleteDIAlarmRuleDeletes 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.
GetDIAlarmRuleGetDIAlarmRuleQueries the details of 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.
ListDIAlarmRulesListDIAlarmRulesQueries a list of alert rules for a new-version synchronization task. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.
UpdateDIAlarmRuleUpdateDIAlarmRuleUpdates an alert rule for a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.

Data Modeling

APITitleDescription
QueryPublicModelEngineQueryPublicModelEngineQueries information about objects that are created in Data Modeling by using fast modeling language (FML) statements.

Operation Center

APITitleDescription
GetAlertMessageGetAlertMessageQueries alert information based on the alert ID that is specified by the AlertId parameter.
ListAlertMessagesListAlertMessagesQueries a list of alerts.
GetBaselineConfigGetBaselineConfigQueries the configurations of a baseline.
ListNodesByBaselineListNodesByBaselineQueries nodes in a baseline.
ListBaselineConfigsListBaselineConfigsQueries a list of baselines.
GetBaselineKeyPathGetBaselineKeyPathThe information about the events that are associated with the instance.
GetBaselineStatusGetBaselineStatusQueries the details of a baseline instance.
ListBaselineStatusesListBaselineStatusesQueries a list of baseline instances.
DeleteRemindDeleteRemindDeletes a custom alert rule.
UpdateRemindUpdateRemindModifies a custom alert rule.
CreateRemindCreateRemindCreates a custom alert rule.
GetRemindGetRemindQueries the information about a custom alert rule.
ListRemindsListRemindsQueries a list of custom alert rules.
ListTopicsListTopicsQueries events.
GetTopicGetTopicQueries the information about an event.
GetNodeGetNodeIndicates whether the request is successful.
ListNodeInputOrOutputListNodeInputOrOutputQueries the input or output information of a node.
ListNodesListNodesThe ID of the workspace.
GetNodeCodeGetNodeCodeQueries the code of a node.
GetInstanceGetInstanceQueries the information about an instance.
ListInstancesListInstancesThe ID of the directed acyclic graph (DAG). You can set this parameter to the value of the DagId parameter returned by the \[RunCycleDagNodes]\(~~212961~~), \[RunSmokeTest]\(~~212949~~), or \[RunManualDagNodes]\(~~212830~~) operation based on your business requirements. The RunManualDagNodes operation is used to backfill data, the RunSmokeTest operation is used to perform smoke testing, and the RunManualDagNodes operation is used to run nodes in a manually triggered workflow.
GetInstanceLogGetInstanceLogQueries the logs of an instance.
StopInstanceStopInstanceTerminates an instance.
RestartInstanceRestartInstanceRestarts an instance.
SetSuccessInstanceSetSuccessInstanceSets the state of a failed instance to successful.
SuspendInstanceSuspendInstanceSuspends an instance.
ResumeInstanceResumeInstanceResumes a suspended instance.
RunCycleDagNodesRunCycleDagNodesCreates a workflow to backfill data.
RunSmokeTestRunSmokeTestCreates a workflow to perform smoke testing.
ListSuccessInstanceAmountListSuccessInstanceAmountQueries the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day.
ListInstanceAmountListInstanceAmountQueries the trend of the number of auto triggered node instances within a specified period of time.
TopTenElapsedTimeInstanceTopTenElapsedTimeInstanceQueries the ranking of the running durations of instances.
TopTenErrorTimesInstanceTopTenErrorTimesInstanceQueries the ranking of nodes on which errors occur within the previous month.
GetFileTypeStatisticGetFileTypeStatisticQueries the distribution of node types.
GetInstanceStatusStatisticGetInstanceStatusStatisticQueries the number of instances that are in each state.
ListFileTypeListFileTypeQueries the information about node types, such as the code and name.
RunManualDagNodesRunManualDagNodesRuns nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find a manually triggered workflow in Operation Center only after the manually triggered workflow is committed and deployed.
ListManualDagInstancesListManualDagInstancesQueries the information about instances in a manually triggered workflow.
GetDagGetDagQueries 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.
ListDagsListDagsQueries the details of directed acyclic graphs (DAGs) for a single data backfill instance based on OpSeq.
ListNodesByOutputListNodesByOutputQueries nodes based on the output of the nodes.
RunTriggerNodeRunTriggerNodeRuns a manually triggered node.
GetNodeParentsGetNodeParentsQueries the ancestor nodes of a node.
GetNodeChildrenGetNodeChildrenQueries a list of instances.
UpdateNodeRunModeUpdateNodeRunModeFreezes or unfreezes a node.
UpdateNodeOwnerUpdateNodeOwnerChanges the owner of a node.
UpdateWorkbenchEventResultUpdateWorkbenchEventResultReturns the processing result sent by an extension after a process in Operation Center is blocked by the extension.
ListShiftPersonnelsListShiftPersonnelsQueries a list of on-duty engineers in a shift schedule.
ListShiftSchedulesListShiftSchedulesQueries a list of shift schedules in Operation Center.
ListInstanceHistoryListInstanceHistoryQueries information about the historical records of all instances. One historical record is generated if an instance is rerun once.
ListInnerNodesListInnerNodesQueries information about inner nodes. For example, you can call this operation to query the inner nodes of a node group or a do-while node. You cannot call this operation to query the inner nodes of a PAI node.
OfflineNodeOfflineNodeUndeploys a node.
GetBaselineGetBaselineQueries the information about a baseline based on its ID.
DeleteBaselineDeleteBaselineDeletes 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.
ListBaselinesListBaselinesObtains a list of baselines.
CreateBaselineCreateBaselineCreates a baseline.
UpdateBaselineUpdateBaseline

Data Quality

APITitleDescription
UpdateQualityFollowerUpdateQualityFollowerUpdates a subscription relationship.
UpdateQualityRuleUpdateQualityRuleUpdates a monitoring rule.
GetQualityRuleGetQualityRuleQueries the information about a monitoring rule.
ListQualityRulesListQualityRulesQueries monitoring rules based on a partition filter expression.
CreateQualityRuleCreateQualityRuleCreates a monitoring rule.
DeleteQualityFollowerDeleteQualityFollowerDeletes a subscriber of a partition filter expression.
DeleteQualityRuleDeleteQualityRuleDeletes a monitoring rule.
CreateQualityFollowerCreateQualityFollowerCreates a subscriber for a partition filter expression.
DeleteQualityEntityDeleteQualityEntityDeletes a partition filter expression.
GetQualityEntityGetQualityEntityQueries the information about a partition filter expression.
CreateQualityEntityCreateQualityEntityCreates a partition filter expression.
CreateQualityRelativeNodeCreateQualityRelativeNodeAssociates a node with a partition filter expression.
DeleteQualityRelativeNodeDeleteQualityRelativeNodeDisassociates a node from a partition filter expression.
ListQualityResultsByEntityListQualityResultsByEntityQueries a list of historical check results based on a partition filter expression.
ListQualityResultsByRuleListQualityResultsByRuleQueries monitoring results after the data quality of a data source or a compute engine is monitored based on monitoring rules.

DataService Studio

APITitleDescription
CreateDataServiceApiCreateDataServiceApiCreates an API.
PublishDataServiceApiPublishDataServiceApiPublishes an API.
DeleteDataServiceApiDeleteDataServiceApiDeletes an API in DataService Studio.
ListDataServiceApisListDataServiceApisQueries a list of APIs in the development state.
GetDataServiceApiGetDataServiceApiQueries the details of a DataService Studio API in the development state.
UpdateDataServiceApiUpdateDataServiceApiUpdates the information about an API in the development state in DataService Studio.
GetDataServicePublishedApiGetDataServicePublishedApiQueries the information about a DataService Studio API in the published state.
ListDataServicePublishedApisListDataServicePublishedApisQueries a list of APIs in the published state.
ListDataServiceApiAuthoritiesListDataServiceApiAuthoritiesQueries the APIs on which other users are granted the access permissions.
ListDataServiceAuthorizedApisListDataServiceAuthorizedApisQueries the APIs that you are authorized to access.
AbolishDataServiceApiAbolishDataServiceApiUnpublishes a DataService Studio API.
GetDataServiceApplicationGetDataServiceApplicationQueries the details of an application.
ListDataServiceApplicationsListDataServiceApplicationsQueries the basic information of applications.
CreateDataServiceFolderCreateDataServiceFolderCreates a folder in DataService Studio.
GetDataServiceFolderGetDataServiceFolderQueries a folder.
ListDataServiceFoldersListDataServiceFoldersQueries folders.
CreateDataServiceGroupCreateDataServiceGroupCreates a business process.
GetDataServiceGroupGetDataServiceGroupQueries a business process.
ListDataServiceGroupsListDataServiceGroupsQueries business processes.
CreateDataServiceApiAuthorityCreateDataServiceApiAuthorityGrants the access permissions on an API in DataService Studio.
DeleteDataServiceApiAuthorityDeleteDataServiceApiAuthorityRevokes the access permissions on an API.
ListDataServiceApiTestListDataServiceApiTestQueries the test records of a DataService Studio API. This API operation allows you to query only the test records that are generated within the previous month.
TestDataServiceApiTestDataServiceApiTests a DataService Studio API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result.
SubmitDataServiceApiSubmitDataServiceApiSubmits an API in DataService Studio.
SaveDataServiceApiTestResultSaveDataServiceApiTestResultSaves the test results of an API.

DataAnalysis

APITitleDescription
UmountDirectoryUmountDirectoryRemoves a directory from the left-side navigation pane of DataAnalysis.
MountDirectoryMountDirectoryAdds a directory to the left-side navigation pane of DataAnalysis.

Data Security Guard

APITitleDescription
GetOpSensitiveDataGetOpSensitiveDataQueries the records that are generated on a specified date for access to sensitive data in all the DataWorks workspaces of a tenant.
DesensitizeDataDesensitizeDataMasks data.
GetOpRiskDataGetOpRiskDataQueries 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.
GetSensitiveDataGetSensitiveDataQueries the latest sensitive data in all the DataWorks workspaces of a tenant.
ScanSensitiveDataScanSensitiveDataChecks whether input data contains sensitive data.
DsgQuerySensResultDsgQuerySensResultQueries the identification results of sensitive data.
QueryDefaultTemplateQueryDefaultTemplateQueries the default data category and data sensitivity level template defined by Data Security Guard.
DsgStopSensIdentifyDsgStopSensIdentifyStops a sensitive data identification task.
QuerySensClassificationQuerySensClassificationQueries data categories.
QuerySensLevelQuerySensLevelQueries data sensitivity levels in Data Security Guard.
QueryRecognizeRulesTypeQueryRecognizeRulesTypeQueries the built-in sensitive data identification rule that is used to configure a sensitive field.
DsgRunSensIdentifyDsgRunSensIdentifyStarts a sensitive data identification task in Data Security Guard.
DeleteRecognizeRuleDeleteRecognizeRuleDeletes sensitive field types.
QuerySensNodeInfoQuerySensNodeInfoQueries sensitive data identification rules.
AddRecognizeRuleAddRecognizeRuleAdds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.
EditRecognizeRuleEditRecognizeRuleEdits a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.
QueryRecognizeDataByRuleTypeQueryRecognizeDataByRuleTypeQueries the type of a sensitive data identification rule.
QueryRecognizeRuleDetailQueryRecognizeRuleDetailQueries the details of a specified sensitive field in Data Security Guard.
DsgUserGroupGetOdpsRoleGroupsDsgUserGroupGetOdpsRoleGroupsQueries 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.
DsgDesensPlanAddOrUpdateDsgDesensPlanAddOrUpdateAdds or modifies a data masking rule.
DsgPlatformQueryProjectsAndSchemaFromMetaDsgPlatformQueryProjectsAndSchemaFromMetaQueries a list of compute engines of different types in the current tenant.
DsgUserGroupDeleteDsgUserGroupDeleteDeletes a user group configured in Data Security Guard.
DsgWhiteListDeleteListDsgWhiteListDeleteListDeletes a data masking whitelist configured in Data Security Guard.
DsgScenedDeleteSceneDsgScenedDeleteSceneDeletes a level-2 data masking scenario created in Data Security Guard.
DsgDesensPlanDeleteDsgDesensPlanDeleteDeletes a data masking rule created in Data Security Guard.
DsgDesensPlanUpdateStatusDsgDesensPlanUpdateStatusModifies the status of a data masking rule.
DsgWhiteListQueryListDsgWhiteListQueryListQueries a data masking whitelist.
DsgSceneAddOrUpdateSceneDsgSceneAddOrUpdateSceneAdds or modifies a level-2 data masking scenario.
DsgSceneQuerySceneListByNameDsgSceneQuerySceneListByNameQueries a list of data masking scenarios.
DsgUserGroupAddOrUpdateDsgUserGroupAddOrUpdateAdds or modifies a user group.
DsgUserGroupQueryListDsgUserGroupQueryListQueries a list of user groups in Data Security Guard.
DsgUserGroupQueryUserListDsgUserGroupQueryUserListQueries a list of users or roles of the current tenant.
DsgDesensPlanQueryListDsgDesensPlanQueryListQueries a list of data masking rules.
DsgWhiteListAddOrUpdateDsgWhiteListAddOrUpdateAdds or modifies a data masking whitelist.
DsgQueryDefaultTemplatesDsgQueryDefaultTemplatesQueries a list of available sensitive field type templates and the data masking rules supported by the templates. You can refer to the response parameters of this operation to configure a data masking rule.

Migration Assistant

APITitleDescription
CreateImportMigrationCreateImportMigrationCreates an import task. The import task contains the import packages of data sources, nodes, and tables.
GetMigrationProcessGetMigrationProcessQueries the progress of a migration task.
StartMigrationStartMigrationStarts a migration task.
CreateExportMigrationCreateExportMigrationCreates an export task. You can use this operation to create an export task but cannot use this operation to start the created export task.
GetMigrationSummaryGetMigrationSummaryQueries the information about a migration task.
ListMigrationsListMigrationsQueries a list of migration tasks.

Security Center

APITitleDescription
CreatePermissionApplyOrderCreatePermissionApplyOrderCreates a permission request order.
GetPermissionApplyOrderDetailGetPermissionApplyOrderDetailQueries the details of a permission request order.
ListPermissionApplyOrdersListPermissionApplyOrdersQueries a list of permission request orders.
ApprovePermissionApplyOrderApprovePermissionApplyOrderProcesses a permission request order.
RevokeColumnPermissionRevokeColumnPermissionRevokes permissions on table fields from a user.
RevokeTablePermissionRevokeTablePermissionRevokes permissions on a table from a user.
RevokeTablePermissionRevokeTablePermission

Open platform

APITitleDescription
ListExtensionsListExtensionsQueries a list of extensions.
GetExtensionGetExtensionQueries the details of an extension.
GetOptionValueForProjectGetOptionValueForProjectQueries the option settings of an extension in a workspace.
ListEnabledExtensionsForProjectListEnabledExtensionsForProjectQueries a list of built-in and custom extensions that are enabled in a workspace.
CallbackExtensionCallbackExtensionSends the processing result of an extension point event by an extension to DataWorks.

Abandoned API

APITitleDescription
ListEntitiesByTagsListEntitiesByTagsQueries a list of entities by tag. Only entities of the maxcompute-table type are supported.
RemoveEntityTagsRemoveEntityTagsRemoves tags from an entity. Only entities of the maxcompute-table type are supported.
SetEntityTagsSetEntityTagsConfigures tags for an entity. Only entities of the maxcompute-table type are supported.
ListEntityTagsListEntityTagsQueries a list of tags of an entity. Only entities of the maxcompute-table type are supported.