Jump to

• Request
• Response

Update the Backup Configuration

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances/{serviceId}/backupconfig

Updates the backup configuration for an Oracle Data Hub Cloud Service instance.

To disable a scheduled full or incremental backup, set the fullBackupSchedule or incrementalBackupSchedule value, respectively, to null. For example: {"fullBackupSchedule": null}.

To disable and reenable the backup service for a service instance, use the backups parameter. When disabled, both on-demand and scheduled automated backups cannot be performed.

For complete information about scheduled automated backups, contents of backups, and where backups are stored, see About Backing Up and Restoring Databases in Administering Oracle Data Hub Cloud Service.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Data Hub Cloud Service account.
• serviceId: string
  Name of the Oracle Data Hub Cloud Service instance.

Body ()

The request body defines the details of the backup configuration update request. Specify only those attributes that you want to update.

The request body defines the details of the backup configuration update request. There are no required attributes, but you must specify the backups parameter to disable or reenable the backup service for the specified service instance.

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• backups: string
  Disable schedule backups or enable them if they had been disabled.
• defaultRetention: string
  The number of days before a backup is deleted from the Oracle Cloud Storage Service container.
• fullBackupSchedule: string
  The schedule of a full backup.
• incrementalBackupSchedule: string
  The schedule of incremental backups.

{
    "type":"object",
    "properties":{
        "defaultRetention":{
            "type":"string",
            "description":"The number of days before a backup is deleted from the Oracle Cloud Storage Service container."
        },
        "fullBackupSchedule":{
            "type":"string",
            "description":"The schedule of a full backup."
        },
        "incrementalBackupSchedule":{
            "type":"string",
            "description":"The schedule of incremental backups."
        },
        "backups":{
            "type":"string",
            "description":"Disable schedule backups or enable them if they had been disabled."
        }
    },
    "title":"Request Body"
}

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

• jobId: string
  Job ID of the operation.
• message: string
  System message that describes the operation. For example: Submitted job to create service [{serviceName}] in domain [{identityDomainId}].

{
    "properties":{
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>Submitted job to create service [{serviceName}] in domain [{identityDomainId}].</code>"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the operation."
        }
    }
}