The OpenAPI module lets you call DataWorks API operations to integrate your applications with DataWorks and use DataWorks services.
Background information
DataWorks OpenAPI offers over 100 API features that you can call to perform tasks such as batch operations and system integration. This improves data development efficiency and helps meet custom enterprise requirements. You can also use the Open Platform to easily view OpenAPI usage information, such as free quota usage, call counts, and scheduling details. For more information about OpenAPI, see DataWorks OpenAPI overview.
Limits
Edition requirements: DataWorks offers OpenAPI for various feature modules, such as tenants, metadata, Data Development, and Operation Center. The DataWorks edition required for an OpenAPI module is the same as the edition required for the feature itself.
Each OpenAPI edition has specific call limits. For more information, see Use OpenAPI.
Each OpenAPI edition includes a specific monthly free call quota. After the free quota is exhausted, you are charged on a pay-as-you-go basis. For more information about the free quota and pay-as-you-go billing, see Free quota and billing methods.
Available regions: China (Hangzhou), China (Shanghai), China (Shenzhen), China (Beijing), China (Zhangjiakou), Beijing 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).
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 . On the page that appears, click Go to Open Platform. 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 OpenAPI Quota: Displays the usage of your free API quota for the current calendar month. Different DataWorks editions offer different free call quotas. After the free quota is exhausted, you are charged for additional calls on a pay-as-you-go basis. For more information, see DataWorks OpenAPI 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.
OpenAPI Call Details: Displays API call information for a specific time period. The information includes the call date, API category, number of daily calls, and total monthly calls. You can filter the API information by API category. The maximum number of daily calls varies based on the DataWorks edition. For more information, see DataWorks OpenAPI 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.
Data lineage OpenAPI practice
For more information about OpenAPI, see Use OpenAPI.