Net3 API Interface for Customer Portal

<back to all web services

RecoveryUsages

The following routes are available for this service:
POST/recovery/manager/usagesRetrieve estimated Usages for Recovery based on potential schedule
RecoveryUsages Parameters:
NameParameterData TypeRequiredDescription
initialDatasetSizebodydoubleYes
projectedDatasetSizebodydoubleYes
changeRateYOYbodydoubleYes
changeRatebodydoubleYes
schedulebodyProtectionScheduleYes
retentionbodyProtectionRetention[]Yes
bandwidthUsagesbodyBandwidthUsagesYes
ProtectionSchedule Parameters:
NameParameterData TypeRequiredDescription
backupCountformintNo
backupFrequencyformBackupFrequencyNo
backupHoursJournalformintNo
BackupFrequency Enum:
Unset
Daily
Hourly
Weekly
Monthly
Yearly
Continuous
ProtectionRetention Parameters:
NameParameterData TypeRequiredDescription
retentionCountformintNo
backupFrequencyformBackupFrequencyNo
BandwidthUsages Parameters:
NameParameterData TypeRequiredDescription
BandwidthAvailableformBandwidthAvailableNo
BandwidthRequiredformBandwidthRequiredNo
DataSyncformDataSyncNo
BandwidthAvailable Parameters:
NameParameterData TypeRequiredDescription
AvailableBandwidthMBformdoubleNo
AvailableBandwidthHoursPerDayformintNo
BandwidthRequired Parameters:
NameParameterData TypeRequiredDescription
RequiredNetworkBandwidthMbpsformdoubleNo
DataSync Parameters:
NameParameterData TypeRequiredDescription
InitialSyncHoursAllowedformintNo
DataCompressionPercentExpectedformdoubleNo
NetworkEfficiencyPercentExpectedformdoubleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /recovery/manager/usages HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RecoveryUsages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <bandwidthUsages xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Recovery">
    <d2p1:BandwidthAvailable>
      <d2p1:AvailableBandwidthHoursPerDay>0</d2p1:AvailableBandwidthHoursPerDay>
      <d2p1:AvailableBandwidthMB>0</d2p1:AvailableBandwidthMB>
    </d2p1:BandwidthAvailable>
    <d2p1:BandwidthRequired>
      <d2p1:RequiredNetworkBandwidthMbps>0</d2p1:RequiredNetworkBandwidthMbps>
    </d2p1:BandwidthRequired>
    <d2p1:DataSync>
      <d2p1:DataCompressionPercentExpected>0</d2p1:DataCompressionPercentExpected>
      <d2p1:InitialSyncHoursAllowed>0</d2p1:InitialSyncHoursAllowed>
      <d2p1:NetworkEfficiencyPercentExpected>0</d2p1:NetworkEfficiencyPercentExpected>
    </d2p1:DataSync>
  </bandwidthUsages>
  <changeRate>0</changeRate>
  <changeRateYOY>0</changeRateYOY>
  <initialDatasetSize>0</initialDatasetSize>
  <projectedDatasetSize>0</projectedDatasetSize>
  <retention xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Recovery">
    <d2p1:ProtectionRetention>
      <d2p1:backupFrequency>Unset</d2p1:backupFrequency>
      <d2p1:retentionCount>0</d2p1:retentionCount>
    </d2p1:ProtectionRetention>
  </retention>
  <schedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Recovery">
    <d2p1:backupCount>0</d2p1:backupCount>
    <d2p1:backupFrequency>Unset</d2p1:backupFrequency>
    <d2p1:backupHoursJournal>0</d2p1:backupHoursJournal>
  </schedule>
</RecoveryUsages>