Snapshot:Get Snapshot

Search (SHIFT+S)

API Reference


Modified since last release

Get Snapshot

GET /block/snapshots/{id}

Get snapshot details

idthe URN of a ViPR snapshot

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

Block snapshot

Field Description Type Notes
<block_snapshot>
<parent>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</parent>      
<is_sync_active> Whether or not the snapshot is active. Boolean
<volume_native_id> ID of the snapshot resource. String
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<source_native_id> ID of the volume that is the snapshot's source. String
<replica_state> String
<read_only> Returns the read-only status of the snapshot. Boolean
<snapset_label> Label for snapshots generated at the same time, with the same consistency group or volume group. String
<provisioned_capacity_gb> This snapshot's logical capacity in Gb (Gigabytes). String
<allocated_capacity_gb> The total amount of space allocated from the snapshot's storage pool (GB) 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>

Examples

Request
GET https://192.168.0.0:4443/block/snapshots/urn:storageos:BlockSnapshot:df792922-170c-47ae-910a-e516d6f6da21: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <block_snapshot>
       <creation_time>1380600535196</creation_time>
       <id>urn:storageos:BlockSnapshot:df792922-170c-47ae-910a-e516d6f6da21:</id>
       <inactive>false</inactive>
       <link href="/block/snapshots/urn:storageos:BlockSnapshot:df792922-170c-47ae-910a-e516d6f6da21:" rel="self"/>
       <name>block_snapshot_10</name>
       <tags/>
       <consistency_group>
            <id>urn:storageos:BlockConsistencyGroup:76aacfbf-1fe9-4eee-9d84-586db5ae3a02:</id>
            <link href="/block/consistency-groups/urn:storageos:BlockConsistencyGroup:76aacfbf-1fe9-4eee-9d84-586db5ae3a02:" rel="self"/>
       </consistency_group>
       <device_label>smi00795_51D5858D_5255F460_1</device_label>
       <native_id>16309</native_id>
       <protocols>
            <protocol>FC</protocol>
       </protocols>
       <storage_controller>urn:storageos:StorageSystem:ed5035a8-5f72-43e8-b970-847b4d76e17c:</storage_controller>
       <varray>
            <id>urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3:</id>
            <link href="/vdc/varrays/urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3:" rel="self"/>
       </varray>
       <wwn>600601605D312F00D0B90225762AE311</wwn>
       <parent>
            <id>urn:storageos:Volume:16e26d2b-e291-4462-a10c-efe45003518c:</id>
            <link href="/block/volumes/urn:storageos:Volume:16e26d2b-e291-4462-a10c-efe45003518c:" rel="self"/>
       </parent>
       <project>
            <id>urn:storageos:Project:3e9226a8-33eb-419f-a7ab-4669eb93485c:</id>
            <link href="/projects/urn:storageos:Project:3e9226a8-33eb-419f-a7ab-4669eb93485c:" rel="self"/>
       </project>
       <source_native_id>00795</source_native_id>
       <is_sync_active>false</is_sync_active>
  </block_snapshot>
Notes: