This topic describes the usage notes of DataWorks API operations.
For information about Alibaba Cloud APIs, see Overview.
Basic information
Version
Version | Description |
Recommended |
Endpoint
You must select an endpoint based on the region in which your DataWorks workspace resides to reduce the latency. 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.
API style
The API operations of DataWorks are called in the remote procedure call (RPC) style.
Call method
Call method | Supported | Description |
Alibaba Cloud SDK (recommended) | Yes | For information about the programming languages supported by DataWorks SDKs and the methods to install dependencies, see DataWorks SDK. |
Supported API operations
For more information, see List of operations by function.
Applicable scopes
Applicable editions:
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.
For information about the limits on API operations that you can call in different DataWorks editions, see Call limits.
Each DataWorks edition 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.
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. 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 operation calls, the number of API operation calls that you have made, and API operation call details, see the View information about API calls section of the OpenAPI topic.
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 QPS and the total number of calls 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
Each DataWorks edition 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.