Replace an Existing Instance's Database Using a Cloud Backup

put

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/ibkup

Replace the database in an existing Database Classic Cloud Service instance hosting a single-instance database using a backup of another database. The backup must be have been created by Oracle Database Backup Cloud Service and stored in an Oracle Storage Cloud Service container. Additionally, the database contained by the cloud backup must meet certain requirements:
  • It must be at version 11.2.0.4.0 or version 12.1.0.2.0 with the latest PSU (patch set update) applied.

  • If it is an Oracle 12c database, it must be multitenant (CDB). Database Classic Cloud Service does not support non-CDB Oracle 12c databases.

  • It must use File System or ASM as its storage method for data files.

Request

Supported Media Types
Path Parameters
  • Identity domain ID for the Database Classic Cloud Service account:
     
    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

  • Name of the Database Classic Cloud Service instance.
Header Parameters
  • Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
  • Identity domain ID for the Database Classic Cloud Service account:
     
    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

Form Parameters
  • String containing a JSON object with the following parameters.
     
    • adminPassword: string
      The password to use for the Oracle Database SYS and SYSTEM users in the newly replaced database.
       
    • ibkupBackupTAG: string
      Backup tag of the specific backup to use to replace the existing database. This parameter is valid only if ibkupOnPremise is set to no. If no value is specified, the latest backup is used.
       
    • ibkupCloudStorageContainer: string
      Name of the Oracle Storage Cloud Service container where the existing cloud backup is stored. This parameter is required if ibkupOnPremise is set to yes.
       
    • ibkupCloudStoragePassword: string
      Password of the Oracle Cloud user specified in ibkupCloudStorageUser. This parameter is required if ibkupOnPremise is set to yes.
       
    • ibkupCloudStorageUser: string
      User name of an Oracle Cloud user who has read access to the container specified in ibkupCloudStorageContainer. This parameter is required if ibkupOnPremise is set to yes.
       
    • ibkupDatabaseID: string
      Database id of the database from which the existing cloud backup was created. This parameter is required if ibkupOnPremise is set to yes.
       
    • ibkupDecryptionKey: string
      Password used to create the existing, password-encrypted cloud backup. This password is used to decrypt the backup. Specify either this parameter or the walletArchiveFile form parameter. This parameter (or the walletArchiveFile form parameter) is required if ibkupOnPremise is set to yes.
       
    • ibkupOnPremise: boolean
      Specify if the existing cloud backup being used to replace the database is from an on-premises database or another Database Classic Cloud Service instance. Valid values are true for an on-premises database and false for a Database Classic Cloud Service instance. Default value is true.
       
    • ibkupServiceID: string
      Oracle Database Classic Cloud Service instance name from which the database of new Oracle Database Classic Cloud Service instance should be created. This parameter is required if ibkupOnPremise is set to no.
  • Zip file containing the contents of the source database's Transparent Database Encryption (TDE) wallet directory.
Back to Top

Response

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Headers
  • A REST URI you can use to check the progress and completion of the replace database operation.
Back to Top