DataWorks Open API provides more than 100 APIs that enable you to perform batch operations and system integrations to boost data development efficiency. You can call these APIs to access various features and integrate your applications with the DataWorks service.
Through the Open Platform, you can monitor your API usage at a glance, including free quota consumption, call volumes, and call logs. For details, see 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. For details, see Use Open API.
Each edition includes a monthly free quota. Calls that exceed the free quota are billed on a pay-as-you-go basis. For details, see 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 your API usage statistics, follow these steps:
Log on to the DataWorks console.
In the top navigation bar, select the desired region.
In the left-side navigation pane, choose More > Open Platform.
On the page that appears, click Go to Open Platform. The Developer Backend tab appears.
This page displays your API usage statistics and best practices.
Usage metrics
The Open API page details your usage in the following sections:
Metric | Description |
Open API free quota | Displays your free quota usage for the current calendar month. Once the free quota is exhausted, pay-as-you-go billing applies. |
Open API call count | The total number of API calls made month-to-date. This counter resets on the first day of each month. |
Open API call details | Detailed logs of your API calls, including date, API category, and daily/monthly totals. You can filter results by API type. |
Best practices
Access the Open API Best Practices section on the Open Platform to view documentation, or use the link to go directly to the best practices guide.