Jump to

• Request
• Response

Create Archival Backup for a Protected Database

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/protectedDatabases/{protectedDatabaseUniqueName}/archivalBackups

Create an on-demand archival backup for a protected database on a Recovery Appliance.

Request

Path Parameters

• protectedDatabaseUniqueName(required): string
  Protected database unique name.
• raTargetId(required): string
  Recovery Appliance id.

Header Parameters

• ORCL-EM-ZDLRATARGET-AUTHORIZATION:
  Recovery Appliance Administrator Credential. If not specified preferred credentials will be used.

  Example:

  NAMED:NC_RA_ADMIN

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Request details for creating archival backups of one or more protected databases on a single Recovery Appliance.

Match All

Show Source

• object CreateArchivalBackupsSingleRAOnetime
  One-time request for creating archival backups of one or more protected databases on a single Recovery Appliance.

{
    "description":"Request details for creating archival backups of one or more protected databases on a single Recovery Appliance.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupsSingleRAOnetime"
        }
    ]
}

Nested Schema : CreateArchivalBackupsSingleRAOnetime

Type: object

One-time request for creating archival backups of one or more protected databases on a single Recovery Appliance.

Show Source

• archivalBackups(required): array archivalBackups
  List of archival backups to be created of one or more protected databases on a single Recovery Appliance.

{
    "description":"One-time request for creating archival backups of one or more protected databases on a single Recovery Appliance.",
    "type":"object",
    "required":[
        "archivalBackups"
    ],
    "properties":{
        "archivalBackups":{
            "description":"List of archival backups to be created of one or more protected databases on a single Recovery Appliance.",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
                    }
                ],
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/OneTimeArchivalBkupRestoreOptions"
                    }
                ],
                "discriminator":{
                    "propertyName":"restoreUsing"
                }
            }
        }
    }
}

Nested Schema : archivalBackups

Type: array

List of archival backups to be created of one or more protected databases on a single Recovery Appliance.

Show Source

• Array of: object Discriminator: restoreUsing
  Discriminator: { "propertyName":"restoreUsing" }

{
    "description":"List of archival backups to be created of one or more protected databases on a single Recovery Appliance.",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
            }
        ],
        "oneOf":[
            {
                "$ref":"#/components/schemas/OneTimeArchivalBkupRestoreOptions"
            }
        ],
        "discriminator":{
            "propertyName":"restoreUsing"
        }
    }
}

Nested Schema : Discriminator: restoreUsing

Type: object

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupRestoreOptions"
        }
    ],
    "discriminator":{
        "propertyName":"restoreUsing"
    }
}

Match All

Show Source

• object CreateArchivalBackupBasicDetails
  Basic request details of the create archival backups API.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupRestoreOptions"
        }
    ],
    "discriminator":{
        "propertyName":"restoreUsing"
    }
}

Match One Schema

Show Source

• OneTimeArchivalBkupRestoreOptions
  One-time specific details of the create archival backups API.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupRestoreOptions"
        }
    ],
    "discriminator":{
        "propertyName":"restoreUsing"
    }
}

Nested Schema : CreateArchivalBackupBasicDetails

Type: object

Basic request details of the create archival backups API.

Show Source

• attributeSetName(required): string
  Attribute set name.
• comments: string
  User provided comments.
• compressionAlgorithm: string
  Allowed Values: [ "BASIC", "LOW", "MEDIUM", "HIGH", "OFF" ]

  Recovery Appliance Compression Algorithm.
• encryptionAlgorithm: string
  Allowed Values: [ "AES128", "AES192", "AES256", "OFF" ]

  Recovery Appliance Encryption Algorithm.
• format: string
  The naming format of the output archival backup pieces. Follows the same rules as the RMAN FORMAT parameter.
• keepFor: string
  Duration value used to set the keep until date for the archival backups to be created. Value is in ISO 8601 duration format. Examples - P2D (2 days), P3Y (3 years), P3W (3 weeks)

  Example: P30D
• restoreUsing(required): string
  Allowed Values: [ "RESTORE_TIME", "RESTORE_POINT", "SCN" ]

  Create Archival backup using this restore type.

{
    "type":"object",
    "description":"Basic request details of the create archival backups API.",
    "required":[
        "attributeSetName",
        "restoreUsing"
    ],
    "properties":{
        "attributeSetName":{
            "type":"string",
            "description":"Attribute set name."
        },
        "restoreUsing":{
            "$ref":"#/components/schemas/RestoreUsingEnum"
        },
        "format":{
            "type":"string",
            "description":"The naming format of the output archival backup pieces. Follows the same rules as the RMAN FORMAT parameter."
        },
        "keepFor":{
            "type":"string",
            "description":"Duration value used to set the keep until date for the archival backups to be created. Value is in ISO 8601 duration format. Examples - P2D (2 days), P3Y (3 years), P3W (3 weeks)",
            "example":"P30D"
        },
        "compressionAlgorithm":{
            "$ref":"#/components/schemas/CompressionAlgorithmEnum"
        },
        "encryptionAlgorithm":{
            "$ref":"#/components/schemas/EncryptionAlgorithmEnum"
        },
        "comments":{
            "type":"string",
            "description":"User provided comments."
        }
    }
}

