Calling DataWorks OpenAPI - DataWorks - Alibaba Cloud Documentation Center

Basic information

Version	OpenAPI portal	Supported APIs	Supported regions
2024-05-18 (New version)	OpenAPI portal	List of supported APIs	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 Notes on Data Studio-related APIs: If you use the new Data Studio, use the 2024-05-18 OpenAPI version. If you do not use the new Data Studio, use the 2020-05-18 OpenAPI version. Check if you are using the new Data Studio and select the corresponding OpenAPI version. Selecting the wrong version may cause query failures or return unexpected results.
2020-05-18 (Legacy version)	OpenAPI portal	List of supported APIs

Limitations

The edition requirements for a module's OpenAPI match those of the module itself.

To regulate DataWorks OpenAPI calls and ensure system stability, APIs are classified as read or write. Different DataWorks editions have specific QPS (queries per second) limits. The Basic Edition also has a daily call limit, while the Standard Edition, Professional Edition, and Enterprise Edition do not. Each edition also has a monthly free call quota and pay-as-you-go rules for calls that exceed the quota. The following table summarizes these details.

Edition	QPS limit	Daily call limit	Monthly free quota	Pay-as-you-go pricing
Basic Edition	Total QPS for all APIs: ≤5	Total API calls per day: ≤100	3,100 calls/month	Subject to call limits. Pay-as-you-go is not supported.
Standard Edition		Unlimited daily API calls	100,000 calls/month	USD 0.05 per 10,000 calls
Professional Edition		Unlimited daily API calls	500,000 calls/month	USD 0.05 per 10,000 calls
Enterprise Edition	Total QPS for read APIs: ≤50 Total QPS for write APIs: ≤20	Unlimited daily API calls	1,000,000 calls/month	USD 0.05 per 10,000 calls

Important

API QPS and call counts are calculated as the cumulative total for an Alibaba Cloud account and its RAM users in each region.
If the QPS limit is exceeded, or if the daily call limit for the Basic Edition is reached, subsequent calls fail. Manage call concurrency and frequency to avoid exceeding these limits.
For the Basic Edition, both successful and failed API calls count towards the daily call limit. The Standard, Professional, and Enterprise editions do not have a daily call limit. For these editions, only successful calls count toward the monthly free quota. Monitor your free quota usage and pay-as-you-go rules.
You can determine an API's type (read or write) from its name. For example, CreateFile is a write API, and ListFiles is a read API.

Prerequisites

Before you call an OpenAPI, ensure you have the AliyunDataWorksFullAccess permission to prevent failures due to insufficient permissions. For more information, see User permissions.

Free quotas and billing methods

The monthly free quota for each edition, the pay-as-you-go price for exceeding the quota, and limits such as QPS and daily call counts are summarized in the table in the Limitations section. This section provides additional details on billing calculations and other important notes.

Important

Each Alibaba Cloud account (including its RAM users) receives a free monthly quota for OpenAPI calls in each region. The free quota varies by DataWorks edition.
The Basic Edition is subject to both a daily call limit and a monthly free quota (see Limitations). After you exceed a limit, you cannot make more calls, and pay-as-you-go is not supported. The Standard and Professional editions do not have a daily call limit but have monthly free quotas (see the summary table in the Limitations section). After the free quota is exhausted, subsequent calls are billed on a pay-as-you-go basis. For pricing details and differences across environments, see the OpenAPI billing section in Resource costs. The Enterprise Edition does not have a daily call limit. After its free quota is exhausted, the same pay-as-you-go billing rules apply.
For the DataWorks Standard, Professional, and Enterprise editions, you can continue to make calls on a pay-as-you-go basis after the monthly free quota is exhausted. International sites use the unit price and billing shown in the documentation. For more information, see Resource costs. The price on your final bill prevails.

API calls

Note

For detailed information about calling Alibaba Cloud OpenAPI, see Overview.

Call methods

Call method	Supported	Description
Alibaba Cloud SDK (Recommended)	Yes	For information about the programming languages supported by the DataWorks SDK and how to install dependencies, see DataWorks SDK.
Native HTTP call	Yes	If you use native HTTP calls, you must implement the signing algorithm and build custom requests. For more information about the signing mechanism, see Request structure and signature.

Call examples

DataWorks SDK (Recommended)
Call OpenAPI over HTTP

API style

DataWorks OpenAPI uses the RPC style.

Endpoints

Select the endpoint for the region where your DataWorks workspace is located to minimize latency. For example, the VPC endpoint for the China (Zhangjiakou) region is dataworks-vpc.cn-zhangjiakou.aliyuncs.com. For more information, see Endpoints (2024-05-18) and Endpoints (2020-05-18).

OpenAPI usage

You can use the Open Platform to view your OpenAPI usage, including free quota consumption, call counts, and scheduling details. For more information, see OpenAPI.