API Explorer
API Explorer
Getting Started
Authentication and Authorization
Asset Management
Storage Management
Protection Policies
Inventory Source Management
Monitoring
Compliance

Monitor Activities

Activities track most of the asynchronous operations in PowerProtect Data Manager. In this tutorial, you can learn how to monitor activities and use the filter query parameter to retrieve only the activities you want. To learn more about the filter query, see this tutorial: Filter the List Result.

The activity classType can be:

  • JOB_GROUP - A group of homogeneous jobs that are initiated simultaneously.
  • JOB - An operation. For example, a VM asset protection job.
  • TASK - Actions that run within a job.

Top-level Jobs

For the top-level jobs, the parentId must be null, and the classType can be JOB_GROUP or JOB.

To query all top-level jobs, use this filter:

parentId eq null and classType in ("JOB", "JOB_GROUP")

Job State

To query all RUNNING top-level jobs:

parentId eq null and classType in ("JOB", "JOB_GROUP") and state in ("RUNNING", "QUEUED", "PENDING_CANCELLATION")

To query all COMPLETED top-level jobs:

parentId eq null and classType in ("JOB", "JOB_GROUP") and state in ("COMPLETED")

Job Status

To query all FAILED COMPLETED top-level jobs:

parentId eq null and classType in ("JOB", "JOB_GROUP") and state in ("COMPLETED") and result.status eq "FAILED"

To query all SUCCESS COMPLETED top-level jobs:

parentId eq null and classType in ("JOB", "JOB_GROUP") and state in ("COMPLETED") and result.status eq "OK"

To query all WARNING COMPLETED top-level jobs:

parentId eq null and classType in ("JOB", "JOB_GROUP") and state in ("COMPLETED") and result.status eq "OK_WITH_ERRORS"

Jobs with Date Range

To query all FAILED COMPLETED top-level jobs within one day:

parentId eq null and classType in ("JOB", "JOB_GROUP") and state in ("COMPLETED") and result.status eq "FAILED" and createTime gt "<one-day-ago>"

To query all FAILED COMPLETED top-level jobs within one week:

parentId eq null and classType in ("JOB", "JOB_GROUP") and state in ("COMPLETED") and result.status eq "FAILED" and createTime gt "<one-week-ago>"

Jobs for Protection Policies

To query all jobs for Protection Policies in which the name contains server:

protectionPolicy.name lk "%server%"

To query all jobs that belong to the Protection Policy with ID “087898d3-76c5-4f12-b398-e93b7bc8a8ca”:

protectionPolicy.id eq "087898d3-76c5-4f12-b398-e93b7bc8a8ca"

Note: Policy information is available only at the JOB_GROUP level. All the results should be classType equals to JOB_GROUP.

Jobs for Assets

To query all jobs for assets in which the name contains linux:

asset.name lk "%linux%"

To query all jobs for the asset with ID “ea6b4ea0-01cf-559e-9e75-fb33b01705f3”:

asset.id eq "ea6b4ea0-01cf-559e-9e75-fb33b01705f3"

Note: Asset information is available only at the JOB level. All the results should be classType equals to JOB.

A query from Job Group to Job and then to Task

First, query the COMPLETED PROTECT JOB_GROUP in which the Policy name contains server:

parentId eq null and classType eq "JOB_GROUP" and state eq "COMPLETED" and category eq "PROTECT" and protectionPolicy.name lk "%server%"

Here is the response:

{
  "page" : {
    "size" : 10,
    ...
  },
  "content" : [ {
    "id" : "04a66058-5bbb-4b5b-98bc-3d020523ba09",
    "name" : "Protect VM - backup-servers-in-vc-8 - PROTECTION - FULL",
    "category" : "PROTECT",
    "classType" : "JOB_GROUP",
    "state" : "COMPLETED",
    "result" : {
      "status" : "OK",
      "summaries" : [ ]
    },
    "protectionPolicy" : {
      "id" : "087898d3-76c5-4f12-b398-e93b7bc8a8ca",
      "name" : "backup-servers-in-vc-8"
    },
    ...
  }
}

In the response, you get the Job Group ID “04a66058-5bbb-4b5b-98bc-3d020523ba09”. To query all the Jobs belonging to this Job Group:

parentId eq "04a66058-5bbb-4b5b-98bc-3d020523ba09"

Here is the response:

{
  "page" : {
    "size" : 8,
    ...
  },
  "content" : [ {
    "id" : "a4762f90-e842-424c-8059-7ed68be797e9",
    "name" : "Protecting VM - qi-dummy-test-12",
    "category" : "PROTECT",
    "parentId" : "04a66058-5bbb-4b5b-98bc-3d020523ba09",
    "classType" : "JOB",
    "state" : "COMPLETED",
    "result" : {
      "status" : "OK",
      ...
    },
    "asset" : {
      "id" : "ea6b4ea0-01cf-559e-9e75-fb33b01705f3",
      "name" : "qi-dummy-test-12",
      "type" : "VIRTUALMACHINE"
    },
  },
  ...
}

In the response, you get the Job ID: “a4762f90-e842-424c-8059-7ed68be797e9”. To query all Tasks under this job:

parentId eq "a4762f90-e842-424c-8059-7ed68be797e9"

Here is the response:

{
  "page" : {
    "size" : 1,
    ...
  },
  "content" : [ {
    "id" : "4e158d68-0862-45f1-899e-3e014575ec0d",
    "name" : "Protecting VM - qi-dummy-test-12 using VM Proxy",
    "category" : "PROTECT",
    "parentId" : "a4762f90-e842-424c-8059-7ed68be797e9",
    "classType" : "TASK",
    "state" : "COMPLETED",
    "result" : {
      "status" : "OK",
      "summaries" : ...
    },
    "hasChildren" : false,
    ...
  } ]
}