DataWorks provides over 100 Open APIs for batch operations and system integrations, enabling you to access DataWorks features programmatically and integrate with your applications.
The Open Platform tracks your API usage, including free quota consumption, call volumes, and call logs. DataWorks Open API overview.
Edition requirements
To use a specific Open API, your DataWorks edition must support the corresponding feature module (e.g., Tenant, Metadata, Data Studio).
-
Each edition has specific daily call limits. Use Open API.
-
Each edition includes a monthly free quota. Calls exceeding the quota are billed pay-as-you-go. Free quota and billing methods.
Available regions
The DataWorks Open API is available in the following regions:
|
Region |
Region |
Region |
|
China (Hangzhou) |
China (Hong Kong) |
US (Silicon Valley) |
|
China (Shanghai) |
Singapore |
US (Virginia) |
|
China (Shenzhen) |
Indonesia (Jakarta) |
Germany (Frankfurt) |
|
China (Beijing) |
Malaysia (Kuala Lumpur) |
UK (London) |
|
China (Zhangjiakou) |
Japan (Tokyo) |
China North 2 Ali Gov 1 |
|
China (Chengdu) |
China East 2 Finance |
View Open API usage
To view API usage statistics:
-
Log on to the DataWorks console.
-
In the top navigation bar, select a region.
-
In the left-side navigation pane, choose More > Open Platform.
-
Click Go to Open Platform. The Developer Backend tab opens.
This page shows your API usage and best practices.
Usage metrics
The Open API page includes the following sections:
|
Metric |
Description |
|
Open API free quota |
Free quota usage for the current calendar month. Pay-as-you-go billing applies after the quota is exhausted. |
|
Open API call count |
Total API calls month-to-date. Resets on the first of each month. |
|
Open API call details |
API call logs with date, category, and daily/monthly totals. Filterable by API type. |
Best practices
Visit the Open API Best Practices section on the Open Platform, or go directly to the best practices guide.