• Home
  • Dynatrace API
  • Environment
  • Log Monitoring v1
  • Custom devices
  • GET analysis job status

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.

GETManaged 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 an access token with Read logs (LogExport) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
customDeviceIdstring

The Dynatrace entity ID of the required custom device.

pathrequired
jobIdstring

The ID of the required log analysis job.

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

pathrequired

Response

Response codes

CodeTypeDescription
200LogJobStatusResult

Success

400ErrorEnvelope

Failed. See the response body for details

Response body objects

The LogJobStatusResult object

The status the log analysis job.

ElementTypeDescription
logAnalysisStatusstring

The status of the log analysis job.

The element can hold these values
  • AGENT_PROCESSING
  • CANCELLED
  • CANCEL_PENDING
  • DOWNLOAD
  • FAILED
  • PROCESSING
  • READY
  • TRANSFERRING
  • WAITING

Can be null.

statusChangeTimestampinteger

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

Can be null.

logHandlingErrorstring

The cause of the job failure.

A successful job has the NONE value.

The element can hold these values
  • AGENT_VERSION_NOT_SUPPORTING_DOCKER
  • CANCELLED
  • FILE_ACCESS_DISABLED
  • FILE_NOT_FOUND
  • INCORRECT_DATE_FORMAT
  • INCORRECT_LOG_FILE
  • INTERNAL_PROCESSING_ERROR
  • INVALID_FILTER_QUERY
  • INVALID_SEARCH_QUERY
  • NONE
  • NO_LOG_AGENT
  • PROCESSOR_FILE_PROCESSING_ERROR
  • PROCESSOR_INTERNAL_ERROR
  • PROCESSOR_INVALID_PARAMETER_ERROR
  • PROCESSOR_NO_LOGS_FILE_FOUND_ERROR
  • PROCESSOR_STOPPING_INTERRUPTED
  • PROCESSOR_TIMED_OUT
  • PROCESSOR_UNHANDLED_EXCEPTION
  • PROCESSOR_UNZIPPING_ERROR
  • REPACK_FAILED_TO_SAVE_LOG_ANALYSIS_IN_STORAGE
  • REPACK_FAILED_TO_STORE_ALL_LOG_ANALYSIS
  • REPACK_FAILED_TO_STORE_LOG_ANALYSIS
  • SOME_LOG_INCORRECT_DATE_FORMAT
  • TIMEOUT

Can be null.

recordsTotalinteger

The number of analyzed log entries.

Can be null.

sortableFieldsstring[]

The map of the log entry sortable fields.

Can be null.

filterableFieldsstring[]

The map of the log entry filterable fields.

Can be null.

Response body JSON model

json
{ "logAnalysisStatus": "AGENT_PROCESSING", "statusChangeTimestamp": 1, "logHandlingError": "AGENT_VERSION_NOT_SUPPORTING_DOCKER", "recordsTotal": 1, "sortableFields": [ "string" ], "filterableFields": [ "string" ] }
Related topics
  • Log Monitoring

    Learn how to enable Log Monitoring, the insights that Log Monitoring can provide, and more.