Data Flow overview

Prev Next

Available in VPC

Data Flow is a fully managed data integration service on NAVER Cloud Platform that allows you to configure, execute, and monitor complex workflows for extracting, transforming, and loading large amounts of data. The Data Flow service provides APIs for workflow, job, and trigger features in RESTful form.

Common Data Flow settings

The following describes commonly used request and response formats in Data Flow APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://dataflow.apigw.ntruss.com

Request headers

The following describes the request headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
  • Unix timestamp format
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)

Response

The following describes the common response format.

Response body

The response body includes the following data:

ErrorResponse
ErrorResponse defines API call failure information. The following describes ErrorResponse.

Field Type Required Description
error Object - Error code and message
error.errorCode String Required Errors
error.message String Required Error message
error.details String Required Error message detailed description

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description Solution
200 - OK Request processing successful -
201 - Created Creation completed -
202 - Request is accepted but not completed yet. The request has been accepted but not yet completed. -
204 - No Content Request processed successfully, no content returned. -
400 - Bad Request Invalid request Check request syntax.
400 - bad-parameter Request parameter error Check request value.
400 - bad-state Request status error. Check the status of request target.
400 - client-request-failed Request error for integrated service. Check integrated service.
400 - client-resource-not-found Resource error for integrated service. Check resource of integrated service.
400 - client-unauthorized Permission error for integrated service. Check permission of integrated service.
400 - No valid member exists of given member number. Invalid request Recheck request parameters and headers.
401 - Unauthorized Authentication failed Check the permissions of the task's creator and requester
403 - Forbidden Server operation denied Check permissions for requested features
404 - resource-not-found Requested resource ID error. Check request target.
500 - unknown-resource-action Job execution error. Inquire via Contact us in the NAVER Cloud Platform portal.
500 - Internal Server Error Internal server errors Try again later.
Note

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Invalid authentication information."
    }
}

Data Flow API

The following describes the APIs provided by the Data Flow service.

Dashboard

The following describes the dashboard-related APIs.

API Description
getExecutionInterval Get job execution count.
getExecutionResult Get job execution count, success count, and failure count.
getExecutionTimes Get job execution time.

Workflow

The following describes the workflow-related APIs.

API Description
createWorkflow Create workflow.
getWorkflows Get workflow list.
getWorkflowById Get workflow details.
getWorkflowExecutions Get workflow execution list.
updateWorkflow Edit workflow.
deleteWorkflow Delete workflow.

Job

The following describes the job-related APIs.

API Description
createJob Create job.
getJobs Get job list.
getJobById Get job details.
updateJob Edit job.
verifyJob Verify job execution request items.
executeJob Run job.
getJobExecutions Get job execution list.
getJobExecutionById Get job execution details.
updateJobExecuteConfig Edit job execution option.
deleteJob Delete job.

Trigger

The following describes the trigger-related APIs.

API Description
createTrigger Create trigger.
getTriggers Get the list of triggers.
getTriggerById Get details of a single trigger.
deleteTrigger Delete trigger.

Data Flow related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Data Flow APIs.