Reference for GetCachedAgentProtectionConfiguration

Url: xfer/schedule/{agentId}/pgs

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"?>
<protectionConfig xmlns="http://apprecovery.com/management/api/2010/05">
  <pauseConfiguration>
    <pauseInterval>P428DT10H30M12.3S</pauseInterval>
    <pauseType>None</pauseType>
    <pausedTimestamp>1999-05-31T11:20:00</pausedTimestamp>
    <pausedUntilUpgrade>true</pausedUntilUpgrade>
  </pauseConfiguration>
  <pgs>
    <pgConfig>
      <currentProtectionInterval>
        <endTime>P428DT10H30M12.3S</endTime>
        <priority>2147483647</priority>
        <startTime>P428DT10H30M12.3S</startTime>
        <step>P428DT10H30M12.3S</step>
      </currentProtectionInterval>
      <id>1627aea5-8e0a-4371-9022-9b504344e724</id>
      <nextSnap>1999-05-31T11:20:00</nextSnap>
      <transferScheduleConfiguration>
        <friday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </friday>
        <monday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </monday>
        <saturday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </saturday>
        <sunday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </sunday>
        <thursday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </thursday>
        <tuesday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </tuesday>
        <wednesday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </wednesday>
      </transferScheduleConfiguration>
      <volumeNames>
        <agentVolume>
          <guidName>String content</guidName>
          <displayName>String content</displayName>
          <lastSnapshotTime>1999-05-31T11:20:00</lastSnapshotTime>
          <driverId>1627aea5-8e0a-4371-9022-9b504344e724</driverId>
          <volumeFiles>
            <protectedFile>
              <clusterRepresentation>
                <ClusterNodeProtectedFile>
                  <nodeId>1627aea5-8e0a-4371-9022-9b504344e724</nodeId>
                  <nodeProtectedFileId>
                    <driverFileId />
                  </nodeProtectedFileId>
                </ClusterNodeProtectedFile>
                <ClusterNodeProtectedFile />
              </clusterRepresentation>
              <fileIdInfo>
                <driverFileId />
              </fileIdInfo>
            </protectedFile>
          </volumeFiles>
          <sharedVhdxOwners />
        </agentVolume>
        <agentVolume>
          <guidName />
        </agentVolume>
      </volumeNames>
    </pgConfig>
    <pgConfig>
      <currentProtectionInterval />
    </pgConfig>
  </pgs>
  <recentlyExcludedVolumes />
  <storage />