Nested Schema : OneTimeArchivalBkupRestoreOptions

One-time specific details of the create archival backups API.

Match One Schema

Show Source

• OneTimeArchivalBkupUsingRestoreTime
  Create archival backup using restore time.
• object OneTimeArchivalBkupUsingRestorePoint
  Create archival backup using restore point name.
• OneTimeArchivalBkupUsingScn
  Create archival backup using SCN.

{
    "description":"One-time specific details of the create archival backups API.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestoreTime"
        },
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestorePoint"
        },
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupUsingScn"
        }
    ]
}

Nested Schema : OneTimeArchivalBkupUsingRestoreTime

Create archival backup using restore time.

Match All

Show Source

• object CreateArchivalBkupUsingRestoreTime
  Create archival backup using restore time.
• object ArchivalRestorePointName
  Restore point name - applicable only for one-time archival backup creation.

{
    "description":"Create archival backup using restore time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBkupUsingRestoreTime"
        },
        {
            "$ref":"#/components/schemas/ArchivalRestorePointName"
        }
    ]
}

Nested Schema : OneTimeArchivalBkupUsingRestorePoint

Type: object

Create archival backup using restore point name.

Show Source

• restorePoint(required): string
  Restore point to be used for creating archival backups.

{
    "description":"Create archival backup using restore point name.",
    "required":[
        "restorePoint"
    ],
    "properties":{
        "restorePoint":{
            "type":"string",
            "description":"Restore point to be used for creating archival backups."
        }
    }
}

Nested Schema : OneTimeArchivalBkupUsingScn

Create archival backup using SCN.

Match All

Show Source

• object CreateArchivalBkupUsingScn
  Database SCN.
• object ArchivalRestorePointName
  Restore point name - applicable only for one-time archival backup creation.

{
    "description":"Create archival backup using SCN.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBkupUsingScn"
        },
        {
            "$ref":"#/components/schemas/ArchivalRestorePointName"
        }
    ]
}

Nested Schema : CreateArchivalBkupUsingRestoreTime

Type: object

Create archival backup using restore time.

Show Source

• restoreUntilTime: string
  Restore time to be used for creating archival backups. Format is YYYY-MM-DDTHH:mm:ssZ in UTC timezone. If restoreUsing value is RESTORE_TIME but restoreUntilTime is not specified or not specified then the archival backup will be created using the latest backup available on the Recovery Appliance.

  Example: 2022-09-21T06:00:00.000Z

{
    "description":"Create archival backup using restore time.",
    "properties":{
        "restoreUntilTime":{
            "type":"string",
            "description":"Restore time to be used for creating archival backups. Format is YYYY-MM-DDTHH:mm:ssZ in UTC timezone. If restoreUsing value is RESTORE_TIME but restoreUntilTime is not specified or not specified then the archival backup will be created using the latest backup available on the Recovery Appliance.",
            "example":"2022-09-21T06:00:00.000Z"
        }
    }
}

Nested Schema : ArchivalRestorePointName

Type: object

Restore point name - applicable only for one-time archival backup creation.

Show Source

• restorePoint: string
  Restore point name to be used for naming the archival backup. If not specified, archival backups will be given a default name KEEP_BACKUP_timestamp.

{
    "description":"Restore point name - applicable only for one-time archival backup creation.",
    "properties":{
        "restorePoint":{
            "type":"string",
            "description":"Restore point name to be used for naming the archival backup. If not specified, archival backups will be given a default name KEEP_BACKUP_timestamp."
        }
    }
}

Nested Schema : CreateArchivalBkupUsingScn

Type: object

Database SCN.

Show Source

• restoreUntilScn(required): string
  Database SCN to be used for creating archival backups.

{
    "description":"Database SCN.",
    "required":[
        "restoreUntilScn"
    ],
    "properties":{
        "restoreUntilScn":{
            "type":"string",
            "description":"Database SCN to be used for creating archival backups."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Headers

• Content-Location:
  Status of the deployment procedure submitted can be viewed in this location.

Body ()

Root Schema : ArchivalBackupsDpSubmissionDetails

Type: object

Archival backups deployment procedure submission details.

Show Source

• executionId: string
  Deployment procedure execution id.
• instanceId: string
  Instance Id of the submitted deployment procedure.
• instanceName: string
  Instance name of the submitted deployment procedure.
• procedureId: string
  Deployment procedure submission id.
• submissionBy: string
  Name of the Enterprise Manager user who submitted the deployment procedure.
• submissionName: string
  Name of the submitted deployment procedure.

{
    "type":"object",
    "description":"Archival backups deployment procedure submission details.",
    "properties":{
        "submissionName":{
            "type":"string",
            "description":"Name of the submitted deployment procedure."
        },
        "submissionBy":{
            "type":"string",
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure."
        },
        "executionId":{
            "type":"string",
            "description":"Deployment procedure execution id."
        },
        "procedureId":{
            "type":"string",
            "description":"Deployment procedure submission id."
        },
        "instanceId":{
            "type":"string",
            "description":"Instance Id of the submitted deployment procedure."
        },
        "instanceName":{
            "type":"string",
            "description":"Instance name of the submitted deployment procedure."
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top