OpenAPI throttling tiers and version requirements
This topic describes the API rate limits and Dataphin version requirements for various features.
Usage limits
RAM roles cannot make OpenAPI calls.
To ensure application stability, Dataphin categorizes OpenAPI calls into Level 1, Level 2, and Level 3. For details on throttling levels and API call quotas, see Call quotas for different Dataphin versions.
Permissions
The DataphinOpenAPIFullAccess system permission lets you make all OpenAPI calls.
The DataphinOpenAPIReadOnlyAccess system permission lets you make read-only OpenAPI calls.
Data development
Group | API | Description | Throttling level | Minimum version |
Directory tree | Creates a directory in the directory tree for compute, data integration, and synchronization tasks. | Level 2 | Agile Edition | |
Deletes a directory from the directory tree. | Level 3 | Agile Edition | ||
Updates a file name. | Level 2 | Agile Edition | ||
Moves a file to a different directory in the directory tree. | Level 2 | Agile Edition | ||
Retrieves a directory tree. | Level 1 | Agile Edition | ||
Lists files in the directory tree. | Level 1 | Agile Edition | ||
Data architecture | Creates a business entity. | Level 3 | Intelligent Edition | |
Deletes a business entity. | Level 3 | Intelligent Edition | ||
Retrieves the details of a business entity. | Level 1 | Intelligent Edition | ||
Retrieves the details of a specific version of a business entity. | Level 1 | Intelligent Edition | ||
Lists business entities. | Level 2 | Intelligent Edition | ||
Takes a business entity offline. | Level 2 | Intelligent Edition | ||
Brings a business entity online. | Level 2 | Intelligent Edition | ||
Updates a business entity. | Level 2 | Intelligent Edition | ||
Creates a business unit. | Level 3 | Intelligent Edition | ||
Creates a data domain. | Level 3 | Intelligent Edition | ||
Deletes a business unit. | Level 3 | Intelligent Edition | ||
Deletes a data domain. | Level 3 | Intelligent Edition | ||
Retrieves information about a business unit by its ID. | Level 3 | Intelligent Edition | ||
Retrieves the details of a data domain. | Level 3 | Intelligent Edition | ||
Lists the business units in the current tenant. | Level 2 | Intelligent Edition | ||
Lists data domains. | Level 3 | Intelligent Edition | ||
Updates a business unit. | Level 3 | Intelligent Edition | ||
Updates a data domain. | Level 3 | Intelligent Edition | ||
Ad hoc query | Creates an ad hoc query file. | Level 3 | Agile Edition | |
Deletes an ad hoc query file. | Level 3 | Agile Edition | ||
Updates an ad hoc query file. | Level 2 | Agile Edition | ||
Retrieves an ad hoc query file. | Level 1 | Agile Edition | ||
Batch integration | Creates a batch integration pipeline. | Level 3 | Agile Edition | |
Asynchronously creates a batch integration pipeline. | Level 3 | Agile Edition | ||
Takes a pipeline offline. | Level 3 | Agile Edition | ||
Asynchronously takes a pipeline offline. | Level 3 | Agile Edition | ||
Retrieves the result of an asynchronous pipeline execution. | Level 1 | Agile Edition | ||
Retrieves a pipeline by its ID. | Level 1 | Agile Edition | ||
Updates a pipeline. | Level 3 | Agile Edition | ||
Asynchronously updates a batch integration pipeline. | Level 3 | Agile Edition | ||
Batch task | Creates a data integration task as a node within a pipeline. | Level 3 | Basic Edition | |
Stops an ad hoc query task. | Level 2 | Agile Edition | ||
Retrieves the results of an ad hoc query task. | Level 2 | Agile Edition | ||
Creates a batch task. | Level 3 | Agile Edition | ||
Deletes a batch task. | Level 3 | Agile Edition | ||
Executes an ad hoc query task. | Level 2 | Agile Edition | ||
Retrieves the execution log for an ad hoc query task. | Level 1 | Agile Edition | ||
Retrieves the details of a batch task. | Level 1 | Agile Edition | ||
Retrieves a list of versions for a batch task. | Level 2 | Agile Edition | ||
Retrieves the custom data lineage of a batch task. | Level 2 | Agile Edition | ||
Retrieves the details of a specific version of a batch task. | Level 2 | Agile Edition | ||
Takes a batch task offline. | Level 3 | Agile Edition | ||
Parses the logical table dependencies of a batch task. Note The parsed upstream dependencies may include self-referencing nodes (where a node's upstream ID matches its own task ID). Ensure your application handles these nodes correctly. | Level 3 | Agile Edition | ||
Updates the custom data lineage of a batch task. | Level 3 | Agile Edition | ||
Submits a batch task. | Level 3 | Agile Edition | ||
Updates a batch task. | Level 3 | Agile Edition | ||
Streaming jobs | Retrieves streaming jobs. | Level 2 | Basic Edition | |
Retrieves the cluster engine version for the specified environment. | Level 2 | Basic Edition | ||
Retrieves queue information for the cluster in the specified environment. | Level 2 | Basic Edition | ||
Creates a stream-batch job. | Level 2 | Basic Edition | ||
Resources | Retrieves the details of a resource file. | Level 2 | Agile Edition | |
Retrieves the details of a specific version of a resource file. | Level 2 | Agile Edition | ||
Updates a resource file. | Level 2 | Agile Edition | ||
Retrieves temporary read/write credentials for file storage. | Level 2 | Agile Edition | ||
Deletes a resource file. | Level 3 | Agile Edition | ||
Creates a resource file. | Level 3 | Agile Edition | ||
UDFs | Retrieves the details of a UDF. | Level 2 | Agile Edition | |
Retrieves the details of a specific version of a UDF. | Level 2 | Agile Edition | ||
Updates a UDF. | Level 2 | Agile Edition | ||
Deletes a UDF. | Level 3 | Agile Edition | ||
Creates a UDF. | Level 3 | Agile Edition | ||
Publish | Retrieves the details of the latest submission record. | Level 2 | Basic Edition | |
Retrieves a paginated list of submission records. | Level 2 | Basic Edition | ||
Retrieves a paginated list of publish records. | Level 2 | Basic Edition | ||
Publishes a list of objects. | Level 2 | Basic Edition |
O&M center
Group | API | Description | Throttling level | Required edition |
Instance O&M | Backfills data by rerunning a task. Supports forcibly rerunning downstream dependencies, but this incurs compute costs and affects data output. | Level 2 | Agile Edition | |
Retrieves a list of downstream instances for an instance. | Level 2 | Agile Edition | ||
Retrieves the upstream and downstream dependencies for an instance. Supports logical tables and code-based tasks. | Level 2 | Agile Edition | ||
Performs batch operations on instances. Supports physical instances and logical table instances. | Level 2 | Agile Edition | ||
Lists all node instances in a backfill workflow for a specific business date. | Level 1 | Agile Edition | ||
Retrieves instance information. | Level 1 | Agile Edition | ||
Retrieves a paginated list of instances. | Level 1 | Agile Edition | ||
Task O&M | Retrieves the upstream and downstream dependencies of a node. | Level 2 | Agile Edition | |
Runs a manual task. Note
| Level 2 | Agile Edition | ||
Retrieves the submission status of a backfill workflow. | Level 1 | Agile Edition | ||
Retrieves instance execution logs. | Level 2 | Agile Edition | ||
Retrieves a physical scheduling node. | Level 1 | Agile Edition | ||
Retrieves the code of a scheduling node. | Level 1 | Agile Edition | ||
Retrieves the operation log for a node. | Level 1 | Agile Edition | ||
Retrieves a list of runs (Dagruns) for a backfill workflow. | Level 1 | Agile Edition | ||
Retrieves the downstream dependencies of a node. This information is useful when creating a backfill workflow. | Level 2 | Agile Edition | ||
Retrieves a list of scheduling nodes. | Level 1 | Agile Edition | ||
Pauses the scheduling of a physical node. A successful call pauses scheduling for the associated task, preventing downstream tasks from being triggered. This API supports only offline code tasks and integration tasks. | Level 2 | Agile Edition | ||
Resumes the scheduling of a physical node. | Level 2 | Agile Edition | ||
Creates a backfill task for a node. Supports both list and large-scale backfilling modes. Note
| Level 2 | Agile Edition | ||
Retrieves the upstream dependencies of an object in the development environment. | Level 2 | Agile Edition | ||
Retrieves a physical node by its output name. Supports only offline code nodes and integration task nodes. | Level 1 | Agile Edition | ||
Alerts | Retrieves alert event details. | Level 1 | Agile Edition | |
Lists alert events based on specified conditions. | Level 1 | Agile Edition | ||
Lists notification records based on specified conditions. | Level 1 | Agile Edition |
Data permissions
Group | API | Description | Throttling level | Minimum version |
permission management | Checks whether a user has permissions on a specified resource. | Level 2 | Agile Edition | |
Grants a user permissions on a resource. Note Only a super administrator or a resource owner (such as a project administrator or data source administrator) can call this operation. This operation currently supports tables and data sources. | Level 2 | Agile Edition | ||
Revokes a user's permissions on a resource. Note Only a super administrator or a resource owner (such as a project administrator or data source administrator) can call this operation. This operation currently supports tables and data sources. | Level 2 | Agile Edition |
Data asset
Group | OpenAPI name | Description | Throttling level | Minimum version |
asset | Retrieves table lineage information. | Level 2 | Agile Edition | |
Retrieves column lineage information. | Level 2 | Agile Edition | ||
Creates a registered lineage. | Level 2 | Agile Edition | ||
Deletes a registered lineage. | Level 2 | Agile Edition | ||
Creates a business metric. | Level 3 | Agile Edition | ||
Updates a business metric. | Level 3 | Agile Edition | ||
Deletes a business metric. | Level 3 | Agile Edition | ||
Retrieves business metric details. | Level 2 | Agile Edition | ||
Lists assets in an asset catalog. Supports both exact and fuzzy matching. | Level 2 | Agile Edition | ||
Retrieves the details of an asset in the asset catalog. | Level 2 | Agile Edition |
Data service
Group | API | Description | Throttling level | Minimum version | |
Data service | API management | Creates and submits a new data service API. | Level 2 | Basic Edition | |
Publishes a data service API to the production environment. | Level 3 | Basic Edition | |||
Returns a paginated list of published APIs. | Level 2 | Basic Edition | |||
Lists data service API groups. | Level 1 | Basic Edition | |||
Retrieves the API documentation. | Level 2 | Basic Edition | |||
Lists APIs by application. | Level 1 | Basic Edition | |||
Retrieves the detailed fields for APIs an application is authorized to use. | Level 1 | Basic Edition | |||
API authorization | Grants authorization for an API. | Level 3 | Basic Edition | ||
Revokes authorization for an API. | Level 3 | Basic Edition | |||
Requests permissions for a data service API. | Level 2 | Basic Edition | |||
Lists the API permissions you manage. | Level 1 | Basic Edition | |||
Application management | Lists all applications in the tenant. | Level 1 | Basic Edition | ||
Retrieves the details of an application. | Level 1 | Basic Edition | |||
Creates a data service application. | Level 3 | Basic Edition | |||
Updates a data service application. | Level 3 | Basic Edition | |||
Deletes a data service application. | Level 3 | Basic Edition | |||
Resets the secret for a data service application. | Level 3 | Basic Edition | |||
Requests permissions for a data service application. | Level 2 | Basic Edition | |||
Lists applications in a group. | Level 1 | Basic Edition | |||
Application group | Lists the application groups in a data service project. | Level 1 | Basic Edition | ||
Creates an application group. | Level 3 | Basic Edition | |||
Updates an application group. | Level 3 | Basic Edition | |||
Deletes an application group. | Level 3 | Basic Edition | |||
Lists authorized applications in a group. | Level 1 | Basic Edition | |||
Application member | Lists the members of an application. | Level 2 | Basic Edition | ||
Adds a member to an application. | Level 3 | Basic Edition | |||
Updates an application member. | Level 3 | Basic Edition | |||
Removes a member from an application. | Level 3 | Basic Edition | |||
Lists users who are authorized to access an application. | Level 1 | Basic Edition | |||
Project management | Lists the projects that you own. | Level 1 | Basic Edition | ||
Lists projects that you are authorized to access. | Level 1 | Basic Edition | |||
Lists users who can be added as project members. | Level 1 | Basic Edition | |||
Adds a user to a data service project and assigns a role. | Level 2 | Basic Edition | |||
Permission query | Lists your permissions on data service applications. | Level 1 | Basic Edition | ||
Lists applications that you are authorized to access. | Level 1 | Basic Edition | |||
Operations and maintenance monitoring | Retrieves API call trend data. | Level 1 | Basic Edition | ||
Retrieves a summary of API call statistics. | Level 1 | Basic Edition | |||
Retrieves API call statistics. | Level 3 | Basic Edition | |||
Retrieves a paginated list of data service call logs. | Level 2 | Basic Edition | |||
Retrieves a paginated list of impacts from abnormal API calls. | Level 2 | Basic Edition | |||
Retrieves a summary of the impact from API errors. | Level 2 | Basic Edition | |||
Platform management
Group | API name | Description | API throttling level | Minimum version requirement |
User and authorization | Transfers ownership of all objects. | Level 3 | Agile Edition | |
Retries a failed transfer task. | Level 3 | Agile Edition | ||
Retrieves the progress of a transfer task by its ID. | Level 2 | Agile Edition | ||
Adds users to a tenant in batches. Note A super administrator or system administrator can perform this operation. | Level 3 | Agile Edition | ||
Adds tenant members from source users. | Level 2 | Agile Edition | ||
Adds a member to a user group. | Level 2 | Agile Edition | ||
Retrieves a paginated list of permission operation logs. | Level 3 | Agile Edition | ||
Retrieves a paginated list of authorization records. | Level 3 | Agile Edition | ||
Retrieves the project production account. Note A super administrator can perform this operation. | Level 1 | Agile Edition | ||
Creates a user group. | Level 3 | Basic Edition | ||
Deletes a user group. | Level 3 | Basic Edition | ||
Retrieves user details by source user ID. | Level 1 | Agile Edition | ||
Retrieves the details of a user group. | Level 1 | Basic Edition | ||
Retrieves user information in batches by user IDs. | Level 1 | Agile Edition | ||
Retrieves global roles that can be assigned to tenant members. Note This API supports only built-in global roles. It does not support custom global roles. | Level 1 | Agile Edition | ||
Lists users that can be added to the tenant. Note A super administrator or system administrator can perform this operation. | Level 1 | Agile Edition | ||
Lists the members of a tenant. | Level 1 | Agile Edition | ||
Retrieves a paginated list of user groups. | Level 1 | Basic Edition | ||
Retrieves a paginated list of user group members. | Level 1 | Basic Edition | ||
Removes a member from a tenant. Note A super administrator or system administrator can perform this operation. | Level 2 | Agile Edition | ||
Removes a member from a user group. | Level 2 | Basic Edition | ||
Updates a tenant member. Note A super administrator or system administrator can perform this operation. | Level 2 | Agile Edition | ||
Updates a user group. | Level 3 | Basic Edition | ||
Changes the enabled status of a user group. | Level 3 | Basic Edition | ||
Lists the current user's tenants. | Level 1 | Agile Edition | ||
Retrieves the current user's roles. | Level 1 | Agile Edition | ||
Row-level permission | Deletes a row-level permission. | Level 3 | Agile Edition | |
Retrieves all accounts with a specific row-level permission by the permission ID. | Level 3 | Agile Edition | ||
Retrieves a paginated list of row-level permissions. | Level 3 | Agile Edition | ||
Retrieves a paginated list of row-level permissions for a specified user. | Level 3 | Agile Edition | ||
Updates a row-level permission. | Level 3 | Agile Edition | ||
Creates a row-level permission. | Level 3 | Agile Edition | ||
Retrieves row-level permissions by table GUIDs. | Level 3 | Agile Edition | ||
Compute source | Checks the connectivity of a compute source. | Level 3 | Agile Edition | |
Checks the connectivity of an existing compute source by its ID. | Level 3 | Agile Edition | ||
Lists compute sources. | Level 2 | Agile Edition | ||
Updates a compute source. Business segment administrators and project administrators can perform this operation. | Level 3 | Agile Edition | ||
Retrieves the details of a compute source by its ID. | Level 2 | Agile Edition | ||
Deletes a compute source. | Level 3 | Agile Edition | ||
Creates a compute source. Note Business segment administrators and project administrators can perform this operation. | Level 3 | Agile Edition | ||
Retrieves the Spark client information for the cluster associated with the compute source. | Level 2 | Agile Edition | ||
Data source | Retrieves the integration tasks and database SQL tasks that are affected by a data source change. | Level 3 | Agile Edition | |
Checks the connectivity of a data source. | Level 3 | Agile Edition | ||
Checks the connectivity of a data source by its ID. | Level 3 | Agile Edition | ||
Creates a data source. Note Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation. | Level 3 | Agile Edition | ||
Deletes a data source. Note Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation. | Level 3 | Agile Edition | ||
Updates the basic information of a data source. Note Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation. | Level 3 | Agile Edition | ||
Updates the connection configuration of a data source. Note Tenant administrators, data administrators, business segment administrators, project administrators, and operations administrators can perform this operation. | Level 3 | Agile Edition | ||
Retrieves a paginated list of data sources, including their configurations. | Level 2 | Agile Edition | ||
Retrieves the history of data source connectivity tests. | Level 3 | Agile Edition | ||
Project | Checks whether a project has dependencies, such as tasks. | Level 3 | Agile Edition | |
Retrieves the details of a project by its ID. | Level 1 | Agile Edition | ||
Retrieves the details of a project by its name. | Level 1 | |||
Adds a project member. Note Project administrators can perform this operation. | Level 2 | Agile Edition | ||
Retrieves the project whitelist. | Level 1 | Agile Edition | ||
Lists project members. | Level 1 | Agile Edition | ||
Lists projects. | Level 1 | Agile Edition | ||
Removes a project member. Note Project administrators can perform this operation. | Level 2 | Agile Edition | ||
Updates the project whitelist. | Level 3 | Agile Edition | ||
Updates a project member. | Level 2 | Agile Edition | ||
Updates the compute settings for a tenant. | Level 3 | Agile Edition |