About Batch Data Processing Service API¶
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
.
The Batch Data Processing Service provides data integration, data development, data operation, and maintenance services that are required for batch data analysis. For details, see the API documentation:
Refer to the table below for the list of APIs, and whether they can be used by EnOS Cloud and EnOS Edge.
API List¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Cancel the running of a specified workflow instance. |
√ |
× |
|
Create a directory. |
√ |
× |
|
Delete a specified workflow. |
√ |
× |
|
Stop the scheduling of a specified workflow. |
√ |
× |
|
Start the scheduling of a specified workflow. |
√ |
× |
|
Export a workflow configuration. |
√ |
× |
|
Get the current time of the server. |
√ |
× |
|
Get the information of a specified workflow. |
√ |
× |
|
Get the information of a specified workflow instance. |
√ |
× |
|
Search workflows that meet the search criteria. |
√ |
× |
|
Get the information of a specified task node instance. |
√ |
× |
|
Get the log of a specified task instance. |
√ |
× |
|
Get the time zone where the server is located. |
√ |
× |
|
Import workflow configuration to create a workflow with the specified name under the specified directory. |
√ |
× |
|
Search workflow instances that meet the search criteria. |
√ |
× |
|
Get all the content in the workflow directory of the current OU, including workflow files and sub-directories. |
√ |
× |
|
Load the specified workflow to a temporary workflow to get the workflow information. |
√ |
× |
|
Save the information of the current workflow. |
√ |
× |
|
Search the basic information of workflows that meet the search criteria. |
√ |
× |
|
Trigger a workflow schedule manually. |
√ |
× |
|
Manually trigger a workflow schedule (run a specified task and its downstream nodes only). |
√ |
× |
|
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 |
62103 |
User has no privilege. |
The user does not have access permission. |
62109 |
Internal server exception |
Internal server exception. |