Reference for GetSnapshots

Url: tapeBackup/getSnapshots

HTTP Method: GET

Message direction	Format	Body
Request	XML	Example,Schema
Response	XML	Example,Schema

The following is an example request XML body:

No Xml request body for this method. False

The following is an example response XML body:

<?xml version="1.0" encoding="utf-16"?>
<tapeSnapshotCollection xmlns="http://apprecovery.com/management/api/2010/05">
  <tapeSnapshot>
    <backupMetadata>
      <agents>
        <!--Valid elements of type: replicatedBackupAgent-->
        <agent i:type="replicatedBackupAgent" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
          <agentType>Protected</agentType>
          <displayName>String content</displayName>
          <hostName>String content</hostName>
          <id>String content</id>
          <parentAgentId>String content</parentAgentId>
          <parentClusterId>String content</parentClusterId>
          <totalWork>18446744073709551615</totalWork>
          <slaveCoreHostName>String content</slaveCoreHostName>
          <slaveCoreId>String content</slaveCoreId>
          <slaveCoreIds>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
          </slaveCoreIds>
        </agent>
        <!--Valid elements of type: replicatedBackupAgent-->
        <agent i:type="replicatedBackupAgent" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
          <agentType>Protected</agentType>
          <displayName>String content</displayName>
          <hostName>String content</hostName>
          <id>String content</id>
          <parentAgentId>String content</parentAgentId>
          <parentClusterId>String content</parentClusterId>
          <totalWork>18446744073709551615</totalWork>
          <slaveCoreHostName>String content</slaveCoreHostName>
          <slaveCoreId>String content</slaveCoreId>
          <slaveCoreIds>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
          </slaveCoreIds>
        </agent>
      </agents>
      <backup>
        <comments>String content</comments>
        <coreDisplayName>String content</coreDisplayName>
        <coreHost>String content</coreHost>
        <coreId>1627aea5-8e0a-4371-9022-9b504344e724</coreId>
        <coreVersion>String content</coreVersion>
        <createDate>1999-05-31T11:20:00</createDate>
        <endDate>1999-05-31T11:20:00</endDate>
        <id>1627aea5-8e0a-4371-9022-9b504344e724</id>
        <startDate>1999-05-31T11:20:00</startDate>
        <totalVolumeImages>2147483647</totalVolumeImages>
        <origin>Replay</origin>
        <backupVersion>Version1</backupVersion>
      </backup>
      <dataFileIds>
        <string>String content</string>
        <string>String content</string>
      </dataFileIds>
      <isSeedDrive>true</isSeedDrive>
      <segment>
        <id>2147483647</id>
        <manifestId>1627aea5-8e0a-4371-9022-9b504344e724</manifestId>
        <previousId>2147483647</previousId>
        <dataFileId>String content</dataFileId>
        <isGlacier>true</isGlacier>
      </segment>
    </backupMetadata>
    <sessionId>1627aea5-8e0a-4371-9022-9b504344e724</sessionId>
  </tapeSnapshot>
  <tapeSnapshot>
    <backupMetadata>
      <agents>
        <!--Valid elements of type: replicatedBackupAgent-->
        <agent i:type="replicatedBackupAgent" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
          <agentType>Protected</agentType>
          <displayName>String content</displayName>
          <hostName>String content</hostName>
          <id>String content</id>
          <parentAgentId>String content</parentAgentId>
          <parentClusterId>String content</parentClusterId>
          <totalWork>18446744073709551615</totalWork>
          <slaveCoreHostName>String content</slaveCoreHostName>
          <slaveCoreId>String content</slaveCoreId>
          <slaveCoreIds>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
          </slaveCoreIds>
        </agent>
        <!--Valid elements of type: replicatedBackupAgent-->
        <agent i:type="replicatedBackupAgent" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
          <agentType>Protected</agentType>
          <displayName>String content</displayName>
          <hostName>String content</hostName>
          <id>String content</id>
          <parentAgentId>String content</parentAgentId>
          <parentClusterId>String content</parentClusterId>
          <totalWork>18446744073709551615</totalWork>
          <slaveCoreHostName>String content</slaveCoreHostName>
          <slaveCoreId>String content</slaveCoreId>
          <slaveCoreIds>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
            <slaveCoreInfo>
              <slaveCoreHostName>String content</slaveCoreHostName>
              <slaveCoreId>1627aea5-8e0a-4371-9022-9b504344e724</slaveCoreId>
            </slaveCoreInfo>
          </slaveCoreIds>
        </agent>
      </agents>
      <backup>
        <comments>String content</comments>
        <coreDisplayName>String content</coreDisplayName>
        <coreHost>String content</coreHost>
        <coreId>1627aea5-8e0a-4371-9022-9b504344e724</coreId>
        <coreVersion>String content</coreVersion>
        <createDate>1999-05-31T11:20:00</createDate>
        <endDate>1999-05-31T11:20:00</endDate>
        <id>1627aea5-8e0a-4371-9022-9b504344e724</id>
        <startDate>1999-05-31T11:20:00</startDate>
        <totalVolumeImages>2147483647</totalVolumeImages>
        <origin>Replay</origin>
        <backupVersion>Version1</backupVersion>
      </backup>
      <dataFileIds>
        <string>String content</string>
        <string>String content</string>
      </dataFileIds>
      <isSeedDrive>true</isSeedDrive>
      <segment>
        <id>2147483647</id>
        <manifestId>1627aea5-8e0a-4371-9022-9b504344e724</manifestId>
        <previousId>2147483647</previousId>
        <dataFileId>String content</dataFileId>
        <isGlacier>true</isGlacier>
      </segment>
    </backupMetadata>
    <sessionId>1627aea5-8e0a-4371-9022-9b504344e724</sessionId>
  </tapeSnapshot>
