EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Snapshot

GET /file/snapshots/{id}

Get info for file share snapshot

idthe URN of a ViPR Snapshot

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

File snapshot details

Field Description Type Notes
<file_snapshot>
<native_id> ID of the snapshot, as exported by the array. String
<parent>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</parent>      
<timestamp> Time instant when the snapshot was created. String
<mount_path> 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
</file_snapshot>

Examples

Request
GET https://192.168.0.0:4443/file/snapshots/urn:storageos:Snapshot:31246ed0-35ad-4552-804a-725af7778eca: 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"?>
  <file_snapshot>
       <creation_time>1379840116785</creation_time>
       <id>urn:storageos:Snapshot:31246ed0-35ad-4552-804a-725af7778eca:</id>
       <inactive>false</inactive>
       <link href="/file/snapshots/urn:storageos:Snapshot:31246ed0-35ad-4552-804a-725af7778eca:" rel="self"/>
       <name>F_9038233005860394</name>
       <tags/>
       <mount_path>/ProviderTenant_F90382330058_31246ed0-35ad-4552-804a-725af7778eca</mount_path>
       <native_id>7241</native_id>
       <parent>
            <id>urn:storageos:FileShare:77e91735-598b-490a-9f9a-ea94911402ac:</id>
            <link href="/file/filesystems/urn:storageos:FileShare:77e91735-598b-490a-9f9a-ea94911402ac:" rel="self"/>
       </parent>
  </file_snapshot>