DataWorks:Use OpenAPI

Basic information

Limitations

• The edition requirements for a module's OpenAPI match those of the module itself.

• To regulate DataWorks OpenAPI calls and ensure system stability, APIs are classified as read or write. Different DataWorks editions have specific QPS (queries per second) limits. The Basic Edition also has a daily call limit, while the Standard Edition, Professional Edition, and Enterprise Edition do not. Each edition also has a monthly free call quota and pay-as-you-go rules for calls that exceed the quota. The following table summarizes these details.

  Version	QPS limit	Daily call limit	Monthly free call quota	Pay-as-you-go after exceeding the free quota
  Basic Edition	Total QPS of all APIs ≤ 5	Total daily API calls ≤ 100	3,100 calls/month	Call limits apply. Additional pay-as-you-go billing is not supported.
  Standard Edition		No daily call limit	100,000 calls/month	USD 0.05 per 10,000 calls
  Professional Edition		No daily call limit	500,000 calls/month	USD 0.05 per 10,000 calls
  Enterprise Edition	Total QPS of read APIs ≤ 50 Total QPS of write APIs ≤ 20	No daily call limit	1,000,000 calls/month	USD 0.05 per 10,000 calls

  The underlying scheduling tasks of DataWorks are not executed through OpenAPI operations. Running out of the OpenAPI call quota does not affect the normal execution of timed scheduling tasks or batch tasks. Only tasks that call OpenAPI operations themselves, such as Python nodes or PyODPS nodes, may be affected. Scheduled instances in the production environment are generated in advance and are not subject to the API call quota.

  Important

  • API QPS and call counts are calculated as the cumulative value of each Alibaba Cloud account (including RAM users) in each region.

  • If the QPS limit is exceeded or the Basic Edition daily call limit is exceeded, calls will fail. Control your call concurrency and frequency accordingly.

  • For the Basic Edition, both successful and failed API calls count toward the daily call limit. The Standard Edition, Professional Edition, and Enterprise Edition do not have a daily call limit, and failed calls are not counted toward the daily call limit. Pay attention to the monthly free call quota and pay-as-you-go billing rules.

  • You can determine the read/write type of each API based on its name. For example, CreateFile is a write API, and ListFiles is a read API.

Prerequisite

Before you call OpenAPI, make sure that the AliyunDataWorksFullAccess permission is enabled. Otherwise, OpenAPI calls may fail due to insufficient permissions. For more information, see Grant the AliyunDataWorksFullAccess permission.

Free quota and billing

The monthly free call quota, pay-as-you-go unit price after exceeding the quota, QPS limits, and daily call limits for each edition are summarized in the table in the Limitations section above. The following information provides additional details about billing metrics and considerations.

• Each calendar month, a free OpenAPI call quota is granted to each Alibaba Cloud account (including RAM users) in each region. The monthly free quota varies by DataWorks edition.

• The Basic Edition is subject to both the daily call limit and the monthly free call quota (for details, see Limitations above). Calls are rejected after the limit is exceeded, and pay-as-you-go billing is not supported. The Standard Edition and Professional Edition do not have a daily call limit and each has a monthly free call quota (see the table in the Limitations section above). Pay-as-you-go billing is supported after the free quota is exceeded. For unit prices and environment-specific differences, see OpenAPI billing in Resource costs. The Enterprise Edition does not have a daily call limit, and the same pay-as-you-go billing rules apply after the free quota is used up.

• The DataWorks Standard Edition, Professional Edition, and Enterprise Edition support continued API calls at pay-as-you-go prices after the monthly free call quota is used up. International sites use the unit price and billing shown in the documentation. For more information, see Resource costs. The actual billing price is subject to the price displayed on your final bill.

How to call OpenAPI

For more information about Alibaba Cloud OpenAPI, see Alibaba Cloud OpenAPI.

View OpenAPI usage

You can use Open Platform to view your OpenAPI usage, including free quota consumption, call counts, and call details. For more information, see View OpenAPI usage.