Reference for StartOracleDatabaseBackup

Url: oracle/startOracleDatabaseBackupLevel0

HTTP Method: PUT

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

The following is an example request XML body:

<?xml version="1.0" encoding="utf-16"?>
<rmanBackupArguments xmlns="http://apprecovery.com/management/api/2010/05">
  <instanceCredentials>
    <credentialsAccountId>1627aea5-8e0a-4371-9022-9b504344e724</credentialsAccountId>
    <encryptPassword>true</encryptPassword>
    <password>String content</password>
    <passwordEncrypted>String content</passwordEncrypted>
    <userName>String content</userName>
    <hostName>String content</hostName>
    <instanceServiceName>String content</instanceServiceName>
    <instanceSid>String content</instanceSid>
    <port>2147483647</port>
    <tnsNetworkAlias>String content</tnsNetworkAlias>
    <useWindowsAuthentication>true</useWindowsAuthentication>
  </instanceCredentials>
  <oraSbtLibraryPath>String content</oraSbtLibraryPath>
  <backupType>Unknown</backupType>
  <backupsPath>String content</backupsPath>
  <coreIpAddress>String content</coreIpAddress>
  <port>2147483647</port>
  <tag>String content</tag>
</rmanBackupArguments>

The following is an example response XML body:

No Xml response output for this method.

The following is the request 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.datacontract.org/2004/07/Replay.Common.Contracts.Oracle.Rman" />
    <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
    <xs:complexType name="rmanBackupArguments">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:rmanArguments">
          <xs:sequence>
            <xs:element minOccurs="0" name="backupType" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Oracle.Rman" type="q1:OracleRmanBackupType" />
            <xs:element minOccurs="0" name="backupsPath" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="coreIpAddress" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="port" type="xs:int" />
            <xs:element minOccurs="0" name="tag" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="rmanBackupArguments" nillable="true" type="tns:rmanBackupArguments" />
    <xs:complexType name="rmanArguments">
      <xs:sequence>
        <xs:element minOccurs="0" name="instanceCredentials" nillable="true" type="tns:oracleInstanceCredentials" />
        <xs:element minOccurs="0" name="oraSbtLibraryPath" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="rmanArguments" nillable="true" type="tns:rmanArguments" />
    <xs:complexType name="oracleInstanceCredentials">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:baseCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="instanceServiceName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="instanceSid" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="port" type="xs:int" />
            <xs:element minOccurs="0" name="tnsNetworkAlias" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="useWindowsAuthentication" type="xs:boolean" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="oracleInstanceCredentials" nillable="true" type="tns:oracleInstanceCredentials" />
    <xs:complexType name="baseCredentials">
      <xs:sequence>
        <xs:element minOccurs="0" name="credentialsAccountId" type="ser:guid" />
        <xs:element minOccurs="0" name="encryptPassword" type="xs:boolean" />
        <xs:element minOccurs="0" name="password" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="passwordEncrypted" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="userName" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="baseCredentials" nillable="true" type="tns:baseCredentials" />
    <xs:complexType name="instanceCredentials">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:baseCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" name="instanceName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="useDefaultCredentials" type="xs:boolean" />
            <xs:element minOccurs="0" name="useWindowsAuthentication" type="xs:boolean" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="instanceCredentials" nillable="true" type="tns:instanceCredentials" />
    <xs:complexType name="virtualInstanceCredentials">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:instanceCredentials">
          <xs:sequence>
            <xs:element minOccurs="0" name="virtualServerName" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="virtualInstanceCredentials" nillable="true" type="tns:virtualInstanceCredentials" />
    <xs:complexType name="catalogRmanBackupsParameters">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:rmanArguments">
          <xs:sequence>
            <xs:element minOccurs="0" name="backupNames" nillable="true" type="tns:stringCollection" />
            <xs:element minOccurs="0" name="backupsParameters" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="catalogRmanBackupsParameters" nillable="true" type="tns:catalogRmanBackupsParameters" />
    <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="recoverOracleDatabaseParameters">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:rmanArguments">
          <xs:sequence>
            <xs:element minOccurs="0" name="backupTag" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="recoveryOptions" nillable="true" type="tns:recoveryOptions" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="recoverOracleDatabaseParameters" nillable="true" type="tns:recoverOracleDatabaseParameters" />
    <xs:complexType name="recoveryOptions">
      <xs:sequence>
        <xs:element minOccurs="0" name="logSequenceNumber" type="xs:unsignedLong" />
        <xs:element minOccurs="0" name="recoveryType" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Oracle.Rman" type="q2:OracleDatabaseRecoveryType" />
        <xs:element minOccurs="0" name="scn" type="xs:long" />
        <xs:element minOccurs="0" name="time" nillable="true" type="xs:dateTime" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="recoveryOptions" nillable="true" type="tns:recoveryOptions" />
    <xs:complexType name="restoreArchiveLogsParameters">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:rmanArguments">
          <xs:sequence>
            <xs:element minOccurs="0" name="logSequenceBounds" nillable="true" type="tns:archiveLogSequenceBounds" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="restoreArchiveLogsParameters" nillable="true" type="tns:restoreArchiveLogsParameters" />
    <xs:complexType name="archiveLogSequenceBounds">
      <xs:sequence>
        <xs:element minOccurs="0" name="upperSequenceBound" type="xs:long" />
        <xs:element minOccurs="0" name="lowerSequenceBound" type="xs:long" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="archiveLogSequenceBounds" nillable="true" type="tns:archiveLogSequenceBounds" />
    <xs:complexType name="restoreControlFileParameters">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:rmanArguments">
          <xs:sequence>
            <xs:element minOccurs="0" name="backupTag" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="backupsParameters" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="restoreControlFileParameters" nillable="true" type="tns:restoreControlFileParameters" />
    <xs:complexType name="restoreDataFilesParameters">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:rmanArguments">
          <xs:sequence>
            <xs:element minOccurs="0" name="backupTag" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="restoreDataFilesParameters" nillable="true" type="tns:restoreDataFilesParameters" />
  </xs:schema>
  <xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Oracle.Rman" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Oracle.Rman" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="OracleDatabaseRecoveryType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="NotSpecified" />
        <xs:enumeration value="UntilSequenceNumber" />
        <xs:enumeration value="UntilScn" />
        <xs:enumeration value="UntilTime" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="OracleDatabaseRecoveryType" nillable="true" type="tns:OracleDatabaseRecoveryType" />
    <xs:simpleType name="OracleRmanBackupType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Unknown" />
        <xs:enumeration value="FullBackup" />
        <xs:enumeration value="Level0" />
        <xs:enumeration value="Level1Differential" />
        <xs:enumeration value="Level1Cumulative" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="OracleRmanBackupType" nillable="true" type="tns:OracleRmanBackupType" />
  </xs:schema>
</Schemas>

The following is the response XML Schema:

The response body is empty.