Batch Data Processing Service API Overview¶

This version is available for the EnOS 2.1.2 update and later releases. For the previous version, see V2.0.

Starting from the EnOS 2.1.2 internal build, the Dataflow Service is renamed to Batch Data Processing Service. In the API request URL, dataflow-batch-service is changed to batch-processing-service, and the API version is upgraded to V2.1.

Through Batch Data Processing Service APIs, developers can perform required data integration, data development, and data operations during big data analysis. For the complete API list and functional descriptions, see API List.

Prerequisites¶

Ensure that you have obtained a service account, and the service account has the permission to call the Batch Data Processing Service APIs. For more information, see API Authorization.

API List ¶

You can see what operations can be used via these APIs and whether it is applicable to EnOS Cloud and EnOS Edge in the following table.

Operation Name	Description	EnOS Cloud	EnOS Edge
Cancel Flow Instance	Cancel the running of a specified workflow instance.	√	×
Create Directory	Create a directory.	√	×
Delete Flow	Delete a specified workflow.	√	×
Disable Flow	Stop the scheduling of a specified workflow.	√	×
Enable Flow	Start the scheduling of a specified workflow.	√	×
Export Flow	Export a workflow configuration.	√	×
Get Current Time	Get the current time of the server.	√	×
Get Flow	Get the information of a specified workflow.	√	×
Get Flow Instance	Get the information of a specified workflow instance.	√	×
Get My Flow	Search workflows that meet the search criteria.	√	×
Get Task Instance	Get the information of a specified task node instance.	√	×
Get Task Instance Log	Get the log of a specified task instance.	√	×
Get Time Zone	Get the time zone where the server is located.	√	×
Import Flow	Import workflow configuration to create a workflow with the specified name under the specified directory.	√	×
List Flow Instances	Search workflow instances that meet the search criteria.	√	×
List Workflow Directories	Get all the content in the workflow directory of the current OU, including workflow files and sub-directories.	√	×
Load Flow For Edit	Load the specified workflow to a temporary workflow to get the workflow information.	√	×
Save Flow	Save the information of the current workflow.	√	×
Search Flow	Search the basic information of workflows that meet the search criteria.	√	×
Trigger Flow	Trigger a workflow schedule manually.	√	×
Trigger Flow From Task	Manually trigger a workflow schedule (run a specified task and its downstream nodes only).	√	×
Update And Trigger Flow	Trigger workflow scheduling with updated parameters.	√	×

Common Error Codes¶

Code	Message	Description
62101	userId does not exist, or it does not match to orgId.	The parameters `userId` or `orgId` is not valid.
62103	User has no privilege.	The user does not have access permission.
62109	Internal server exception	Internal server exception.