</protectionConfig>

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.Transfer" />
    <xs:complexType name="protectionConfig">
      <xs:sequence>
        <xs:element minOccurs="0" name="pauseConfiguration" nillable="true" type="tns:protectionPauseConfiguration" />
        <xs:element minOccurs="0" name="pgs" nillable="true" type="tns:agentProtectionGroupConfigs" />
        <xs:element minOccurs="0" name="recentlyExcludedVolumes" nillable="true" type="tns:agentVolumes" />
        <xs:element minOccurs="0" name="storage" nillable="true" type="tns:protectionStorageConfig" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectionConfig" nillable="true" type="tns:protectionConfig" />
    <xs:complexType name="protectionPauseConfiguration">
      <xs:sequence>
        <xs:element minOccurs="0" name="pauseInterval" type="ser:duration" />
        <xs:element minOccurs="0" name="pauseType" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Transfer" type="q1:ProtectionPauseType" />
        <xs:element minOccurs="0" name="pausedTimestamp" type="xs:dateTime" />
        <xs:element minOccurs="0" name="pausedUntilUpgrade" type="xs:boolean" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectionPauseConfiguration" nillable="true" type="tns:protectionPauseConfiguration" />
    <xs:complexType name="agentProtectionGroupConfigs">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="pgConfig" nillable="true" type="tns:pgConfig" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentProtectionGroupConfigs" nillable="true" type="tns:agentProtectionGroupConfigs" />
    <xs:complexType name="pgConfig">
      <xs:sequence>
        <xs:element minOccurs="0" name="currentProtectionInterval" nillable="true" type="tns:intervalTransferScheduleItem" />
        <xs:element minOccurs="0" name="id" type="ser:guid" />
        <xs:element minOccurs="0" name="nextSnap" nillable="true" type="xs:dateTime" />
        <xs:element minOccurs="0" name="transferScheduleConfiguration" nillable="true" type="tns:transferScheduleConfiguration" />
        <xs:element minOccurs="0" name="volumeNames" nillable="true" type="tns:agentVolumes" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="pgConfig" nillable="true" type="tns:pgConfig" />
    <xs:complexType name="intervalTransferScheduleItem">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:transferScheduleItem">
          <xs:sequence>
            <xs:element minOccurs="0" name="endTime" type="ser:duration" />
            <xs:element minOccurs="0" name="priority" type="xs:int" />
            <xs:element minOccurs="0" name="startTime" type="ser:duration" />
            <xs:element minOccurs="0" name="step" type="ser:duration" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="intervalTransferScheduleItem" nillable="true" type="tns:intervalTransferScheduleItem" />
    <xs:complexType name="transferScheduleItem">
      <xs:sequence />
    </xs:complexType>
    <xs:element name="transferScheduleItem" nillable="true" type="tns:transferScheduleItem" />
    <xs:complexType name="transferScheduleConfiguration">
      <xs:sequence>
        <xs:element minOccurs="0" name="friday" nillable="true" type="tns:transfersAgenda" />
        <xs:element minOccurs="0" name="monday" nillable="true" type="tns:transfersAgenda" />
        <xs:element minOccurs="0" name="saturday" nillable="true" type="tns:transfersAgenda" />
        <xs:element minOccurs="0" name="sunday" nillable="true" type="tns:transfersAgenda" />
        <xs:element minOccurs="0" name="thursday" nillable="true" type="tns:transfersAgenda" />
        <xs:element minOccurs="0" name="tuesday" nillable="true" type="tns:transfersAgenda" />
        <xs:element minOccurs="0" name="wednesday" nillable="true" type="tns:transfersAgenda" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="transferScheduleConfiguration" nillable="true" type="tns:transferScheduleConfiguration" />
    <xs:complexType name="transfersAgenda">
      <xs:sequence>
        <xs:element minOccurs="0" name="transferScheduleItemsCollection" nillable="true" type="tns:transferScheduleItemsCollection" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="transfersAgenda" nillable="true" type="tns:transfersAgenda" />
    <xs:complexType name="transferScheduleItemsCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="transferScheduleItem" nillable="true" type="tns:transferScheduleItem" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="transferScheduleItemsCollection" nillable="true" type="tns:transferScheduleItemsCollection" />
    <xs:complexType name="agentVolumes">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="agentVolume" nillable="true" type="tns:agentVolume" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentVolumes" nillable="true" type="tns:agentVolumes" />
    <xs:complexType name="agentVolume">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:volumeName">
          <xs:sequence>
            <xs:element minOccurs="0" name="lastSnapshotTime" nillable="true" type="xs:dateTime" />
            <xs:element minOccurs="0" name="driverId" type="ser:guid" />
            <xs:element minOccurs="0" name="volumeFiles" nillable="true" type="tns:volumeFiles" />
            <xs:element minOccurs="0" name="sharedVhdxOwners" nillable="true" type="tns:guidCollection" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="agentVolume" nillable="true" type="tns:agentVolume" />
    <xs:complexType name="volumeName">
      <xs:sequence>
        <xs:element minOccurs="0" name="guidName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="volumeName" nillable="true" type="tns:volumeName" />
    <xs:complexType name="volumeFiles">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="protectedFile" nillable="true" type="tns:protectedFile" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="volumeFiles" nillable="true" type="tns:volumeFiles" />
    <xs:complexType name="protectedFile">
      <xs:sequence>
        <xs:element minOccurs="0" name="clusterRepresentation" nillable="true" type="tns:clusterNodesProtectedFileCollection" />
        <xs:element minOccurs="0" name="fileIdInfo" nillable="true" type="tns:FileIdInfo" />
        <xs:element minOccurs="0" name="fileToHostMapping" nillable="true" type="tns:hyperVServerFileIdInfoCollection" />
        <xs:element minOccurs="0" name="isSharedVirtualDisk" type="xs:boolean" />
        <xs:element minOccurs="0" name="virtualDiskPath" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectedFile" nillable="true" type="tns:protectedFile" />
    <xs:complexType name="clusterNodesProtectedFileCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="ClusterNodeProtectedFile" nillable="true" type="tns:protectedFilesClusterNodesRepresentation" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="clusterNodesProtectedFileCollection" nillable="true" type="tns:clusterNodesProtectedFileCollection" />
    <xs:complexType name="protectedFilesClusterNodesRepresentation">
      <xs:sequence>
        <xs:element minOccurs="0" name="nodeId" type="ser:guid" />
        <xs:element minOccurs="0" name="nodeProtectedFileId" nillable="true" type="tns:FileIdInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectedFilesClusterNodesRepresentation" nillable="true" type="tns:protectedFilesClusterNodesRepresentation" />
    <xs:complexType name="FileIdInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="driverFileId" type="xs:int" />
        <xs:element minOccurs="0" name="fileIdHighPart" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="fileIdLowPart" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="volumeSerialNumber" type="xs:unsignedLong" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="FileIdInfo" nillable="true" type="tns:FileIdInfo" />
    <xs:complexType name="hyperVServerFileIdInfoCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="hyperVServerFileIdInfo" nillable="true" type="tns:hyperVServerFileIdInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="hyperVServerFileIdInfoCollection" nillable="true" type="tns:hyperVServerFileIdInfoCollection" />
    <xs:complexType name="hyperVServerFileIdInfo">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentId" type="ser:guid" />
        <xs:element minOccurs="0" name="protectedFileId" nillable="true" type="tns:FileIdInfo" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="hyperVServerFileIdInfo" nillable="true" type="tns:hyperVServerFileIdInfo" />
    <xs:complexType name="guidCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="guid" type="ser:guid" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="guidCollection" nillable="true" type="tns:guidCollection" />
    <xs:complexType name="protectionStorageConfig">
      <xs:sequence>
        <xs:element minOccurs="0" name="enableSafeDataStoring" type="xs:boolean" />
        <xs:element minOccurs="0" name="encryptionKeyId" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="repositoryName" type="ser:guid" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="protectionStorageConfig" nillable="true" type="tns:protectionStorageConfig" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Transfer" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Core.Contracts.Transfer" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="ProtectionPauseType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="None" />
        <xs:enumeration value="PauseUntilResumed" />
        <xs:enumeration value="PauseUntilTime" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="ProtectionPauseType" nillable="true" type="tns:ProtectionPauseType" />
  </xs:schema>
</Schemas>