All Products
Search

This Product

    DataWorks:Using OpenAPI

    Document Center

    DataWorks:Using OpenAPI

    Last Updated:Oct 28, 2025

    This topic describes the basic information, limits, billing, and call instructions for DataWorks OpenAPI.

    Basic information

    Version

    OpenAPI portal

    Supported API list

    Supported regions

    2024-05-18 (new OpenAPI)

    OpenAPI Portal

    Supported API list

    China (Hangzhou), China (Shanghai), China (Shenzhen), China (Beijing), China (Zhangjiakou), Alibaba 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)

    Important

    Usage notes for Data Development-related OpenAPI:

    • If you Use The New Data Studio, use the 2024-05-18 version.

    • If you do not Use The New Data Studio, use the 2020-05-18 version.

    Confirm whether you Use The New Data Studio and select the corresponding OpenAPI version. If you select an incorrect version, your query may fail or you may not get the expected results.

    2020-05-18 (old OpenAPI)

    OpenAPI Portal

    Supported API list

    Limits

    • DataWorks provides OpenAPI for different feature modules, such as tenant, metadata, Data Development, and Operation Center. The edition requirements for an OpenAPI are the same as those for its corresponding feature.

    • To standardize DataWorks OpenAPI calls and ensure system stability, OpenAPI is classified into read and write types. Different DataWorks editions have different queries per second (QPS) limits and daily call limits for read and write OpenAPI. The details are as follows.

      Edition

      QPS limit

      Maximum daily calls

      Basic Edition

      Total QPS for all OpenAPI ≤ 5

      The total number of API calls per day cannot exceed 100.

      Standard Edition

      The total number of API calls per day cannot exceed 1,000.

      Professional Edition

      The total number of daily API calls cannot exceed 10,000.

      Enterprise Edition

      • Total QPS for read OpenAPI ≤ 50

      • Total QPS for write OpenAPI ≤ 20

      There is no limit on the number of daily API calls.

      Important

      • The QPS and call limits apply to the total number of calls made by an Alibaba Cloud account and its RAM users in each region.

      • If the QPS or daily call limit is exceeded, calls will fail. You must control the call concurrency and the number of calls accordingly.

      • Both successful and failed calls count toward the daily call limit.

      • You can determine the read or write type of an OpenAPI from its name. For example, CreateFile is a write OpenAPI and ListFiles is a read OpenAPI.

    Prerequisites

    Before calling an OpenAPI, ensure that the AliyunDataWorksFullAccess permission is granted to prevent call failures due to insufficient permissions. For more information, see Access control.

    Free quota and billing method

    Each OpenAPI version includes a monthly free call quota. After the free quota is used up, calls are charged on a pay-as-you-go basis. The following table describes the free quotas and pay-as-you-go pricing.

    Edition

    Free call quota

    Pay-as-you-go pricing after free quota is used

    Basic Edition

    3,100 calls/month

    Call limits apply. Pay-as-you-go billing is not supported.

    Standard Edition

    31,000 calls/month

    Professional Edition

    310,000 calls/month

    Enterprise Edition

    1,000,000 calls/month

    USD 0.05 per 10,000 calls

    Important

    • In each region, each Alibaba Cloud account receives a free OpenAPI call quota every calendar month. This quota is shared between the account and its RAM users. The free quota varies based on the DataWorks edition.

    • Because of the daily call limits of different DataWorks editions, the actual number of monthly calls for the Basic, Standard, and Professional editions will not exceed the free quota. Therefore, pay-as-you-go billing is not supported for these editions. For more information, see Limits.

    • After the free quota for DataWorks Enterprise Edition is used up, calls are charged on a pay-as-you-go basis. The actual price on your bill prevails.

    • Only successful OpenAPI calls consume the free quota and are charged on a pay-as-you-go basis after the quota is used up. Failed OpenAPI calls do not consume the free quota and are not charged.

    Calling instructions

    Note

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

    Call methods

    Call method

    Supported

    Description

    Alibaba Cloud SDK (Recommended)

    Support

    For information about the supported languages and dependency installation methods for the DataWorks software development kit (SDK), see DataWorks SDK.

    Native HTTP call

    Support

    With native HTTP calls, you must implement the signature algorithm, build a custom request, and initiate the HTTP call. For more information about the signature mechanism, see Request structure and signature mechanism.

    Call examples

    API style

    RPC style.

    Endpoints

    Select an endpoint based on the region where your DataWorks project resides to achieve the lowest latency. For example, the VPC endpoint for the China (Zhangjiakou) region is dataworks-vpc.cn-zhangjiakou.aliyuncs.com. For more information, see Endpoints (2024-05-18) and Endpoints (2020-05-18).

    View OpenAPI usage

    You can use the Open Platform to easily retrieve OpenAPI usage information, including free quota usage, number of calls, and scheduling details. For more information, see Open API (OpenAPI).