API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (dataworks-public/2020-05-18) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Tenant
|
API |
Title |
Description |
| CreateDataSource | CreateDataSource | Adds a data source to DataWorks. |
| ListDataSources | ListDataSources | Queries the data sources added to a DataWorks workspace. |
| UpdateDataSource | UpdateDataSource | Updates a data source. |
| DeleteDataSource | DeleteDataSource | Removes a data source. |
| ListResourceGroups | ListResourceGroups | Queries a list of resource groups of a specific type. |
| GetProject | GetProject | Queries the information about a DataWorks workspace. |
| AddProjectMemberToRole | AddProjectMemberToRole | Assigns a role to a member of a DataWorks workspace. Before you call this operation, you must add your account to a DataWorks workspace as a member. |
| CreateProjectMember | CreateProjectMember | Adds a user to a DataWorks workspace. |
| DeleteProjectMember | DeleteProjectMember | Removes a user from a DataWorks workspace. |
| ListProjectRoles | ListProjectRoles | Queries a list of roles in a DataWorks workspace. |
| RemoveProjectMemberFromRole | RemoveProjectMemberFromRole | Removes a role from a user in a DataWorks workspace. |
| ListProjectMembers | ListProjectMembers | Queries a list of existing members in a DataWorks workspace. |
| ListProjects | ListProjects | Queries a list of DataWorks workspaces of the tenant to which a user belongs. |
| ListProjectIds | ListProjectIds | Queries the IDs of the workspaces on which a specific Alibaba Cloud account or RAM user has permissions in a specific region. |
| CreateProject | CreateProject | Creates a DataWorks workspace. |
| ChangeResourceManagerResourceGroup | ChangeResourceManagerResourceGroup | Changes the resource group of a resource. |
| ListMeasureData | ListMeasureData | Queries the statistics on the number of phone call-based alerts or text message-based alerts reported within the tenant to which your account belongs during the previous 30 days. |
Metadata
|
API |
Title |
Description |
| ListTables | ListTables | Obtains tables of different data source types within a tenant by page. |
| GetMetaDBInfo | GetMetaDBInfo | Queries the basic metadata information about a compute engine instance. |
| GetMetaDBTableList | GetMetaDBTableList | Retrieves all tables in the specified Engine Instance. |
| CheckMetaTable | CheckMetaTable | Checks whether a metatable exists. |
| CheckMetaPartition | CheckMetaPartition | Checks whether a partition in a MaxCompute metatable exists. |
| SearchMetaTables | SearchMetaTables | Queries metatables based on specific conditions. |
| GetMetaTableBasicInfo | GetMetaTableBasicInfo | Queries the basic information about a metatable. |
| GetMetaTableColumn | GetMetaTableColumn | Queries the field information of a metatable. |
| GetMetaTablePartition | GetMetaTablePartition | Retrieves a list of partitions for a table. |
| GetMetaTableOutput | GetMetaTableOutput | Queries the output information of a metatable. |
| GetMetaTableChangeLog | GetMetaTableChangeLog | Queries the change logs of a metatable. |
| GetMetaTableIntroWiki | GetMetaTableIntroWiki | Queries the instructions on how to use a table. |
| CreateMetaCategory | CreateMetaCategory | Creates a category. |
| DeleteMetaCategory | DeleteMetaCategory | Deletes a category. |
| UpdateMetaCategory | UpdateMetaCategory | Updates a category. |
| GetMetaCategory | GetMetaCategory | Queries the information about a category tree. |
| GetMetaTableListByCategory | GetMetaTableListByCategory | Queries metatables in a specified category. |
| AddToMetaCategory | AddToMetaCategory | Adds a metatable to a specified category. |
| DeleteFromMetaCategory | DeleteFromMetaCategory | Removes a table from a specified category. |
| UpdateMetaTable | UpdateMetaTable | This operation updates the metadata of a table. |
| UpdateMetaTableIntroWiki | 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 configured by calling this operation are added. |
| ListMetaDB | ListMetaDB | Queries a list of metadatabases. |
| UpdateTableModelInfo | UpdateTableModelInfo | Modifies the information about a table, such as the table folder, level, and category. |
| CreateTableTheme | CreateTableTheme | Creates a table theme. This operation will be replaced soon. We recommend that you do not call this operation. |
| DeleteTableTheme | DeleteTableTheme | Deletes a table theme. This operation will be replaced soon. We recommend that you do not call this operation. |
| UpdateTableTheme | UpdateTableTheme | Updates a table theme. This operation will be replaced soon. We recommend that you do not call this operation. |
| ListTableTheme | ListTableTheme | Lists table themes. This operation will be replaced soon. We recommend that you do not call this operation. |
| GetMetaTableThemeLevel | GetMetaTableThemeLevel | Fetches topics and hierarchy metadata for tables |
| CreateTableLevel | CreateTableLevel | Creates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation. |
| UpdateTableLevel | UpdateTableLevel | Updates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation. |
| DeleteTableLevel | DeleteTableLevel | Deletes a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation. |
| ListTableLevel | ListTableLevel | Lists hierarchy levels. This operation will be replaced soon. We recommend that you do not call this operation. |
| UpdateMetaCollection | UpdateMetaCollection | Updates the name and comment of a collection. |
| ListMetaCollections | ListMetaCollections | Queries information about collections. Collections include data albums that are displayed on the Data Map page and categories that are created in the data albums. You can call this API operation to query collections by type. |
| DeleteMetaCollection | DeleteMetaCollection | Deletes a collection. |
| GetMetaCollectionDetail | GetMetaCollectionDetail | Queries the information about a collection. |
| RegisterLineageRelation | RegisterLineageRelation | Registers the lineage between self-managed entities to DataWorks. |
Data Development
|
API |
Title |
Description |
| CreateFile | CreateFile | Creates a file in DataStudio. You cannot call this operation to create files for Data Integration nodes. |
| CreateUdfFile | CreateUdfFile | Creates a file for a function in DataStudio. |
| CreateBusiness | CreateBusiness | Creates a workflow in DataStudio. |
| DeleteBusiness | DeleteBusiness | Deletes a workflow. |
| CreateFolder | CreateFolder | The operation that you want to perform. Set the value to \\*\\*CreateFolder\\*\\*. |
| UpdateBusiness | UpdateBusiness | Updates a workflow. |
| EstablishRelationTableToBusiness | EstablishRelationTableToBusiness | Imports a table to a workflow. The call to this API operation is equivalent to performing the following operations: Go to the DataStudio page, find the desired workflow, and then click the workflow name. Right-click Table under the desired folder and select Import Table. |
| SubmitFile | SubmitFile | Commits a file to the development environment of the scheduling system to generate a task. |
| GetFileVersion | GetFileVersion | Queries the information about a file version. |
| DeleteFolder | DeleteFolder | Deletes a folder from the Data Development page. |
| DeleteFile | DeleteFile | Deletes a file from DataStudio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process. |
| GetDeployment | GetDeployment | Queries the information about a deployment package. |
| GetFolder | GetFolder | You can call GetFolder to retrieve the details of a folder. |
| ListFileVersions | ListFileVersions | Queries a list of file versions. |
| ListFolders | ListFolders | Call the ListFolders operation to query for folders. |
| DeployFile | DeployFile | Deploys a file to the production environment. |
| UpdateUdfFile | UpdateUdfFile | Updates the file information about a function. |
| GetBusiness | GetBusiness | Queries the information about a workflow. |
| GetIDEEventDetail | GetIDEEventDetail | Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered. |
| CreateResourceFile | CreateResourceFile | Creates or uploads a resource file in DataStudio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE). |
Data Integration
|
API |
Title |
Description |
| UpdateDISyncTask | UpdateDISyncTask | Updates a data synchronization task. |
| TestNetworkConnection | TestNetworkConnection | Tests the network connectivity between a data source and a resource group. |
| GetDISyncTask | GetDISyncTask | Queries the details of a real-time synchronization task or a data synchronization solution. |
| DeployDISyncTask | DeployDISyncTask | Deploys a real-time synchronization task. |
| GetDISyncInstanceInfo | GetDISyncInstanceInfo | Queries the status of a real-time synchronization task or a data synchronization solution. |
| GenerateDISyncTaskConfigForUpdating | GenerateDISyncTaskConfigForUpdating | Generates the JSON for an asynchronous thread that is used to update a real-time synchronization task in Data Integration. |
| QueryDISyncTaskConfigProcessResult | QueryDISyncTaskConfigProcessResult | Queries the execution results of an asynchronous task. |
| CreateDIJob | CreateDIJob | Creates a new-version synchronization task. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres and batch synchronization of all data in a MySQL database to Hive. |
| GetDIJob | GetDIJob | Queries the information about a new-version synchronization task created in Data Integration. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres. |
| UpdateDIJob | UpdateDIJob | Updates a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres. |
| CreateDIAlarmRule | CreateDIAlarmRule | Creates an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres. |
| GetDIAlarmRule | GetDIAlarmRule | Queries the details of an alert rule configured for a new-version synchronization task. Only the following types of tasks are supported: real-time data synchronization from a MySQL database to Hologres. |
| ListDIAlarmRules | ListDIAlarmRules | Queries a list of alert rules configured for a new-version synchronization task. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres. |
| UpdateDIAlarmRule | UpdateDIAlarmRule | Updates an alert rule for a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres. |
Operation Center
|
API |
Title |
Description |
| GetAlertMessage | GetAlertMessage | Queries alert information based on the alert ID that is specified by the AlertId parameter. |
| ListAlertMessages | ListAlertMessages | Queries a list of alerts. |
| GetBaselineConfig | GetBaselineConfig | Queries the configurations of a baseline. |
| ListNodesByBaseline | ListNodesByBaseline | Queries nodes in a baseline. |
| ListBaselineConfigs | ListBaselineConfigs | Queries a list of baselines. |
| GetBaselineKeyPath | GetBaselineKeyPath | The information about the events that are associated with the instance. |
| DeleteRemind | DeleteRemind | Deletes a custom monitoring alert rule. |
| CreateRemind | CreateRemind | Creates a custom alert rule. |
| GetRemind | GetRemind | Queries the information about a custom alert rule. |
| ListReminds | ListReminds | Queries a list of custom alert rules. |
| GetTopic | GetTopic | Queries the information about an event. |
| GetTopicInfluence | GetTopicInfluence | Queries baseline instances affected by an event. |
| GetNode | GetNode | Indicates whether the request is successful. |
| ListNodeInputOrOutput | ListNodeInputOrOutput | Queries the input and output information about a node. Only the ancestor or descendant nodes at the nearest level can be queried each time. |
| ListNodes | ListNodes | The ID of the workspace. |
| RestartInstance | RestartInstance | Restarts an instance. |
| SuspendInstance | SuspendInstance | Suspends an instance. |
| TopTenElapsedTimeInstance | TopTenElapsedTimeInstance | Queries the ranking of the running durations of instances. |
| TopTenErrorTimesInstance | TopTenErrorTimesInstance | Queries the ranking of nodes on which errors occur within the previous month. |
| GetInstanceStatusStatistic | GetInstanceStatusStatistic | Queries the number of instances that are in each state. |
| RunManualDagNodes | RunManualDagNodes | Runs nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find a manually triggered workflow in Operation Center only after the manually triggered workflow is committed and deployed. |
| GetDag | GetDag | Queries the information about a directed acyclic graph (DAG). You can call the GetDag operation to query the information about the DAG for a manually triggered workflow, a manually triggered node, or a data backfill instance. However, you cannot query the information about the DAG for an auto triggered node or an auto triggered workflow. |
| ListNodesByOutput | ListNodesByOutput | Queries nodes based on the output of the nodes. |
| GetNodeParents | GetNodeParents | Queries a list of ancestor nodes of a node. |
| GetNodeChildren | GetNodeChildren | Queries a list of instances. |
| UpdateWorkbenchEventResult | UpdateWorkbenchEventResult | Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension. |
| ListShiftPersonnels | ListShiftPersonnels | Queries a list of on-duty engineers in a shift schedule. |
| ListShiftSchedules | ListShiftSchedules | Queries a list of shift schedules in Operation Center. |
| ListInnerNodes | ListInnerNodes | Queries information about inner nodes. For example, you can call this operation to query the inner nodes of a node group or a do-while node. You cannot call this operation to query the inner nodes of a PAI node. |
| GetBaseline | GetBaseline | Queries the information about a baseline based on its ID. |
| ListBaselines | ListBaselines | Obtains a list of baselines. |
| CreateBaseline | CreateBaseline | Creates a baseline. |
| UpdateBaseline | UpdateBaseline | Updates a baseline. |
Data Quality
|
API |
Title |
Description |
| UpdateQualityRule | UpdateQualityRule | Updates a monitoring rule. |
| GetQualityRule | GetQualityRule | Queries the information about a monitoring rule. |
| ListQualityRules | ListQualityRules | Queries monitoring rules based on a partition filter expression. |
| GetQualityFollower | GetQualityFollower | Queries the subscribers of a partition filter expression. |
| GetQualityEntity | GetQualityEntity | Queries the information about a partition filter expression. |
| DeleteQualityRelativeNode | DeleteQualityRelativeNode | Disassociates a node from a partition filter expression. |
| ListQualityResultsByEntity | ListQualityResultsByEntity | Queries a list of historical check results based on a partition filter expression. |
| ListQualityResultsByRule | ListQualityResultsByRule | Queries monitoring results after the data quality of a data source or a compute engine is monitored based on monitoring rules. |
DataService Studio
|
API |
Title |
Description |
| CreateDataServiceApi | CreateDataServiceApi | Creates an API. |
| GetDataServicePublishedApi | GetDataServicePublishedApi | Queries the information about a DataService Studio API in the published state. |
| ListDataServicePublishedApis | ListDataServicePublishedApis | Queries a list of APIs in the published state. |
Security Center
|
API |
Title |
Description |
| CreatePermissionApplyOrder | CreatePermissionApplyOrder | Creates a permission request. |
| GetPermissionApplyOrderDetail | GetPermissionApplyOrderDetail | Queries the details of a permission request. |
| ListPermissionApplyOrders | ListPermissionApplyOrders | Queries a list of permission requests. |