Get information about the logical volumes found in a VM.

get

https://cluster.ip.address/irisservices/api/v1/public/restore/vms/volumesInformation

Privileges: RESTORE_VIEW

All required fields must be specified for this operation.
To get values for these fields, invoke the GET /public/restore/objects
operation.
A specific Job Run is defined by the jobRunId, startedTimeUsecs, and
attemptNumber fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

jobId

int64

required

Specifies the Job id for the Protection Job that is currently
associated with the object.
If the object was backed up on current Cohesity Cluster, this field
contains the id for the Job that captured this backup object.
If the object was backed up on a Primary Cluster and
replicated to this Cohesity Cluster, a new Inactive Job is created,
the object is now associated with new Inactive Job, and this field
contains the id of the new Inactive Job.

clusterId

int64

required

Specifies the Cohesity Cluster id where the Job was created.

clusterIncarnationId

int64

required

Specifies the incarnation id of the Cohesity Cluster where the Job
was created.
An incarnation id is generated when a Cohesity Cluster is initially
created.

jobRunId

int64

required

Specifies the id of the Job Run that captured the snapshot.

startedTimeUsecs

int64

required

Specifies the time when the Job Run starts capturing a snapshot.
Specified as a Unix epoch Timestamp (in microseconds).

attemptNumber

int64

Specifies the number of the attempts made by the Job Run
to capture a snapshot of the object. For example, if an snapshot
is successfully captured after three attempts, this field equals 3.

sourceId

int64

required

Specifies the id of the VM object to search for volumes.

originalJobId

int64

required

Specifies the id for the Protection Job that originally captured
the snapshots of the original object. If the object was backed up
on a Primary Cluster replicated to this Cohesity Cluster,
and a new Inactive Job is created,
this field still contains the id of the original Job and NOT the
id of the new Inactive Job.
This field is used in combination with the clusterId and
clusterIncarnationId to uniquely identify a Job.

supportedVolumesOnly

boolean

Specifies to return only supported volumes information. Unsupported
volumes are not returned if this flag is set to true.
Default is false.

computeVolumeInfo

boolean

Specifies whether to compute volume information if it is not found.
If ComputeVolumeInfo is false and volume information is not found it
skips computation of volume information and returns KNotFound.

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