Usage notes of DataWorks API operations - DataWorks - Alibaba Cloud Documentation Center

This topic describes the usage notes of DataWorks API operations, including the basic information, limits, billing, and calling description.

Basic information

Version	API operation portal	Supported API operation	Supported region
May 18, 2024 (new-version API operations)	OpenAPI Explorer	List of operations by function	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) Important Usage notes for API operations related to Data Studio: If you participate in the public preview of Data Studio, we recommend that you use new-version API operations. If you have not participated in the public preview of Data Studio, we recommend that you use old-version API operations. You must select the version of API operations based on whether you have participated in the public preview of Data Studio. If you select an inappropriate version, your query may fail or you cannot obtain expected results.
May 18, 2020 (old-version API operations)	OpenAPI Explorer	List of operations by function

Limits

DataWorks provides various API operations, such as API operations related to tenants, metadata, DataStudio, and Operation Center. The API operations related to a DataWorks module have the same edition requirements as the DataWorks module.

DataWorks API operations are classified into API operations for data read and API operations for data write to standardize API calls and ensure system stability. The following table describes the queries per second (QPS) limits and the maximum number of daily calls of API operations for data read and API operations for data write in different DataWorks editions.

Edition	QPS limit	Maximum number of daily calls
Basic Edition	≤ 5 for all API operations	≤ 100
Standard Edition		≤ 1,000
Professional Edition		≤ 10,000
Enterprise Edition	≤ 50 for API operations for data read ≤ 20 for API operations for data write	Unlimited

Important

The QPS and the number of API calls are calculated by accumulating the total QPS and the total number of calls in each region for an Alibaba Cloud account and the RAM users within the Alibaba Cloud account.
If the QPS or the number of daily calls exceeds the upper limit, an API call fails. We recommend you control the call concurrency and the number of initiated API calls.
The maximum number of daily calls includes the numbers of successful and failed API calls.
You can determine whether an API operation is used for data read or data write based on the name of the API operation. For example, CreateFile is an API operation used for data write, and ListFiles is an API operation used for data read.

Prerequisites

Before you call API operations, you must check whether the AliyunDataWorksFullAccess policy is attached to your account. This can prevent call failures caused by insufficient permissions. For more information, see User permission management.

Free quota and billing rules

DataWorks provides a free quota for API calls for each calendar month. After the free quota is used up, you are charged based on the pay-as-you-go billing method. The following table describes the free quota and billing rules.

Edition	Free quota	Pay-as-you-go pricing
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

Important

DataWorks provides a free quota for API calls for each calendar month in each region. This free quota is shared by your Alibaba Cloud account and the RAM users within your Alibaba Cloud account. The free quota varies based on the DataWorks edition.
The maximum number of daily API calls that are allowed in different DataWorks editions varies. The actual monthly quota for APl calls 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 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 consumed 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 consumed, and you are not charged.

Calling description

Note

For information about Alibaba Cloud APIs, see Overview.

Call method

Call method	Supported	Description
Alibaba Cloud SDK (recommended)	Yes	For information about the programming languages supported by DataWorks SDKs and the methods for installing dependencies, see DataWorks SDK.

Call example

DataWorks SDK

API style

The API operations of DataWorks are called in the remote procedure call (RPC) style.

Endpoint

To reduce the latency, you must select an endpoint based on the region in which your DataWorks workspace resides. For example, if your workspace is deployed in a virtual private cloud (VPC) in the China (Zhangjiakou) region, specify dataworks-vpc.cn-zhangjiakou.aliyuncs.com as the endpoint. For more information, see Endpoints (May 18, 2024) and Endpoints (May 18, 2020).

View the use situations of API operations

On the OpenAPI page, you can view the usage of the free quota that DataWorks provides for API calls per month and the number of API calls that you have made in the current month. You can also specify a date range to check the details of API calls within the range. For more information, see OpenAPI.