DataWorks provides API operations of multiple modules, such as tenants, metadata, DataStudio, Operation Center, and Data Integration. Queries per second (QPS) limits, the maximum number of daily calls, and applicable DataWorks editions differ among the API operations. This topic describes the applicable editions and regions, billing rules, and call limits of the API operations and lists the API operations by function.
Applicable scopes
Applicable editions:
The API operations related to a DataWorks module have the same edition requirements as the DataWorks module.
For information about the limits on API operations that you can call in different DataWorks editions, see Call limits.
DataWorks provides a free quota for you to call API operations in each calendar month. After the free quota is used up, you are charged based on the pay-as-you-go billing method. For more information about the free quota and billing rules, see Free quota and billing rules.
For information about the mappings between the API operations and DataWorks editions, see List of operations by function.
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, Indonesia (Jakarta), US (Silicon Valley), US (Virginia), Germany (Frankfurt), UK (London), Japan (Tokyo) and Malaysia (Kuala Lumpur)
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 QPS limits and the maximum number of daily calls of API operations at different levels in different DataWorks editions.
For information about how to view the free quota that DataWorks provides for API calls, the number of API calls that you have made, and API call details, see View information about API calls.
Edition | QPS limit | Maximum number of daily calls |
Basic Edition | ≤ 5 for API operations at level 1, level 2, or level 3 | ≤ 100 |
Standard Edition | ≤ 1,000 | |
Professional Edition | ≤ 10,000 | |
Enterprise Edition |
|
|
The QPS and the number of API calls are calculated by accumulating the total number of calls for all API operations in each region for an Alibaba Cloud account and RAM users within the Alibaba Cloud account.
If the QPS or the number of daily calls exceeds the upper limit, an API call will fail. We recommend you control the call concurrency and the number of initiated API calls.
The maximum number of daily calls includes the number of successful API calls and the number of failed API calls.
Free quota and 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.
Edition | Free quota | Pricing based on the pay-as-you-go billing method |
Basic Edition | 3,100 calls per month | Calls to the API operations are limited. The pay-as-you-go billing method is not supported. |
Standard Edition | 31,000 calls per month | |
Professional Edition | 310,000 calls per month | |
Enterprise Edition | 1,000,000 calls per month | 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. The free quota varies based on the DataWorks edition.
Due to the limits on the maximum number of daily calls of API operations in different DataWorks editions, the actual monthly quota for you to call API operations in DataWorks Basic Edition, DataWorks Standard Edition, and DataWorks Professional Edition may be less than the free quota provided by DataWorks. For more information, see Call limits.
After the free quota provided by DataWorks Enterprise Edition is used up, you are charged based on the pay-as-you-go billing method. The actual price in your bills prevails.
The free quota is used only after API operations are successfully called. After the free quota is used up, you are charged based on the pay-as-you-go billing method. If API operations fail to be called, the free quota is not used, and you are not charged.
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.
Tenants
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Queries a list of compute engines. | Level 2 |
| |
Adds a data source to DataWorks. | Level 2 | ||
Queries a list of data sources of DataWorks. | Level 3 | ||
Updates a data source. | Level 2 | ||
Removes a data source. | Level 2 | ||
Queries a list of resource groups. | Level 1 | ||
Queries the information about a DataWorks workspace. | Level 1 | ||
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 | ||
Adds a user to a DataWorks workspace. | Level 2 | ||
Removes a user from a DataWorks workspace. | Level 2 | ||
Queries a list of roles in a DataWorks workspace. | Level 1 | ||
Removes a role from a user in a DataWorks workspace. | Level 2 | ||
Queries a list of members in a DataWorks workspace. | Level 1 | ||
Queries a list of DataWorks workspaces of the tenant to which a user belongs by page. | Level 1 | ||
Queries a list of IDs of the DataWorks workspaces on which an Alibaba Cloud account or RAM user has permissions. | Level 1 | ||
Deletes a DataWorks workspace. | Level 3 | ||
Creates a DataWorks workspace. | Level 3 | ||
Updates a DataWorks workspace. | Level 3 | ||
Changes the resource group to which a resource belongs. | Level 3 |
Metadata
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Queries the basic metadata information about a compute engine. | Level 1 |
| |
Queries a list of metatables in a compute engine. | Level 1 |
| |
Checks whether a metatable exists. | Level 1 |
| |
Checks whether a partition exists. | Level 1 |
| |
Queries metatables based on specific conditions. | Level 1 |
| |
Queries the basic information about a metatable. | Level 1 |
| |
Queries the field information about a metatable. | Level 1 |
| |
Queries a list of partitions of a metatable. | Level 1 |
| |
Queries the output information in a metatable. | Level 1 |
| |
Queries the change logs of a metatable. | Level 1 |
| |
Queries the instructions on how to use a metatable. | Level 1 |
| |
Creates a category. | Level 2 |
| |
Deletes a category. | Level 2 |
| |
Updates a category. | Level 2 |
| |
Queries a category tree. | Level 1 |
| |
Queries a list of metatables in a category. | Level 1 |
| |
Adds a metatable to a category. | Level 2 |
| |
Removes a metatable from a category. | Level 2 |
| |
Updates the metadata information about a table. | Level 2 |
| |
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 |
| |
Queries a list of metadatabases. | Level 1 |
| |
Updates the information about a table, such as the theme, level, and category. | Level 2 |
| |
Creates a table theme. | Level 2 |
| |
Deletes a table theme. | Level 2 |
| |
Updates a table theme. | Level 2 |
| |
Queries a list of table themes. | Level 1 |
| |
Creates a table level. | Level 2 |
| |
Deletes a table level. | Level 2 |
| |
Updates a table level. | Level 2 |
| |
Queries a list of table levels. | Level 1 |
| |
Queries the information about table themes and table levels. | Level 1 |
| |
Updates a collection. | Level 2 |
| |
Queries a list of collections. | Level 2 |
| |
Queries a list of entities in a collection. | Level 2 |
| |
Deletes a collection. | Level 2 |
| |
Queries the information about a collection. | Level 2 |
| |
Removes an entity from a collection. | Level 2 |
| |
Adds an entity to a collection. | Level 2 |
| |
Creates a collection. | Level 2 |
| |
Queries a list of output tasks of a metatable. | Level 1 |
| |
Queries the ancestor or descendant lineage of an entity. | Level 2 |
| |
Deletes the lineage between entities. | Level 2 |
| |
Registers the lineage between self-managed entities to DataWorks and enables the lineage to be combined with the existing lineage between system entities in DataWorks to form a full-link lineage. | Level 2 |
|
DataStudio
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Creates a file in DataStudio. | Level 3 |
| |
Creates a file for a function in DataStudio. | Level 2 |
| |
Creates a workflow. | Level 2 |
| |
Deletes a workflow. | Level 3 |
| |
Creates a folder. | Level 2 |
| |
Updates a workflow. | Level 2 |
| |
Queries a list of files. | Level 1 |
| |
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 |
| |
Commits a file to the development environment of the scheduling system to generate a task. | Level 3 |
| |
Queries a list of workflows. | Level 1 |
| |
Queries the information about a file version. | Level 1 |
| |
Deletes a folder from DataStudio. | Level 3 |
| |
Deletes a file from DataStudio. | Level 3 |
| |
Queries the information about a deployment package. | Level 1 |
| |
Updates a file. | Level 2 |
| |
Queries the information about a folder. | Level 1 |
| |
Queries a list of file versions. | Level 1 |
| |
Queries the information about a file. | Level 1 |
| |
Queries a list of folders. | Level 1 |
| |
Deploys a file to the production environment. | Level 3 |
| |
Updates the file information about a function. | Level 2 |
| |
Queries the information about a workflow. | Level 1 |
| |
Updates a folder. | Level 2 |
| |
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. | Level 1 |
| |
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 |
| |
Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered. | Level 1 |
| |
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). | Level 3 |
|
Data Integration
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Creates a synchronization task. | Level 3 |
| |
Deletes a synchronization task. You can call this operation to delete only a real-time synchronization task. | Level 3 |
| |
Updates a synchronization task. | Level 3 |
| |
Tests the network connectivity between a data source and a resource group. | Level 3 |
| |
Queries the metadata of a data source. | Level 3 |
| |
Queries the default global configurations of synchronization tasks in a DataWorks workspace. | Level 3 |
| |
Updates the default global configurations of synchronization tasks in a DataWorks workspace. | Level 3 |
| |
Queries the information about a real-time synchronization task. | Level 3 |
| |
Deploys a real-time synchronization task. | Level 3 |
| |
Queries the status of a real-time synchronization task. | Level 3 |
| |
Starts a real-time synchronization task. | Level 3 |
| |
Stops a real-time synchronization task. | Level 3 |
| |
Undeploys a real-time synchronization task. | Level 3 |
| |
Generates an ID for an asynchronous thread that is used to create a synchronization task in Data Integration. | Level 3 |
| |
Generates an ID for an asynchronous thread that is used to update a synchronization task in Data Integration. | Level 3 |
| |
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 task in Data Integration. | Level 3 |
| |
Creates a synchronization task of a new version. | Level 3 |
| |
Deletes a synchronization task of a new version. | Level 3 |
| |
Queries the information about a synchronization task of a new version. | Level 3 |
| |
Queries a list of synchronization tasks of a new version. | Level 3 |
| |
Starts a synchronization task of a new version. | Level 3 |
| |
Stops a synchronization task of a new version. | Level 3 |
| |
Updates a synchronization task of a new version. | Level 3 |
| |
Creates an alert rule for a synchronization task of a new version. | Level 3 |
| |
Queries the information about an alert rule for a synchronization task of a new version. | Level 3 |
| |
Queries a list of alert rules for a synchronization task of a new version. | Level 3 |
| |
Updates an alert rule for a synchronization task of a new version. | Level 3 |
|
For information about how to call an API operation to create a synchronization task in Data Integration, see Use API operations to create, modify, and delete a batch synchronization task.
Operation Center
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Queries a list of alerts. | Level 1 |
| |
Queries the configurations of a baseline. | Level 1 |
| |
Queries a list of nodes in a baseline. | Level 1 |
| |
Queries a list of baselines. | Level 1 |
| |
Queries the key path of a baseline instance. | Level 1 |
| |
Queries the information about a baseline instance. | Level 1 |
| |
Queries a list of baseline instances. | Level 1 |
| |
Deletes a custom alert rule. | Level 2 |
| |
Updates a custom alert rule. | Level 3 |
| |
Creates a custom alert rule. | Level 3 |
| |
Queries the information about a custom alert rule. | Level 1 |
| |
Queries a list of custom alert rules. | Level 1 |
| |
Queries a list of events. | Level 1 |
| |
Queries the information about an event. | Level 1 |
| |
Queries a list of baseline instances affected by an event. | Level 1 |
| |
Queries the information about a node. | Level 1 |
| |
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 |
| |
Queries a list of nodes. | Level 1 |
| |
Queries the code of a node. | Level 1 |
| |
Queries the information about an instance. | Level 1 |
| |
Queries a list of instances. | Level 1 |
| |
Queries the logs of an instance. | Level 1 |
| |
Terminates an instance. | Level 2 |
| |
Restarts an instance. | Level 2 |
| |
Sets the state of a failed instance to successful. | Level 2 |
| |
Suspends an instance. | Level 2 |
| |
Resumes a suspended instance. | Level 2 |
| |
Creates a workflow to backfill data. | Level 2 |
| |
Creates a workflow to perform smoke testing. | Level 2 |
| |
Queries the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day. | Level 3 |
| |
Queries the trend of the number of auto triggered node instances within a specific period of time. | Level 1 |
| |
Queries the ranking of the running durations of instances. | Level 1 |
| |
Queries the ranking of nodes on which errors occur within the previous month. | Level 1 |
| |
Queries the distribution of node types. | Level 1 |
| |
Queries the number of instances in each state. | Level 1 |
| |
Queries the information about one or more node types, such as the code and name of a node type. | Level 1 |
| |
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 |
| |
Queries the information about instances in a manually triggered workflow. | Level 1 |
| |
Queries the information about a directed acyclic graph (DAG) based on the ID of the DAG. | Level 1 |
| |
Queries a list of DAGs for a single data backfill instance based on OpSeq. | Level 1 |
| |
Queries a list of nodes based on the output of the nodes. | Level 1 |
| |
Runs a manually triggered node. | Level 2 |
| |
Queries a list of ancestor nodes of a node. | Level 2 |
| |
Queries a list of descendant nodes of a node. | Level 2 |
| |
Freezes or unfreezes a node. | Level 2 |
| |
Changes the owner of a node. | Level 2 |
| |
Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension. | Level 2 |
| |
Queries a list of on-duty engineers in a shift schedule. | Level 1 |
| |
Queries a list of shift schedules in Operation Center. | Level 1 |
| |
Queries a list of historical records for all instances. One historical record is generated if an instance is rerun once. | Level 1 |
| |
Queries a list of 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 Platform for AI (PAI) node. | Level 1 |
| |
Undeploys a node. | Level 3 |
| |
Creates a baseline. | Level 3 |
| |
Updates a baseline. | Level 3 |
| |
Queries the configurations of a baseline based on its ID. | Level 1 |
| |
Queries a list of baselines. | Level 1 |
| |
Deletes a baseline based on its ID. | Level 2 |
|
Data Quality
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Updates a subscription relationship. | Level 2 |
| |
Updates a monitoring rule. | Level 2 | ||
Queries the information about a monitoring rule. | Level 1 | ||
Queries a list of monitoring rules based on a partition filter expression. | Level 3 | ||
Creates a monitoring rule. | Level 3 | ||
Deletes a subscriber of a partition filter expression. | Level 2 | ||
Deletes a monitoring rule. | Level 2 | ||
Queries the subscribers of a partition filter expression. | Level 1 | ||
Creates a subscriber for a partition filter expression. | Level 3 | ||
Deletes a partition filter expression. | Level 2 | ||
Queries the information about a partition filter expression. | Level 1 | ||
Creates a partition filter expression. | Level 2 | ||
Associates a node with a partition filter expression. | Level 3 | ||
Disassociates a node from a partition filter expression. | Level 2 | ||
Queries a list of historical monitoring results based on a partition filter expression. | Level 1 | ||
Queries a list of monitoring results based on a monitoring rule. | Level 1 |
DataService Studio
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Creates an API. | Level 3 |
| |
Publishes an API. | Level 3 | ||
Deletes an API. | Level 3 | ||
Queries a list of APIs in the development state. | Level 1 | ||
Queries the information about an API in the development state. | Level 1 | ||
Updates an API in the development state. | Level 3 | ||
Queries the information about an API in the published state. | Level 1 | ||
Queries a list of APIs in the published state. | Level 1 | ||
Queries a list of APIs whose access permissions are granted to other users. | Level 1 | ||
Queries a list of APIs that you are authorized to access. | Level 1 | ||
Unpublishes an API. | Level 3 | ||
Queries the information about an application. | Level 1 | ||
Queries a list of applications. | Level 1 | ||
Creates a folder. | Level 2 | ||
Queries the information about a folder. | Level 1 | ||
Queries a list of folders. | Level 1 | ||
Creates a business process. | Level 2 | ||
Queries the information about a business process. | Level 1 | ||
Queries a list of business processes. | Level 1 | ||
Grants the access permissions on an API. | Level 1 | ||
Revokes the access permissions on an API. | Level 1 |
DataAnalysis
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Removes a directory from the left-side navigation pane of DataAnalysis. | Level 2 |
| |
Adds a directory to the left-side navigation pane of DataAnalysis. | Level 2 |
|
Data Security Guard
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
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 |
| |
Masks data. | Level 1 |
| |
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 |
| |
Queries the latest sensitive data in all the DataWorks workspaces of a tenant. | Level 1 |
| |
Checks whether input data contains sensitive data. | Level 1 |
| |
Queries the identification results of sensitive data. | Level 1 |
| |
Queries the default data category and sensitivity level template. | Level 1 |
| |
Stops sensitive data identification tasks. | Level 1 |
| |
Queries data categories. | Level 1 |
| |
Queries data sensitivity levels. | Level 1 |
| |
Queries the built-in sensitive data identification rule that is used to configure a sensitive field. | Level 1 |
| |
Starts a sensitive data identification task. | Level 1 |
| |
Deletes sensitive field types. | Level 1 |
| |
Queries sensitive data identification rules. | Level 1 |
| |
Adds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard. | Level 1 |
| |
Edits a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard. | Level 1 |
| |
Queries the type of a sensitive data identification rule. | Level 1 |
| |
Queries the information about a sensitive field. | Level 1 |
| |
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. | Level 1 |
| |
Adds or modifies a data masking rule. | Level 1 |
| |
Queries a list of compute engines of different types in the current tenant. | Level 1 |
| |
Deletes a user group. | Level 1 |
| |
Deletes a data masking whitelist. | Level 1 |
| |
Deletes a level-2 data masking scenario. | Level 1 |
| |
Deletes a data masking rule. | Level 1 |
| |
Modifies the status of a data masking rule. | Level 1 |
| |
Queries a data masking whitelist. | Level 1 |
| |
Adds or modifies a level-2 data masking scenario. | Level 1 |
| |
Queries a list of data masking scenarios. | Level 1 |
| |
Adds or modifies a user group. | Level 1 |
| |
Queries a list of user groups. | Level 1 |
| |
Queries a list of users or roles of the current tenant. | Level 1 |
| |
Queries a list of data masking rules. | Level 1 |
| |
Adds or modifies a data masking whitelist. | Level 1 |
| |
Queries 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. | Level 1 |
|
Migration Assistant
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Creates an import task. The import task contains the import packages of data sources, nodes, and tables. | Level 2 |
| |
Queries the progress of a migration task. | Level 1 | ||
Starts a migration task. | Level 2 | ||
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 | ||
Queries the information about a migration task. | Level 2 | ||
Queries a list of migration tasks. | Level 2 |
Security Center
Operation | Description | Level | Minimum edition (supported by this edition and more advanced editions) |
Creates a permission request order. | Level 2 |
| |
Queries the information about a permission request order. | Level 2 | ||
Queries a list of permission request orders. | Level 3 | ||
Processes a permission request order. | Level 2 | ||
Revokes permissions on table fields from a user. | Level 2 | ||
Revokes permissions on a table from a user. | Level 2 |
Open Platform
Operation | Description | Level | Minimum edition |
Queries a list of extensions. | Level 1 |
| |
Queries the information about an extension. | Level 1 | ||
Queries the option settings of an extension in a workspace. | Level 1 | ||
Queries a list of built-in and custom extensions that are enabled in a workspace. | Level 1 | ||
Sends the processing result of an extension point event to DataWorks through an extension. | Level 1 |
Methods to obtain required information
View information about a user
In the left-side navigation pane, choose . On the Users page, click the name of the desired user. In the Basic Information section of the page that appears, you can view the basic information about the user, such as the UID.
In the User AccessKeys section of the tab on the user details page, you can view the AccessKey pair of the user.
View the region ID of a workspace
You can obtain the region ID of a workspace from the URL of the DataStudio service of DataWorks. The following figure shows the URL of a workspace in the China (Shanghai) region.
NoteFor information about how to go to the DataStudio page, see Go to the DataStudio page.
View the ID of a workspace
The ID of a workspace is a unique identifier of the workspace. To view the workspace ID, perform the following steps:
Go to the Management Center page.
Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose . On the page that appears, select the desired workspace from the drop-down list and click Go to Management Center.
In the left-side navigation pane, click Workspace. In the Basic Properties section of the tab, obtain the workspace ID.
View the ID of a tenant
Each Alibaba Cloud account has a tenant ID to distinguish the current Alibaba Cloud account from other Alibaba Cloud accounts. The RAM users within an Alibaba Cloud account belong to the same tenant. This indicates that the tenant ID of the Alibaba Cloud account is the same as that of the RAM users within the Alibaba Cloud account. To obtain the ID of a tenant, perform the following steps:
In the upper-right corner of the DataStudio page, click the name of the current user and click User Info in the section. In the User Info dialog box, you can view the ID of the tenant.
FAQ
Error: The request for this resource has exceeded your daily available limit.
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 view the details of the error code in Service error codes.