Block Snapshot Session:Get Snapshot Session

Search (SHIFT+S)

API Reference


New in this release

Get Snapshot Session

GET /block/snapshot-sessions/{id}

Get the details of the BlockSnapshotSession instance with the passed id.

idThe URI of the BlockSnapshotSession instance.

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

BlockSnapshotSessionRestRep specifying the snapshot session details.

Field Description Type Notes
<block_snapshot_session>
<parent>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</parent>      
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<session_label> User specified session label. String
<replication_group_instance> Source Replication Group name for which this session is created for. String
<session_set_name> User specified name while creating sessions for Replication Groups. String
<device_label> Label assigned to the Block object. An example of a block object is a volume. String
<native_id> Native ID for this Block object. String
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<protocols>
<protocol> String 0-* Elements
</protocols>
<storage_controller> Storage controller where this Block object is located. URI
<wwn> World Wide name of this Block object. String
<consistency_group>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</consistency_group>      
<replication_group_instance> Name reference of replication group that the object belong to. String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</block_snapshot_session>
Notes: