Data Flow overview
- Print
- PDF
Data Flow overview
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Data Flow provides API through API Gateway of NAVER Cloud Platform.
The access key and secret key are necessary for API authentication.
For more information on API key creation and usage instructions, see API Gateway User Guide > Call API.
For more information on the access key and secret key, see Common Guide > API overview.
Data Flow provides various APIs, and you can check the API specifications and perform simple tests through the Swagger page. See the following content for Data Flow's Swagger documentation.
- Access NAVER Cloud Platform console.
- Click Services > API Gateway in order.
- Click Published APIs > Data Flow > Catalog in order.
- After clicking Data Flow, click API Manual below.
The screen that appears at this time is AiTEMS' Swagger page, and the link displayed at the top of the page (https://dataflow.apigw.ntruss.com/api/v1) is the API address of AiTEMS.
Common settings
Data Flow API URL
https://dataflow.apigw.ntruss.com/api/v1
Request headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | It indicates the time elapsed since January 1, 1970, 00:00:00 (UTC) in milliseconds and the request is considered invalid if the time difference from the API Gateway server is greater than 5 minutesx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Value of access key ID issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specify the request body content type as application/jsonContent-Type: application/json |
Operation
Dashboard
| API name | Description |
|---|---|
| getExecutionResult | View the total number of job executions, and the number of succeeded and failed executions |
| getExecutionCount | View the number of job executions during the specified period |
| getExecutionTimes | View the job execution time during the specified period |
Workflow
| API name | Description |
|---|---|
| getWorkflows | View workflow list |
| getWorkflowById | View workflow |
| createWorkflow | Create workflow |
| updateWorkflow | Edit workflow |
| deleteWorkflow | Delete workflow |
| getWorkflowExecutions | View workflow execution list |
Job
| API name | Description |
|---|---|
| getJobs | View job list |
| getJobById | View job |
| createJob | Create job |
| updateJob | Edit job |
| deleteJob | Delete job |
| verifyJob | Verify job request items |
| executeJob | Execute job |
| getJobExecutions | View job execution list |
| getJobExecutionById | View job execution details |
| updateJobExecuteConfig | Edit job execution settings |
Trigger
| API name | Description |
|---|---|
| getTriggers | View trigger list |
| getTriggerById | View trigger |
| createTrigger | Create trigger |
| deleteTrigger | Delete trigger |
Error response format
If a API request fails, or an error occurs while processing, the success/failure result is returned as an HTTP status code, and the detailed message is returned in JSON format.
Response examples
{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "{workflowId=aa}: Unable to find.",
"instance": "/dataflow/api/workflows/aa",
"errorType": "resource-not-found/WORKFLOW"
}
Error response
| HTTP status code | Error type | Messages | Description | Solutions |
|---|---|---|---|---|
| 400 | bad-parameter | Check the parameters. | Request parameters error | Reconfirm the requested value |
| 400 | bad-state | Check the status. | Request status error | Reconfirm the status of the requested target |
| 404 | resource-not-found/ | The item can't be found. | Requested resource ID error | Reconfirm the requested target |
| 400 | client-request-failed | Failed to the request. | Linked product request error | View linked products |
| 400 | client-resource-not-found | The resource can't be found. | Linked product resource error | View linked product resource |
| 400 | client-unauthorized | You don't have permissions. | Linked product permission error | View linked product permission |
| 500 | unknown-resource-action/ | An unexpected error has occurred. | Job execution error | Contact us through Customer Support > Contact us |
Was this article helpful?