The OpenAPI module allows you to call DataWorks API operations to integrate your applications with DataWorks and use DataWorks services.
Background information
DataWorks provides more than 100 API operations that you can call to interact with DataWorks and use DataWorks services. For example, you can call DataWorks API operations to perform batch operations or integrate your applications with DataWorks. DataWorks can facilitate data development and meet enterprise-specific requirements. On the OpenAPI page, you can view the usage of the free quota for API calls that DataWorks provides per month and the number of API calls that you made in the current month. You can also specify a date range to view specific API call details. For more information about DataWorks API operations, see Overview.
Limits
Applicable editions:
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.
DataWorks 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.
For information about the mappings between the API operations and DataWorks editions, see List of operations by function.
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)
View information about API calls
Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose . The Developer Backend tab appears.
The OpenAPI page appears. On this page, you can view information about API calls. You can also view the best practices for using the OpenAPI module.
Content of the OpenAPI page
On the OpenAPI page, you can view the following information:
Free Call Quota for This Month: The usage of the free quota for API calls that DataWorks provides per month up to the current date in the current month. The free quota for API calls that DataWorks provides per month varies based on your DataWorks edition. After the free quota is exhausted, you are charged for the number of API calls you make. For more information, see Overview.
Successful Calls This Month: The number of API calls that you made up to the current date in the current month. The number of API calls is counted by month and recounted on the first day of each month.
API Call Details: The information about API calls in a specific date range, including the date on which an API operation is called, the name, type, and level of an API operation, the number of times an API operation is called on the current day, and the number of times an API operation is called in the current month. You can search for API calls based on the types and levels of API operations. The maximum number of times that an API operation can be called per day varies based on your DataWorks edition. For more information, see Overview.
Best practices of DataWorks OpenAPI
The Best Practices of DataWorks OpenAPI section on the OpenAPI page displays the best practices for using the OpenAPI module. If you click one practice, you are redirected to the related document. You can also click the following links in this topic to go to the related document.
Best practices for calling DataWorks API operations to manage files
Best practices for calling DataWorks API operations to manage tables
Best practices for calling DataWorks API operations to develop, commit, and run tasks
Best practices for calling DataWorks API operations to perform ETL operations on data
For more information about API operations, see API overview.