This topic describes the applicable scopes, billing rules, and call limits of DataWorks API operations and lists the DataWorks API operations by function.
Applicable scopes
- Applicable editions: DataWorks Enterprise Edition and DataWorks Ultimate Edition
- Applicable regions: China (Hangzhou), China (Shanghai), China (Shenzhen), China (Beijing), China (Zhangjiakou), China North 2 Ali Gov, China East 2 Finance, China (Chengdu), China (Hong Kong), Singapore (Singapore), Indonesia (Jakarta), US (Silicon Valley), India (Mumbai), US (Virginia), Germany (Frankfurt), UK (London), Japan (Tokyo), Australia (Sydney), and Malaysia (Kuala Lumpur)
Billing rules
DataWorks provides a free quota for you to call API operations. After you use up the
free quota, you are charged based on the pay-as-you-go billing method. The following
table describes the billing rules for different editions of DataWorks.
| Item | Enterprise edition | Ultimate Edition |
|---|---|---|
| Free quota | 1 million calls per month | 10 million calls per month |
| Pricing based on the pay-as-you-go billing method | USD 0.05 per 10,000 calls | |
DataWorks provides a free quota for you to call API operations in each calendar month in each region. This free quota is shared by your Alibaba Cloud account and RAM users within your Alibaba Cloud account. After the free quota is used up, you are charged USD 0.05 per 10,000 calls for additional API requests that you make.
Call limits
DataWorks API operations are classified into three levels to standardize API operation
calls and ensure system stability. For more information, see List of operations by function. The following table describes the call limits of API operations at different levels.
| Level | Call limit |
|---|---|
| Level 1 | QPS1 ≤ 50 |
| Level 2 | QPS1 ≤ 20 |
| Level 3 | QPS1 ≤ 5 and the total number of daily calls2 ≤ 10,000 |
Note:
- 1: the total queries per second (QPS) for all API operations at the specific level in each region for an Alibaba Cloud account and RAM users within the Alibaba Cloud account.
- 2: the total number of daily calls for all API operations at Level 3 in each region for an Alibaba Cloud account and RAM users within the Alibaba Cloud account.
List of operations by function
The following tables list the API operations available for use in DataWorks. The API
operations are related to tenants, metadata, DataStudio, Data Integration, Data Modeling,
Operation Center, Data Quality, DataService Studio, Data Security Guard, Migration
Assistant, and Security Center. For information about how to call API operations to
develop data in DataWorks, see Sample calls to DataWorks API operations.
- Tenants
Operation Description Level ListCalcEngines Queries compute engine instances. Level 2 CreateDataSource Adds a data source to DataWorks. Level 2 ListDataSources Queries the data sources of DataWorks. Level 3 UpdateDataSource Updates a data source. Level 2 DeleteDataSource Deletes a data source. Level 2 ListResourceGroups Queries resource groups. Level 1 GetProject Queries the information about a DataWorks workspace. Level 1 AddProjectMemberToRole Assigns a role to a member of a DataWorks workspace. Before you call this operation, you must add a user as a member to the DataWorks workspace. Level 2 CreateProjectMember Adds a user to a DataWorks workspace. Level 2 DeleteProjectMember Removes a user from a DataWorks workspace. Level 2 ListProjectRoles Queries roles in a DataWorks workspace. Level 1 RemoveProjectMemberFromRole Removes a role from a user in a DataWorks workspace. Level 2 ListProjectMembers Queries members in a DataWorks workspace. Level 1 ListProjects Queries the DataWorks workspaces of the tenant to which a user belongs by page. Level 1 ListProjectIds Queries the IDs of the DataWorks workspaces on which a specific Alibaba Cloud account or RAM user has permissions. Level 1 - Metadata
Operation Description Level GetMetaDBInfo Queries the basic metadata information about a compute engine instance. Level 1 GetMetaDBTableList Queries metatables in a compute engine instance. Level 1 CheckMetaTable Checks whether a metatable exists. Level 1 CheckMetaPartition Checks whether a partition exists in a metatable. Level 1 SearchMetaTables Queries metatables based on specific conditions. Level 1 GetMetaTableBasicInfo Queries the basic information about a metatable. Level 1 GetMetaTableColumn Queries the field information about a metatable. Level 1 GetMetaTablePartition Queries the partitions of a metatable. Level 1 GetMetaTableOutput Queries the output information in a metatable. Level 1 GetMetaTableChangeLog Queries the change logs of a metatable. Level 1 GetMetaTableIntroWiki Queries the instructions on how to use a metatable. Level 1 GetMetaTableLineage Queries the lineage of a metatable. Level 1 GetMetaColumnLineage Queries the lineage of a field in a metatable. Level 2 CreateMetaCategory Creates a category. Level 2 DeleteMetaCategory Deletes a category. Level 2 UpdateMetaCategory Updates a category. Level 2 GetMetaCategory Queries a category tree. Level 1 GetMetaTableListByCategory Queries metatables in a specific category. Level 1 AddToMetaCategory Adds a metatable to a specific category. Level 2 DeleteFromMetaCategory Removes a metatable from a specific category. Level 2 CreateTable Creates a MaxCompute table. Level 3 UpdateTable Updates a MaxCompute table. Level 2 UpdateTableAddColumn Updates the fields in a MaxCompute table. Level 3 DeleteTable Deletes a MaxCompute table. Level 2 GetDDLJobStatus Queries the status of a table creation, update, or deletion task. Level 1 UpdateMetaTable Updates the metadata information about a table. Level 2 UpdateMetaTableIntroWiki Updates the instructions on how to use a metatable. If no instruction on how to use the metatable is available, the instructions that are specified by calling this operation are added. Level 2 ListMetaDB Queries metadatabases. Level 1 UpdateTableModelInfo Updates the information about a table, such as the theme, level, and category. Level 2 CreateTableTheme Creates a table theme. Level 2 DeleteTableTheme Deletes a table theme. Level 2 UpdateTableTheme Updates a table theme. Level 2 ListTableTheme Queries table themes. Level 1 CreateTableLevel Creates a table level. Level 2 DeleteTableLevel Deletes a table level. Level 2 UpdateTableLevel Updates a table level. Level 2 ListTableLevel Queries table levels. Level 1 - DataStudio
Operation Description Level CreateFile Creates a file in DataStudio. Level 3 CreateUdfFile Creates a file for a function in DataStudio. Level 2 CreateBusiness Creates a workflow. Level 2 DeleteBusiness Deletes a workflow. Level 3 CreateFolder Creates a folder. Level 2 UpdateBusiness Updates a workflow. Level 2 ListFiles Queries files. Level 1 EstablishRelationTableToBusiness Imports a table to a workflow. A call of this API operation is equivalent to the following operations: Go to the DataStudio page, find the workflow to which you want to import a table in the Scheduled Workflow pane, and then click the workflow name. Click the MaxCompute folder, right-click the Table folder, and then select Import Table. Level 2 SubmitFile Commits a file to the development environment of the scheduling system to generate a node. Level 3 ListBusiness Queries workflows. Level 1 GetFileVersion Queries the details of a file version. Level 1 DeleteFolder Deletes a folder from DataStudio. Level 3 DeleteFile Deletes a file from DataStudio. Level 3 GetDeployment Queries the details of a deployment task. Level 1 UpdateFile Updates a file. Level 2 GetFolder Queries the details of a folder. Level 1 ListFileVersions Queries file versions. Level 1 GetFile Queries the details of a file. Level 1 ListFolders Queries folders. Level 1 DeployFile Deploys a file to the production environment. Level 3 UpdateUdfFile Updates the file information about a function. Level 2 GetBusiness Queries the details of a workflow. Level 1 UpdateFolder Updates the information about a folder. Level 2 CheckFileDeployment Returns the check events of a file. After you commit your file that is created on the DataStudio page, the system checks the file and returns check events before the system deploys the file. You must determine whether the check can be continued based on the events. Level 1 ListDeployments Queries deployment tasks. This operation is equivalent to viewing a list of deployment tasks on the Deploy Tasks page of the DataWorks console. Level 1 UpdateIDEEventResult Returns the check results of an extension point event to DataStudio after the extension point event is triggered and an extension checks the extension point event. Level 2 GetIDEEventDetail Queries the data snapshot of an extension point based on the ID of an open message when the related extension point event is triggered. Level 1 - Data Integration
For more information about how to call an API operation to create a node in Data Integration, see Use API operations to create, configure, and manage a data synchronization node.Operation Description Level CreateDISyncTask Creates a synchronization node or solution in Data Integration. Level 3 DeleteDISyncTask Deletes a synchronization node in Data Integration. You can call this operation to delete only a real-time synchronization node. Level 3 UpdateDISyncTask Updates a synchronization node or solution in Data Integration. Level 3 TestNetworkConnection Tests the network connectivity between a data source and a resource group. Level 3 GetDataSourceMeta Queries the metadata of a specified data source. Level 3 ListDIProjectConfig Queries the default global configuration of synchronization solutions in a specified DataWorks workspace. Level 3 UpdateDIProjectConfig Modifies the default global configuration of synchronization solutions in a specified DataWorks workspace. Level 3 GetDISyncTask Queries details about a real-time synchronization node or a synchronization solution. Level 3 DeployDISyncTask Deploys a real-time synchronization node or a synchronization solution. Level 3 GetDISyncInstanceInfo Queries the status of a real-time synchronization node or a synchronization solution. Level 3 StartDISyncInstance Starts a real-time synchronization node or a synchronization solution. Level 3 StopDISyncInstance Stops a real-time synchronization node. Level 3 TerminateDISyncInstance Undeploys a real-time synchronization node. Level 3 GenerateDISyncTaskConfigForCreating Generates an ID for an asynchronous thread that is used to create a real-time synchronization node in Data Integration. Level 3 GenerateDISyncTaskConfigForUpdating Generates an ID for an asynchronous thread that is used to update a real-time synchronization node in Data Integration. Level 3 QueryDISyncTaskConfigProcessResult Obtains the asynchronously generated parameters based on the ID of an asynchronous thread. The parameters are used to create or update a real-time synchronization node or a synchronization solution in Data Integration. Level 3 - Operation Center
Operation Description Level ListAlertMessages Queries alerts. Level 1 GetBaselineConfig Queries the configurations of a baseline. Level 1 ListNodesByBaseline Queries nodes in a baseline. Level 1 ListBaselineConfigs Queries baselines. Level 1 GetBaselineKeyPath Queries the key path of a baseline instance. Level 1 GetBaselineStatus Queries the details of a baseline instance. Level 1 ListBaselineStatuses Queries baseline instances. Level 1 DeleteRemind Deletes a custom alert rule. Level 2 UpdateRemind Updates a custom alert rule. Level 3 CreateRemind Creates a custom alert rule. Level 3 GetRemind Queries the details of a custom alert rule. Level 1 ListReminds Queries custom alert rules. Level 1 ListTopics Queries events. Level 1 GetTopic Queries the details of an event. Level 1 GetTopicInfluence Queries baseline instances affected by an event. Level 1 GetNode Queries the details of a node. Level 1 ListNodeInputOrOutput Queries the ancestor or descendant nodes of a node. Only the ancestor or descendant nodes at the nearest level can be queried each time. Level 1 ListNodes Queries nodes. Level 1 GetNodeCode Queries the code of a node. Level 1 GetInstance Queries the details of an instance. Level 1 ListInstances Queries instances. Level 1 GetInstanceLog Queries the logs of an instance. Level 1 StopInstance Terminates an instance. Level 2 RestartInstance Restarts an instance. Level 2 SetSuccessInstance Sets the status of a failed instance to successful. Level 2 SuspendInstance Suspends an instance. Level 2 ResumeInstance Resumes a suspended instance. Level 2 RunCycleDagNodes Creates a workflow to backfill data. Level 2 RunSmokeTest Creates a workflow to perform smoke testing. Level 2 ListSuccessInstanceAmount Queries the trend of the number of auto triggered node instances that are successfully run each hour within the current day. Level 3 ListInstanceAmount Queries the trend of the number of auto triggered node instances within a specified period of time. Level 1 TopTenElapsedTimeInstance Queries the ranking of the running durations of instances. Level 1 TopTenErrorTimesInstance Queries the ranking of nodes on which errors occur within the last month. Level 1 GetFileTypeStatistic Queries the distribution of node types. Level 1 GetInstanceStatusStatistic Queries the number of instances in each state. Level 1 ListFileType Queries the information about one or more node types, such as the code and name of a node type. Level 1 RunManualDagNodes Runs 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 the manually triggered workflow on the Operation Center page only after the manually triggered workflow is committed and deployed. Level 2 ListManualDagInstances Queries the information about instances in a manually triggered workflow. Level 1 GetDag Queries the details of a directed acyclic graph (DAG) based on the ID of the DAG. Level 1 ListDags Queries the details of DAGs for a single data backfill instance based on OpSeq. Level 1 ListNodesByOutput Queries nodes based on the output of the nodes. Level 1 RunTriggerNode Runs a manually triggered node. Level 2 GetNodeParents Queries the ancestor nodes of a node. Level 2 GetNodeChildren Queries the descendant nodes of a node. Level 2 UpdateNodeRunMode Freezes or unfreezes a node. Level 2 UpdateNodeOwner Changes the owner of a node. Level 2 UpdateWorkbenchEventResult Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension. Level 2 ListShiftPersonnels Queries the on-duty engineers in a shift schedule. Level 1 ListShiftSchedules Queries shift schedules in Operation Center. Level 1 - Data Quality
Operation Description Level UpdateQualityFollower Updates a subscription relationship. Level 2 UpdateQualityRule Updates a monitoring rule. Level 2 GetQualityRule Queries the information about a monitoring rule. Level 1 ListQualityRules Queries monitoring rules based on a partition filter expression. Level 3 CreateQualityRule Creates a monitoring rule. Level 3 DeleteQualityFollower Deletes a subscriber of a partition filter expression. Level 2 DeleteQualityRule Deletes a monitoring rule. Level 2 GetQualityFollower Queries the subscribers of a partition filter expression. Level 1 CreateQualityFollower Creates a subscriber for a partition filter expression. Level 3 DeleteQualityEntity Deletes a partition filter expression. Level 2 GetQualityEntity Queries a partition filter expression. Level 1 CreateQualityEntity Creates a partition filter expression. Level 2 CreateQualityRelativeNode Associates a node with a partition filter expression. Level 3 DeleteQualityRelativeNode Disassociates a node from a partition filter expression. Level 2 ListQualityResultsByEntity Queries historical monitoring results based on a partition filter expression. Level 1 ListQualityResultsByRule Queries monitoring results based on a monitoring rule. Level 1 - DataService Studio
Operation Description Level CreateDataServiceApi Creates an API. Level 3 PublishDataServiceApi Publishes an API. Level 3 DeleteDataServiceApi Deletes an API. Level 3 ListDataServiceApis Queries the information about APIs in the development state. Level 1 GetDataServiceApi Queries the details of an API in the development state. Level 1 UpdateDataServiceApi Updates the information about an API in the development state. Level 3 GetDataServicePublishedApi Queries the information about an API in the published state. Level 1 ListDataServicePublishedApis Queries the information about APIs in the published state. Level 1 ListDataServiceApiAuthorities Queries the APIs whose access permissions are granted to users. Level 1 ListDataServiceAuthorizedApis Queries the APIs that you are authorized to access. Level 1 AbolishDataServiceApi Unpublishes an API. Level 3 GetDataServiceApplication Queries the details of an application. Level 1 ListDataServiceApplications Queries the basic information about applications. Level 1 CreateDataServiceFolder Creates a folder. Level 2 GetDataServiceFolder Queries a folder. Level 1 ListDataServiceFolders Queries one or more folders. Level 1 CreateDataServiceGroup Creates a business process. Level 2 GetDataServiceGroup Queries a business process. Level 1 ListDataServiceGroups Queries business processes. Level 1 CreateDataServiceApiAuthority Grants the access permissions on an API. Level 1 DeleteDataServiceApiAuthority Revokes the access permissions on an API. Level 1 - Data Security Guard
Operation Description Level GetOpSensitiveData Queries the records that are generated on a specified date for access to the sensitive data in all the DataWorks workspaces of a tenant. Level 1 DesensitizeData Masks data. Level 1 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. Level 1 GetSensitiveData Queries the latest sensitive data in all the DataWorks workspaces of a tenant. Level 1 ScanSensitiveData Checks whether input data contains sensitive data. Level 1 - Migration Assistant
Operation Description Level CreateImportMigration Creates an import task. The import task contains the import packages of the data sources, nodes, and tables. Level 2 GetMigrationProcess Queries the progress of a migration task. Level 1 StartMigration Starts a migration task. Level 2 CreateExportMigration Creates an export task. You can use this operation to create an export task but cannot use this operation to start the created export task. Level 2 GetMigrationSummary Queries the information about a migration task. Level 2 ListMigrations Queries migration tasks. Level 2 - Security Center
Operation Description Level CreatePermissionApplyOrder Creates a permission request order. Level 2 GetPermissionApplyOrderDetail Queries the details of a permission request order. Level 2 ListPermissionApplyOrders Queries permission request orders. Level 3 ApprovePermissionApplyOrder Processes a permission request order. Level 2 RevokeColumnPermission Revokes permissions on table fields from a user. Level 2 RevokeTablePermission Revokes permissions on a table from a user. Level 2
If an error code is returned when you call an API operation, you can view the description of the error code in the API reference. You can also visit the API Error Center to view the details of the error code.