This topic describes the applicable scopes, billing methods, and call limits of DataWorks API operations.
Applicable scopes
- Applicable editions: DataWorks Enterprise Edition and DataWorks Ultimate Edition
- Applicable regions: China (Hangzhou), China (Shanghai), China (Shenzhen), China (Beijing), China (Zhangjiakou), China East 2 Finance, and China (Hong Kong)
Billing methods
DataWorks offers a free quota for you to call API operations. After you use up the
free quota, you are charged in pay-as-you-go mode. The following table describes the
billing standards for different editions of DataWorks.
Type | Enterprise Edition | Ultimate Edition |
---|---|---|
Free quota | 1 million calls/month | 10 million calls/month |
Billable API calls | CNY 0.3 per 10,000 calls |
DataWorks offers a monthly free quota for you to call API operations in each region by using your Alibaba Cloud account or a RAM user under your Alibaba Cloud account. After you use up the free quota, you are charged CNY 0.3 per 10,000 calls.
Call limits
In DataWorks, the API operations are classified into three levels to standardize the
call of API operations and ensure the system stability. For more information, see
List of operations by function. The following table describes the call limits of the API operations at different
levels.
Level | Call limit |
---|---|
Level 1 | QPS1 ≤ 50 |
Level 2 | QPS1 ≤ 20 |
Level 3 | QPS1 ≤ 5 and the total number of daily calls2 ≤ 10,000 |
Note:
- 1: the total QPS for the API operations at the current level in each region for an Alibaba Cloud account and its RAM users.
- 2: the total number of daily calls for the API operations at level 3 in each region for an Alibaba Cloud account and its RAM users.
List of operations by function
The following tables list the API operations available for use in DataWorks. The API
operations are related to tenants, metadata, Data Analytics, Operation Center, Data
Quality, and DataService Studio.
- Tenants
Operation Description Level ListCalcEngines Queries compute engines. Level 3 CreateConnection Creates a connection to a data store. Level 2 DeleteConnection Deletes a connection to a data store. Level 2 ListConnections Queries connections to data stores. Level 3 UpdateConnection Updates a connection to a data store. Level 2 ListResourceGroups Queries resource groups. Level 1 GetProjectDetail Queries the information about a DataWorks workspace. Level 1 AddProjectMemberToRole Assigns a role to a user in a DataWorks workspace. Before you call this operation, you must add the user to the DataWorks workspace. Level 2 CreateProjectMember Adds a user to a DataWorks workspace. Level 2 DeleteProjectMember Removes a user from a DataWorks workspace. Level 2 ListProjectRoles Queries roles in a DataWorks workspace. Level 1 RemoveProjectMemberFromRole Removes a role from a user in a DataWorks workspace. Level 2 ListProjectMembers Queries members in a DataWorks workspace. Level 1 ListProjects Queries DataWorks workspaces of the tenant to which a user belongs by page. Level 1 - Metadata
Operation Description Level GetMetaDBInfo Queries the basic metadata information about an engine instance. Level 1 GetMetaDBTableList Queries the tables of an engine instance. Level 1 CheckMetaTable Checks whether a table exists. Level 1 CheckMetaPartition Checks whether a partition exists. Level 1 SearchMetaTables Queries tables based on specified conditions. Level 1 GetMetaTableBasicInfo Queries the basic information about a table. Level 1 GetMetaTableColumn Queries the field information about a table. Level 1 GetMetaTableFullInfo Queries the complete information about a table, including the field information. Level 1 GetMetaTablePartition Queries the partitions of a table. Level 1 GetMetaTableOutput Queries the output information about a table. Level 1 GetMetaTableChangeLog Queries the change logs of a table. Level 1 GetMetaTableIntroWiki Queries the instructions on how to use a table. Level 1 GetMetaTableLineage Queries the lineage of a table. Level 1 GetMetaColumnLineage Queries the lineage of a field. Level 3 CreateMetaCategory Creates a category. Level 2 DeleteMetaCategory Deletes a category. Level 2 UpdateMetaCategory Updates a category. Level 2 GetMetaCategory Queries the category tree. Level 1 GetMetaTableListByCategory Queries tables in a specified category. Level 1 AddToMetaCategory Adds a table to a specified category. Level 2 DeleteFromMetaCategory Removes a table from a specified category. Level 2 CreateTable Creates a MaxCompute table. Level 2 UpdateTable Updates a MaxCompute table. Level 2 DeleteTable Deletes a MaxCompute table. Level 2 GetDDLJobStatus Queries the task status of creating, updating, or deleting a table. Level 1 UpdateMetaTable Updates the metadata information about a table. Level 2 UpdateMetaTableIntroWiki Updates the instructions on how to use a table. If no instruction on how to use the table is available, the instructions that are specified by calling this operation are added. Level 2 ListMetaDB Queries databases. Level 1 UpdateTableModelInfo Updates the folder, level, and category of a table. Level 2 CreateTableTheme Creates a table folder. Level 2 DeleteTableTheme Deletes a table folder. Level 2 UpdateTableTheme Updates a table folder. Level 2 ListTableTheme Queries table folders. Level 1 CreateTableLevel Creates a table level. Level 2 DeleteTableLevel Deletes a table level. Level 2 UpdateTableLevel Updates a table level. Level 2 ListTableLevel Queries table levels. Level 1 - Data Analytics
Operation Description Level CreateFile Creates a file in Data Analytics. Level 3 CreateUdfFile Creates a file for a function in Data Analytics. Level 2 DeleteBusiness Deletes a workflow. Level 3 CreateFolder Creates a folder. Level 2 UpdateBusiness Updates a workflow. Level 2 ListFiles Queries files. Level 1 EstablishRelationTableToBusiness Imports a table to a workflow. This operation is equivalent to right-clicking a workflow on the DataStudio page and selecting Import Table. Level 2 SubmitFile Commits a file to the development environment of the scheduling system to create a task. Level 3 ListBusiness Queries workflows. Level 1 GetFileVersion Obtains the details of a file version. Level 1 DeleteFolder Deletes a folder from Data Analytics. Level 3 DeleteFile Deletes a file from Data Analytics. Level 3 GetDeployment Queries the details of a deployment task. Level 1 UpdateFile Updates a file. Level 2 GetFolder Queries the details of a folder. Level 1 ListFileVersions Queries file versions. Level 1 GetFile Queries the details of a file. Level 1 ListFolders Queries folders. Level 1 DeployFile Deploys a file to the production environment. Level 3 UpdateUdfFile Updates the file information about a function. Level 2 GetBusiness Queries the details of a workflow. Level 1 UpdateFolder Updates the information about a folder. Level 2 - Operation Center
Operation Description Level ListAlertMessages Queries alerts. Level 1 GetBaselineConfig Queries the configurations of a baseline. Level 1 GetNodeOnBaseline Queries the nodes on a baseline. Level 1 ListBaselineConfigs Queries baselines. Level 1 GetBaselineKeyPath Queries the key path of a baseline instance. Level 1 GetBaselineStatus Queries the details of a baseline instance. Level 1 ListBaselineStatuses Queries baseline instances. Level 1 DeleteRemind Deletes a custom alert rule. Level 2 UpdateRemind Updates a custom alert rule. Level 3 CreateRemind Creates a custom alert rule. Level 3 GetRemind Queries the details of a custom alert rule. Level 1 ListReminds Queries custom alert rules. Level 1 ListTopics Queries events. Level 1 GetTopic Queries the details of an event. Level 1 GetTopicInfluence Queries affected baseline instances. Level 1 GetNode Queries the details of a node. Level 1 ListNodeIO Queries the information about the parent and child nodes of a node. Level 1 ListNodes Queries nodes. Level 1 GetNodeCode Queries the code of a node. Level 1 GetInstance Queries the details of an instance. Level 1 ListInstances Queries instances. Level 1 GetInstanceLog Queries the logs of an instance. Level 1 StopInstance Terminates an instance. Level 2 RestartInstance Restarts an instance. Level 2 SetSuccessInstance Resets the status of a failed instance to Successful. Level 2 SuspendInstance Suspends an instance. Level 2 ResumeInstance Resumes a suspended instance. Level 2 CreateDagComplement Creates a workflow to generate retroactive data. Level 2 CreateDagTest Creates a workflow to run a smoke test. Level 2 GetSuccessInstanceTrend Queries the statistics of instances in different periods of a day. Level 3 GetInstanceCountTrend Queries the quantity trend of auto triggered node instances. Level 1 GetInstanceConsumeTimeRank Queries the ranking of the running duration of instances. Level 1 GetInstanceErrorRank Queries the ranking of node errors in the last month. Level 1 ListProgramTypeCount Queries the distribution of node types. Level 1 GetInstanceStatusCount Queries the statistics of instances in different states. Level 1 GetNodeTypeListInfo Queries the information about node types, including the code and name of each node type. Level 1 - Data Quality
Operation Description Level UpdateQualityFollower Updates subscription relationships. Level 2 UpdateQualityRule Updates a monitoring rule. Level 2 GetQualityRule Queries the information about a monitoring rule. Level 1 ListQualityRules Queries monitoring rules based on partition filter expressions. Level 3 CreateQualityRule Creates a monitoring rule. Level 3 DeleteQualityFollower Deletes a subscriber of a partition filter expression. Level 2 DeleteQualityRule Deletes a monitoring rule. Level 2 GetQualityFollower Queries subscribers of a partition filter expression. Level 1 CreateQualityFollower Creates a subscriber of a partition filter expression. Level 3 DeleteQualityEntity Deletes a partition filter expression. Level 2 GetQualityEntity Queries a partition filter expression. Level 1 CreateQualityEntity Creates a partition filter expression. Level 2 CreateQualityRelativeNode Associates a node with a partition filter expression. Level 3 DeleteQualityRelativeNode Disassociates a node from a partition filter expression. Level 2 ListQualityResultsByEntity Queries the monitoring result history based on a partition filter expression. Level 1 ListQualityResultsByRule Queries the monitoring result history based on a monitoring rule. Level 1 - DataService Studio
Operation Description Level CreateDataServiceApi Creates an API in DataService Studio. Level 3 PublishDataServiceApi Publishes an API in DataService Studio. Level 3 DeleteDataServiceApi Deletes an API from DataService Studio. Level 3 ListDataServiceApis Queries the information about APIs in the development state in DataService Studio. Level 1 GetDataServiceApi Queries the information about an API in the development state in DataService Studio. Level 1 UpdateDataServiceApi Updates the information about an API in the development state in DataService Studio. Level 3 GetDataServicePublishedApi Queries the information about an API in the published state in DataService Studio. Level 1 ListDataServicePublishedApis Queries the information about APIs in the published state in DataService Studio. Level 1 ListDataServiceApiAuthorities Queries the APIs on which other users are granted the access permissions. Level 1 ListDataServiceAuthorizedApis Queries authorized APIs. Level 1 AbolishDataServiceApi Unpublishes an API in DataService Studio. Level 3 GetDataServiceApplication Queries the details of an application in DataService Studio. Level 1 ListDataServiceApplications Queries the basic information of applications in DataService Studio. Level 1 CreateDataServiceFolder Creates a folder in DataService Studio. Level 2 GetDataServiceFolder Queries a folder in DataService Studio. Level 1 ListDataServiceFolders Queries one or more folders in DataService Studio. Level 1 CreateDataServiceGroup Creates a workflow in DataService Studio. Level 2 GetDataServiceGroup Queries a workflow in DataService Studio. Level 1 ListDataServiceGroups Queries one or more workflows in DataService Studio. Level 1 CreateDataServiceApiAuthority Grants the access permissions on an API in DataService Studio. Level 3 DeleteDataServiceApiAuthority Revokes the access permissions on an API in DataService Studio. Level 3