getJobs
- Print
- PDF
getJobs
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get the list of jobs.
GET https://dataflow.apigw.ntruss.com/api/v1/jobs?page={page}&limit={limit}
Request
Request parameter
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| name | No | String | Job name | |
| status | No | String | RUNNABLE, RUNNING, DELETED, UNKNOWN, DRAFT, STOPPED, EDITING | Job status |
| page | No | Number | Page | |
| limit | No | Number | Maximum number per page |
Response
| Field name | Type | Description | Remarks |
|---|---|---|---|
| list[].jobId | String | Task ID | |
| list[].name | String | Job name | |
| list[].type | String | Job type | |
| list[].status | String | Job status | |
| list[].lastExecutionStatus | String | Last execution status | |
| list[].createdDate | String | Job creation date | |
| list[].updatedDate | String | Last update | |
| list[].lastExecutionDate | String | Last execution date | |
| list[].resourceId | String | Resource ID (same as the job ID) | |
| list[].disabled | Boolean | Whether you have permission to view the resource | |
| count | Number | Total count | |
| page | Number | Page | |
| limit | Number | Maximum number per page |
Response status
| HTTP Status | Desc |
|---|---|
| 200 | OK (Successfully searched) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Examples
Request example
GET /api/v1/jobs?page=0&limit=1000
Host: dataflow.apigw.ntruss.com
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}
Response example
{
"list": [
{
"jobId": "5Yns7JgRt25f",
"name": "data-flow",
"type": "DATAFLOW",
"status": "RUNNABLE",
"lastExecutionStatus": "COMPLETED",
"createdDate": "2023-10-20T13:45:15.000",
"updatedDate": "2023-10-20T13:46:56.000",
"lastExecutionStatus": "2023-10-20T13:46:56.000",
"resourceId": "5Yns7JgRt25f",
"disabled": false
},
{
"jobId": "qOxHK8QR61ZB",
"name": "test",
"description": "",
"type": "DATAFLOW",
"status": "RUNNABLE",
"lastExecutionStatus": "COMPLETED",
"createdDate": "2023-09-18T17:45:03.000",
"updatedDate": "2023-10-20T14:20:19.000",
"lastExecutionStatus": "2023-10-20T13:46:56.000",
"resourceId": "qOxHK8QR61ZB",
"disabled": false
}
],
"count": 2,
"page": 0,
"limit": 1000
}
Was this article helpful?