Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB
Data Processing
Batch Jobs

Logs for a batch job

Lists log entries for the batch job, usually for debugging purposes.

Back-ends can log any information that may be relevant for a user at any stage (status) of the batch job. Users can log information during data processing using respective processes such as inspect.

If requested consecutively, it is RECOMMENDED that clients use the offset parameter to get only the entries they have not received yet.

While pagination itself is OPTIONAL, the offset parameter is REQUIRED to be implemented by back-ends.

get/jobs/{job_id}/logs

Path parameters

job_idstring required

Per-back-end unique identifier of the batch job, generated by the back-end during creation. MUST match the specified pattern.

Example:a3cca2b2aa1e3b5b

Identifier of the batch job.

Query parameters

offsetstring

The last identifier (property id of a log entry) the client has received. If provided, the back-end MUST only send the entries that occurred after the specified identifier. If not provided or empty, the back-end MUST start with the first entry.

level'error' | 'warning' | 'info' | 'debug'

The minimum severity level for log entries that the back-end returns.

The order of the levels is as follows (from low to high severity): debug, info, warning, error. That means if warning is set, the back-end will only return log entries with the level warning and error.

The default minimum log level is debug, which returns all log levels.

limitinteger

This parameter enables pagination for the endpoint and specifies the maximum number of elements that arrays in the top-level object (e.g. collections, processes, batch jobs, secondary services, log entries, etc.) are allowed to contain. The links array MUST NOT be paginated like the resources, but instead contain links related to the paginated resources or the pagination itself (e.g. a link to the next page). If the parameter is not provided or empty, all elements are returned.

Pagination is OPTIONAL: back-ends or clients may not support it. Therefore, it MUST be implemented in a way that clients not supporting pagination get all resources regardless. Back-ends not supporting pagination MUST return all resources.

If the response is paginated, the links array MUST be used to communicate the links for browsing the pagination with predefined rel types. See the links array schema for supported rel types. Back-end implementations can, unless specified otherwise, use any kind of pagination technique, depending on what is supported best by their infrastructure: page-based, offset-based, token-based or something else. The clients SHOULD use whatever is specified in the links with the corresponding rel types.

Response

Lists the requested log entries.

level'error' | 'warning' | 'info' | 'debug'

The minimum severity level for log entries that the back-end returns. This property MUST reflect the effective lowest level that may appear in the document, which is (if implemented) the highest level of:

  1. the log_level specified by the user for the processing request.
  2. the level specified by the user for the log request.

The order of the levels is as follows (from low to high severity): debug, info, warning, error. That means if warning is set, the logs will only contain entries with the level warning and error.

Example response

{
  "logs": [
    {
      "id": "1",
      "code": "SampleError",
      "level": "error",
      "message": "Can not load the UDF file from the URL `https://openeo.example/invalid/file.txt`. Server responded with error 404.",
      "path": [
        {
          "node_id": "runudf1",
          "process_id": "ndvi",
          "parameter": "udf"
        }
      ],
      "usage": {
        "cpu": {
          "value": 40668,
          "unit": "cpu-seconds"
        },
        "duration": {
          "value": 2611,
          "unit": "seconds"
        },
        "memory": {
          "value": 108138811,
          "unit": "mb-seconds"
        },
        "network": {
          "value": 0,
          "unit": "kb"
        },
        "storage": {
          "value": 55,
          "unit": "mb"
        }
      },
      "links": [
        {
          "href": "https://openeo.example/docs/errors/SampleError",
          "rel": "about"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "related",
      "href": "https://openeo.example",
      "type": "text/html",
      "title": "openEO"
    }
  ]
}