Process groups log monitoring API - 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/process-groups/{pgId}/logs/jobs/{jobId} SaaS https://{your-environment-id}.live.dexp.ae/api/v1/entity/infrastructure/process-groups/{pgId}/logs/jobs/{jobId}

Authentication

To execute this request, you need the Access logs permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter Type Description In Required

pgId

string

Parameter	Type	Description	In	Required
pgId	string	The entity ID of the required process group.	path	required
jobId	string	The ID of the required analysis job. You can retrieve it from the response of the `POST /entity/infrastructure/process-groups/{pgId}/logs/{logPath}` request.	path	required

The entity ID of the required process group.

path

required

jobId

string

The ID of the required analysis job.

You can retrieve it from the response of the POST /entity/infrastructure/process-groups/{pgId}/logs/{logPath} request.

path

required

Response format

Response parameters JSON model

The LogJobStatusResult object

The status the log analysis job.

Element	Type	Description
logAnalysisStatus	string	The status of the log analysis job. `READY`: the job has successfully finished. `FAILED`: The job has failed. See the value of the logHandlingError for the failure cause.
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.

    
{
  "logAnalysisStatus": "AGENT_PROCESSING",
  "statusChangeTimestamp": 0,
  "logHandlingError": "AGENT_VERSION_NOT_SUPPORTING_DOCKER",
  "recordsTotal": 0,
  "sortableFields": [
    "string"
  ],
  "filterableFields": [
    "string"
  ]
}

Example

In this example the request inquires the status of the log analysis job with the ID 707306f2-f3c2-4f7b-a457-cf00f7a65b1d.

The API token is passed in the Authorization header.

The response shows that the job has completed successfully—the logAnalysisStatus has the READY value—and it has analyzed 224 log entries.

Curl

curl -X GET \
  https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-54A8B0B75D36E463/logs/jobs/707306f2-f3c2-4f7b-a457-cf00f7a65b1d \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-54A8B0B75D36E463/logs/jobs/707306f2-f3c2-4f7b-a457-cf00f7a65b1d

Response content

{
  "logAnalysisStatus":"READY",
  "statusChangeTimestamp":1470226839963,
  "logHandlingError":"NONE",
  "recordsTotal":224
}

Response code

200