Get the progress of a run.

get

https://cluster.ip.address/v2/data-protect/runs/{runId}/progress

Privileges: PROTECTION_VIEW

Get the progress of a run.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

runId

string

required

Specifies a unique run id of the Protection Run.

Query Params

objects

array of int64s

Specifies the objects whose progress will be returned. This only applies to protection group runs and will be ignored for object runs. If the objects are specified, the run progress will not be returned and only the progress of the specified objects will be returned.

objects

tenantIds

array of strings

TenantIds contains ids of the tenants for which the run is to be returned.

tenantIds

includeTenants

boolean

If true, the response will include Protection Group Runs which were created by all tenants which the current user has permission to see. If false, then only Protection Groups created by the current user will be returned. If it's not specified, it is true by default.

includeFinishedTasks

boolean

Specifies whether to return finished tasks. By default only active tasks are returned.

startTimeUsecs

int64

Specifies the time after which the progress task starts in Unix epoch Timestamp(in microseconds).

endTimeUsecs

int64

Specifies the time before which the progress task ends in Unix epoch Timestamp(in microseconds).

maxTasksNum

int32

Specifies the maximum number of tasks to return.

excludeObjectDetails

boolean

Specifies whether to return objects. By default all the task tree are returned.

includeEventLogs

boolean

Specifies whether to include event logs

maxLogLevel

int32

Specifies the number of levels till which to fetch the event logs. This is applicable only when includeEventLogs is true.

runTaskPath

string

Specifies the task path of the run or object run. This is applicable only if progress of a protection group with one or more object is required.If provided this will be used to fetch progress details directly without looking actual task path of the object. Objects field is stil expected else it changes the response format.

objectTaskPaths

array of strings

Specifies the object level task path. This relates to the objectID. If provided this will take precedence over the objects, and will be used to fetch progress details directly without looking actuall task path of the object.

objectTaskPaths

Responses

200Success

defaultError