Custom device logs API v1 - GET analysis job status

Gets the status of the specified log analysis job.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs/jobs/{jobId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs/jobs/{jobId}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs/jobs/{jobId}

Authentication

To execute this request, you need the Read logs (LogExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
customDeviceId string

The Dynatrace entity ID of the required custom device.

path required
jobId string

The ID of the required log analysis job.

You can retrieve it from the response of the POST analysis job request.

path required

Response

Response codes

Code Description
200

Success

400

Failed. See the response body for details

Response body

The LogJobStatusResult object

The status the log analysis job.

Element Type Description
logAnalysisStatus string

The status of the log analysis job.

statusChangeTimestamp integer

The timestamp of the last status change, in UTC milliseconds.

logHandlingError string

The cause of the job failure.

A successful job has the NONE value.

recordsTotal integer

The number of analyzed log entries.

sortableFields string[]

The map of the log entry sortable fields.

filterableFields string[]

The map of the log entry filterable fields.