Volume:Get Volume

Search (SHIFT+S)

API Reference


Modified since last release

Get Volume

GET /block/volumes/{id}

Get the details of a specific volume

idthe URN of a ViPR volume to query

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

Volume details

Field Description Type Notes
<volume>
<allocated_capacity_gb> The total amount of space allocated from the volume's storage pool (GB) String
<pre_allocation_size_gb> The amount of space that was initially allocated when the volume was created (GB) String
<auto_tier_policy>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</auto_tier_policy>      
<requested_capacity_gb> This volume's total capacity in Gb (Gigabytes). String
<vpool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vpool>      
<is_composite> Specifies whether this is a composite (meta) volume. Boolean
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<provisioned_capacity_gb> This volume's logical capacity in Gb (Gigabytes). String
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<thinly_provisioned> Whether or not this volume is thinly provisioned. A thin volume initially allocates a portion of its assigned capacity when it is created and then grows as needed. Boolean
<high_availability_backing_volumes>
<high_availability_backing_volume>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</high_availability_backing_volume>      
</high_availability_backing_volumes>
<protection>    
<mirrors>    
<native_mirrors>
<native_mirror>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</native_mirror>      
</native_mirrors>
</mirrors>      
<recoverpoint>    
<targets> This volume's RecoverPoint (RP) target copies
<target>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</target>      
</targets>
<protection_set>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</protection_set>      
<protection_system>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</protection_system>      
<site_name> A label that can be used to denote the physical location of the volume String
<copy_name> The volume's RecoverPoint (RP) copy name. In this context, a production volume is a copy that is used as a source for replication. String
<replicationset_name> The name of this volume's RecoverPoint (RP) replication set. A replication set consists of a production volume and that volume's target copies. String
<personality> How this volume is used with respect to replication Valid values: SOURCE = A production volume TARGET = A copy of a production volume METADATA = A volume that stores meta-data for replication. Example: A RecoverPoint journal volume String
</recoverpoint>      
<full_copies>    
<associated_source_volume>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_source_volume>      
<volumes>
<volume>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume>      
</volumes>
<is_sync_active> Boolean
<percent_synced> Integer
<replicaState> String
<full_copy_set_name> the name to identify full copies created as a Set String
</full_copies>      
<srdf>    
<associated_source_volume>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_source_volume>      
<volumes>
<volume>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume>      
</volumes>
<personality> How this volume is used with respect to replication Valid values: SOURCE = A production volume TARGET = A copy of a production volume METADATA = A volume that stores meta-data for replication. Example = Recoverpoint journal volume String
<srdf_group_uri> URI
<srdf_copy_mode> String
</srdf>      
</protection>      
<access_state> The volume's access state String
<link_status> The volume's link status String
<has_xio_3x_backend_volumes> Specifies whether this is Xtremio 3.x volume or not. Boolean
<storage_pool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
<volume_groups>
<volume_group>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume_group>      
</volume_groups>
<supports_snapshot_sessions> Specifies whether this is volume supports Snapshot Sessions. Boolean
<system_type> Storage system's type 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
</volume>
Notes: