Get the status of a discovery task

Use this API to get the status of a scheduled discovery task.

Note: If too many devices are scheduled to run in one task (for example, up to 50,000 network devices), this API may return a large amount of data and cause a performance issue.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Discovery/Tasks/{task}/Status

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

task*required
(path)

Input the name or ID of the scheduled discovery task added on benchmark page. Get a task ID by using the API Get all discovery tasks in a domain.

Response

Parameter

Type

Description

Example

statusCode

integer

The returned status code of executing the API.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "taskStatus": 10
}

statusDescription

string

The explanation of the status code.

taskStatus

integer

The status of the task. The status has the following values:

▪-1: Unknown

▪0: Never run

▪2: Running

▪10: Succeeded

▪11: Succeeded with warnings

▪20: Failed

▪30: Manually stopped

▪31: Automatically stopped due to timeout set by users or another system setting.