Get Job Run (Snapshot) summary statistics about the leaf Protection Sources Objects that match the specified filter criteria.

get

https://cluster.ip.address/irisservices/api/v1/public/reports/protectionSourcesJobsSummary

Privileges: REPORTS_VIEW, TENANT_VIEW

For example, if two Job ids are passed in, Snapshot summary statistics about
all the leaf Objects that have been protected by the two specified
Jobs are reported.
For example, if a top level registered Source id is passed in, summary
statistics about all the Snapshots backing up leaf Objects in
the specified Source are reported.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

jobIds

array of int64s

Filter by a list of Job ids. Snapshots summary statistics
for the specified Protection Jobs are reported.

jobIds

startTimeUsecs

int64

Filter by a start time. Snapshot summary statistics
for Job Runs that started after the specified time are reported.
Specify the start time as a Unix epoch Timestamp (in microseconds).

endTimeUsecs

int64

Filter by end time. Snapshot summary statistics
for Job Runs that ended before the specified time are returned.
Specify the end time as a Unix epoch Timestamp (in microseconds).

environments

array of strings

Filter by a list of environment types such as 'kVMware', 'kView', etc.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.

environments

protectionSourceIds

array of int64s

Filter by a list of leaf Protection Sources Objects (such as VMs).
Snapshot summary statistics for the listed Protection Source Objects
are reported.

protectionSourceIds

statuses

array of strings

Filter by a list of run statuses.
'kSuccess' indicates that the Job Run was successful.
'kRunning' indicates that the Job Run is currently running.
'kWarning' indicates that the Job Run was successful but warnings were
issued.
'kCancelled' indicates that the Job Run was canceled.
'kError' indicates the Job Run encountered an error and did not run to
completion.

statuses

Allowed:

outputFormat

string

Specifies the format for the output such as 'csv' or 'json'.
If not specified, the json format is returned.
If 'csv' is specified, a comma-separated list with a heading
row is returned.

registeredSourceId

int64

Specifies an id of a top level Registered Source such as
a vCenter Server. If specified, Snapshot summary statistics for all
the leaf Protection Sources (such as VMs) that are children of this
Registered Source are reported.
NOTE: If specified, filtering by other fields is not supported.

consecutiveFailures

int32

Filters out those jobs which have number of consecutive run failures less
than consecutiveFailures.

reportName

string

Specifies the custom report name the user wants to set for this report.

reportType

int32

Specifies the report type that will be used to set the right label &
subject line for the report when downloaded or emailed because same API is
used for 3 reports currently

kAvailableLocalSnapshotsReport
kFailedObjectsReport
kProtectionSummaryByObjectTypeReport

tenantIds

array of strings

TenantIds contains ids of the tenants for which objects are to be
returned.

tenantIds

allUnderHierarchy

boolean

AllUnderHierarchy specifies if objects of all the tenants under the
hierarchy of the logged in user's organization should be returned.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError