DataWorks OpenAPI lets you automate and integrate DataWorks operations programmatically. This page covers everything you need before making your first call: which API version to use, call methods, rate limits, billing, and endpoints.
Basic information
| Version | Portal | Supported APIs | Supported regions |
|---|---|---|---|
| 2024-05-18 (new) | OpenAPI portal | API list | China (Hangzhou), China (Shanghai), China (Shenzhen), China (Beijing), China (Zhangjiakou), Alibaba Gov Cloud, China (Shanghai) Finance Cloud, China (Chengdu), China (Hong Kong), Singapore, Indonesia (Jakarta), US (Silicon Valley), US (Virginia), Germany (Frankfurt), UK (London), Japan (Tokyo), and Malaysia (Kuala Lumpur) |
| 2020-05-18 (previous) | OpenAPI portal | API list | — |
Choosing a version for Data Development APIs:
The correct version depends on whether you use the New Data Studio.
Using New Data Studio → use version 2024-05-18
Not using New Data Studio → use version 2020-05-18
Selecting the wrong version causes query failures or unexpected results. Confirm which Data Studio you use before integrating.
Prerequisites
Before you begin, ensure that you have:
The
AliyunDataWorksFullAccesspermission granted to your Alibaba Cloud account or RAM user. For details, see Access control.
Limits
DataWorks OpenAPI covers multiple feature modules — tenant, metadata, Data Development, and Operation Center. The edition requirements for each OpenAPI match those of its corresponding feature.
To maintain system stability, APIs are classified as read or write based on their operation type. For example, ListFiles is a read API and CreateFile is a write API. Each DataWorks edition has different queries per second (QPS) and daily call limits:
| Edition | QPS limit | Daily call limit |
|---|---|---|
| Basic Edition | Total QPS for all APIs ≤ 5 | ≤ 100 calls/day |
| Standard Edition | — | ≤ 1,000 calls/day |
| Professional Edition | — | ≤ 10,000 calls/day |
| Enterprise Edition | Read APIs ≤ 50 QPS; Write APIs ≤ 20 QPS | No limit |
Limits apply to the combined calls of an Alibaba Cloud account and all its RAM users within each region.
Both successful and failed calls count toward the daily limit. Only successful calls count toward billing — see Billing for details.
If you exceed the QPS or daily call limit, calls fail. Control call concurrency and volume accordingly.
Billing
Each OpenAPI version includes a monthly free call quota. After the free quota is exhausted, only Enterprise Edition supports pay-as-you-go billing. For Basic, Standard, and Professional editions, daily call limits prevent the monthly total from exceeding the free quota.
| Edition | Free quota | Pay-as-you-go pricing |
|---|---|---|
| Basic Edition | 3,100 calls/month | Not supported |
| Standard Edition | 31,000 calls/month | Not supported |
| Professional Edition | 310,000 calls/month | Not supported |
| Enterprise Edition | 1,000,000 calls/month | USD 0.05 per 10,000 calls |
The free quota is shared between an Alibaba Cloud account and its RAM users, per region, and resets every calendar month.
Only successful calls consume the free quota and are charged after the quota is exhausted. Failed calls do not count toward billing.
For Enterprise Edition, the actual price on your bill prevails.
Calling instructions
For general information about Alibaba Cloud OpenAPI, see Alibaba Cloud OpenAPI.
Call methods
| Method | Description |
|---|---|
| Alibaba Cloud SDK (recommended) | The software development kit (SDK) handles authentication and request signing automatically. For supported languages and installation instructions, see DataWorks SDKDataWorks SDK. |
| Native HTTP call | Make raw HTTP requests. You must implement the signature algorithm and build each request manually. For the signature specification, see Request structure and signature mechanism. |
API style
RPC style.
Endpoints
Select the endpoint for the region where your DataWorks project resides to minimize latency. For example, the VPC endpoint for the China (Zhangjiakou) region is dataworks-vpc.cn-zhangjiakou.aliyuncs.com.
For a full list of endpoints, see Endpoints (2024-05-18) and Endpoints (2020-05-18).
Call examples
DataWorks SDKDataWorks SDK examples (recommended)
View OpenAPI usage
Use the Open Platform to monitor your API usage, including free quota consumption, total call counts, and scheduling details. For details, see DataWorks Open API.