Categories

Versions

Get Jobs (AI Hub) (Admin Tools)

Synopsis

This operator gets a list of all jobs that have been executed on an AI Hub.

Description

This operator retrieves a list of all jobs that have been executed on an AI Hub in reverse chronological order. This list contains the exact the same information as the Executions page within the AI Hub web interface. For each job, the resulting ExampleSet contains a job id, queueName, process location, state, ownerId, execution duration (in milliseconds), usedMemory (in kb), maxMemory of the container (in kb), a reportedError flag, and several timestamps (createdAt, dequeuedAt, startedAt, and endedAt).

Note that this list only contains job executions run inside job containers. Executions via webservice requests will not appear in this list.

If the list contains more than 20 jobs, the operator will only return the 20 most recent jobs. This is considered the first page of the list. For all subsequent pages (i.e. all jobs older than the most recent 20), there is a page number parameter that can be set manually or via a macro. All pages, and jobs on each page, are again in reverse chronological order.

As with other operators in this extension, the input of this operator requires an AI Hub Connection IOObject with sufficient information and credentials (server_url, client_secret, and refresh_token) to access the AI Hub API. You can create an AI Hub connection IOObject in Studio by going to Create Connections selection in the Connections menu. The client_secret and refresh tokens can be obtained by logging to the AI Hub as an administrator in the web interface and then directly navigating to this URL: [server_url]/get-token. If all the information is entered correctly, a new AI Hub Connection IOObject will appear in the Connections folder of your repository. This Connection IOObject now can be connected to any Admin extension operator con input port when needed.

Input

  • con (Connection)

    An AI Hub Connection IOObject.

Output

  • con

    The AI Hub Connection IOObject from the input port, delivered as a passthru.

  • exa (Data Table)

    An ExampleSet containing information about all jobs that have been executed on an AI Hub.

Parameters

  • page A page number of the list, expressed as an integer e.g. 1, 2, 3, etc... Range:
  • include_archived If set to true archived jobs will be shown. Range: