Getting a task run log for live monitoring - Cloud

Talend Cloud APIs User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Design and Development > Designing APIs
Design and Development > Testing APIs
Use the GET method to obtain logs of a task run from the /executions/{runId}/logs endpoint.

Before you begin

  • You must have the Author, the Viewer and the Executor permissions for the workspace to which the task to be monitored belongs.
  • You must know the ID of the task run you need to monitor.

    This ID is available on the Task execution log page, reading as Task execution ID. Or you can obtain this ID via a GET call from the /executables/tasks/{taskId}/executions endpoint.

About this task

You can access the Management Console API via https://api.us.cloud.talend.com/tmc/swagger/swagger-ui.html. You'll find a list of the URLs corresponding to each data center in Talend Cloud regions and URLs.

In this example, Talend API Tester is used to issue API requests. For further information about Talend API Tester, see Talend Cloud API Tester User Guide.

Procedure

  1. If you do not have a personal access token yet, on the Users page of Talend Cloud Management Console, generate a personal access token for your account.
  2. Open Talend API Tester in your browser and select GET from the Method list.
  3. In the field next to the Method drop-down list, enter the endpoint to be used: https://api.<your_environment>.cloud.talend.com/tmc/v2.5/executions/<runId>/logs

    Example

  4. In the HEADERS area, click Add header and in the name field that is displayed, enter Authorization and in the value field, enterBearer and your personal access token. Enter a whitespace to separate Bearer and your personal access token.
  5. Click Send to issue your request.
  6. Click the Save button to save this request in your repository on Talend API Tester.

Results

You can then integrate this API call in your own monitoring system to continuously get and analyze the latest information of this run, so that your monitoring system can send notifications accordingly and timely.