Execution Logs
Endpoints
- https://api.eu.cloud.talend.comURL for the AWS Europe region
- https://api.ap.cloud.talend.comURL for the AWS Asia Pacific region
- https://api.us.cloud.talend.comURL for the AWS United States East region
- https://api.au.cloud.talend.comURL for the AWS Australia region
- https://api.us-west.cloud.talend.comURL for the Azure United States West region
Security scheme
This scheme can be referenced across the API
Public
| Name | Description |
|---|---|
| Format | Bearer <token> |
Logs
Delete logs of a specified execution
DELETE /monitoring/executions/{id}/logsExecution Logs - Delete permission (ID: EXECUTION_LOGS_DELETE) to delete logs for a given execution identified by its ID.Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Required |
Response
200Status 200
500Status 500
Generate logs for a completed or ongoing execution
POST /monitoring/executions/{id}/logsThis endpoint generates the log of a given task run and returns a download token for this log (maximum log size: 100,000). Logs earlier than 30 days are deleted This token is valid for one hour.
If the desired log size exceeds the 100,000-entry limit, use the time range parameters (startTime or endTime or both) to split the requests. Adjust the time range for each request to retrieve all log entries by making multiple calls.
For example, use endTime in each request to retrieve up to 100,000 log entries before that time. Repeat with earlier endTime values until you have retrieved the desired log history.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| fileFormat | Format of the log file to be generated. The available formats are json and text. | string Optional | JSON fileFormat=TEXT |
| endTime | Latest date and time of the logs to be put in the generated log. By default, current time is used | string Optional | 2021-06-14T15:04:45Z |
| newFileName | This parameter indicates whether you need to include task IDs and execution IDs in the filename of the log to be generated. It generates a distinctive file name reading like: It is recommended to set this value to be true as the old filename format is going to be deprecated. | boolean Optional | |
| startTime | The earliest log entries by date and time to include in the generated log. Log entries older than 30 days are automatically deleted. If you omit this parameter, the generated log includes available entries from the start of the run. If the run started more than 30 days before the request, only entries from the 30 days before the request are available. | string Optional | 2021-06-14T07:01:45Z |
Response
200Status 200
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| size | Number of lines in logs | integer Required | |
| token | Token used to check the status of the log file generation | string Required |
206Status 206
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| size | Number of lines in logs | integer Required | |
| token | Token used to check the status of the log file generation | string Required |
Get task execution logs
GET /monitoring/executions/{id}/logsLogs earlier than 30 days are automatically cleared.
Use cases
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Required |
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| count | Number of log entries to return. The default value is 50 and the maximum value is 200 | number Optional | 50 |
| endTime | latest date and time of the logs to be retrieved. By default, current time is used | datetime Optional | 2021-06-14T15:04:45Z |
| order | The way in which the returned logs are sorted by their timestamps. The default value is DESC, meaning the latest logs are put first | string Optional | DESC |
| startIndex | Start position of the pagination of the logs, greater or equal to 0 | number Optional | |
| startTime | The earliest log entries by date and time to include in the generated log. Log entries older than 30 days are automatically deleted. If you omit this parameter, the generated log includes available entries from the start of the run. If the run started more than 30 days before the request, only entries from the 30 days before the request are available. | datetime Optional | 2021-06-14T07:01:45Z |
Response
200Status 200
| Name | Description | Type | Attributes and examples | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| size | Number of log entries in the current page | number Required | |||||||||||||||||||||||||||||||||||||||||||||
| totalSize | Total number of log entries for the give execution ID | number Required | |||||||||||||||||||||||||||||||||||||||||||||
| totalSizeFiltered | Total number of log entries for the given execution ID, for the specific time range defned in the request | number Optional | |||||||||||||||||||||||||||||||||||||||||||||
| data | array of Object Optional |
| |||||||||||||||||||||||||||||||||||||||||||||
| nextIndex | Next index for pagination if it exists | number Optional | |||||||||||||||||||||||||||||||||||||||||||||
Check log generation status and return download URL
POST /monitoring/executions/{id}/logs/statusCheck the status of the generated log and return a download URL.
You need to put the download token in the body.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Required |
aec20220-f745-4da6-a5e0-b6dfe083eee5Response
200Status 200
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| presignedURL | URL to download full logs, valid for 60 minutes | string Optional | |
| status | Status of full log file generation | string Required |
ErrorResponse
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| status | number Required | ||
| message | string Optional | ||
| requestId | string Optional | ||
| detail | detail message for 401 - unauthorized error | string Optional |