</tapeSnapshotCollection>

The following is the request XML Schema:

The request body is empty.

The following is the response XML Schema:

<?xml version="1.0" encoding="utf-16"?>
<Schemas>
  <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="anyType" nillable="true" type="xs:anyType" />
    <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
    <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
    <xs:element name="boolean" nillable="true" type="xs:boolean" />
    <xs:element name="byte" nillable="true" type="xs:byte" />
    <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
    <xs:element name="decimal" nillable="true" type="xs:decimal" />
    <xs:element name="double" nillable="true" type="xs:double" />
    <xs:element name="float" nillable="true" type="xs:float" />
    <xs:element name="int" nillable="true" type="xs:int" />
    <xs:element name="long" nillable="true" type="xs:long" />
    <xs:element name="QName" nillable="true" type="xs:QName" />
    <xs:element name="short" nillable="true" type="xs:short" />
    <xs:element name="string" nillable="true" type="xs:string" />
    <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
    <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
    <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
    <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
    <xs:element name="char" nillable="true" type="tns:char" />
    <xs:simpleType name="char">
      <xs:restriction base="xs:int" />
    </xs:simpleType>
    <xs:element name="duration" nillable="true" type="tns:duration" />
    <xs:simpleType name="duration">
      <xs:restriction base="xs:duration">
        <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
        <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
        <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="guid" nillable="true" type="tns:guid" />
    <xs:simpleType name="guid">
      <xs:restriction base="xs:string">
        <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
      </xs:restriction>
    </xs:simpleType>
    <xs:attribute name="FactoryType" type="xs:QName" />
    <xs:attribute name="Id" type="xs:ID" />
    <xs:attribute name="Ref" type="xs:IDREF" />
  </xs:schema>
  <xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" />
    <xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Backup" />
    <xs:complexType name="tapeSnapshotCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="tapeSnapshot" nillable="true" type="tns:tapeSnapshot" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="tapeSnapshotCollection" nillable="true" type="tns:tapeSnapshotCollection" />
    <xs:complexType name="tapeSnapshot">
      <xs:sequence>
        <xs:element minOccurs="0" name="backupMetadata" nillable="true" type="tns:backupManifest" />
        <xs:element minOccurs="0" name="sessionId" type="ser:guid" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="tapeSnapshot" nillable="true" type="tns:tapeSnapshot" />
    <xs:complexType name="backupManifest">
      <xs:sequence>
        <xs:element minOccurs="0" name="agents" nillable="true" type="tns:agents" />
        <xs:element minOccurs="0" name="backup" nillable="true" type="tns:backupInfo" />
        <xs:element minOccurs="0" name="dataFileIds" nillable="true" type="tns:stringCollection" />
        <xs:element minOccurs="0" name="isSeedDrive" type="xs:boolean" />
        <xs:element minOccurs="0" name="segment" nillable="true" type="tns:backupSegmentInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="backupManifest" nillable="true" type="tns:backupManifest" />
    <xs:complexType name="agents">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="agent" nillable="true" type="tns:backupAgent" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agents" nillable="true" type="tns:agents" />
    <xs:complexType name="backupAgent">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentType" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" type="q1:AgentType" />
        <xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="id" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="parentAgentId" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="parentClusterId" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="totalWork" type="xs:unsignedLong" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="backupAgent" nillable="true" type="tns:backupAgent" />
    <xs:complexType name="replicatedBackupAgent">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:backupAgent">
          <xs:sequence>
            <xs:element minOccurs="0" name="slaveCoreHostName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="slaveCoreId" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="slaveCoreIds" nillable="true" type="tns:slaveCoreInfos" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="replicatedBackupAgent" nillable="true" type="tns:replicatedBackupAgent" />
    <xs:complexType name="slaveCoreInfos">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="slaveCoreInfo" nillable="true" type="tns:slaveCoreInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="slaveCoreInfos" nillable="true" type="tns:slaveCoreInfos" />
    <xs:complexType name="slaveCoreInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="slaveCoreHostName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="slaveCoreId" type="ser:guid" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="slaveCoreInfo" nillable="true" type="tns:slaveCoreInfo" />
    <xs:complexType name="backupInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="comments" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="coreDisplayName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="coreHost" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="coreId" type="ser:guid" />
        <xs:element minOccurs="0" name="coreVersion" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="createDate" type="xs:dateTime" />
        <xs:element minOccurs="0" name="endDate" type="xs:dateTime" />
        <xs:element minOccurs="0" name="id" type="ser:guid" />
        <xs:element minOccurs="0" name="startDate" type="xs:dateTime" />
        <xs:element minOccurs="0" name="totalVolumeImages" type="xs:int" />
        <xs:element minOccurs="0" name="origin" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Backup" type="q2:BackupOrigin" />
        <xs:element minOccurs="0" name="backupVersion" xmlns:q3="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Backup" type="q3:BackupVersion" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="backupInfo" nillable="true" type="tns:backupInfo" />
    <xs:complexType name="stringCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="stringCollection" nillable="true" type="tns:stringCollection" />
    <xs:complexType name="backupSegmentInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="id" type="xs:int" />
        <xs:element minOccurs="0" name="manifestId" type="ser:guid" />
        <xs:element minOccurs="0" name="previousId" type="xs:int" />
        <xs:element minOccurs="0" name="dataFileId" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="isGlacier" type="xs:boolean" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="backupSegmentInfo" nillable="true" type="tns:backupSegmentInfo" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Agents" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="AgentType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Protected" />
        <xs:enumeration value="Replicated" />
        <xs:enumeration value="PendingFailover" />
        <xs:enumeration value="Failover" />
        <xs:enumeration value="ClusterNode" />
        <xs:enumeration value="Cluster" />
        <xs:enumeration value="RecoveryPointsOnly" />
        <xs:enumeration value="EsxServer" />
        <xs:enumeration value="EsxVirtualMachine" />
        <xs:enumeration value="Backup" />
        <xs:enumeration value="Unknown" />
        <xs:enumeration value="HyperVServer" />
        <xs:enumeration value="HyperVVirtualMachine" />
        <xs:enumeration value="HyperVCluster" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="AgentType" nillable="true" type="tns:AgentType" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Backup" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Backup" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="BackupOrigin">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Replay" />
        <xs:enumeration value="MigrationTool" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="BackupOrigin" nillable="true" type="tns:BackupOrigin" />
    <xs:simpleType name="BackupVersion">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Version1" />
        <xs:enumeration value="Version2" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="BackupVersion" nillable="true" type="tns:BackupVersion" />
  </xs:schema>
</Schemas>