Jump to

• Request
• Response

Fleet Create Protection Policies

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/actions/bulkCreateProtectionPolicies

Create one or more protection policies on one or more Recovery Appliances.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Attributes to be used for the Create/Update/Delete protection policy APIs for one or more Recovery Appliances.

Show Source

• raTargetNames(required): array raTargetNames
  List of protection policies to be created or updated on one or more Recovery Appliances.
• schedule: object ScheduleRAOperations
  Schedule with which the protected databases procedure will be scheduled. If the schedule option is not provided, the protected databases procedure runs immediately.

{
    "description":"Attributes to be used for the Create/Update/Delete protection policy APIs for one or more Recovery Appliances.",
    "type":"object",
    "required":[
        "raTargetNames"
    ],
    "properties":{
        "raTargetNames":{
            "description":"List of protection policies to be created or updated on one or more Recovery Appliances.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectionPoliciesPerTarget"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

Nested Schema : raTargetNames

Type: array

List of protection policies to be created or updated on one or more Recovery Appliances.

Show Source

• Array of: object ProtectionPoliciesPerTarget
  List of protection policies to be created on a Recovery Appliance.

{
    "description":"List of protection policies to be created or updated on one or more Recovery Appliances.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectionPoliciesPerTarget"
    }
}

Nested Schema : ScheduleRAOperations

Type: object

Schedule with which the protected databases procedure will be scheduled. If the schedule option is not provided, the protected databases procedure runs immediately.

Show Source

• daysOfTheMonth: string
  Comma-separated list of days. (Required only if frequency is monthly, or yearly. Example, repeat=1d. The valid range is 1 to 30 inclusive)
• daysOfTheWeek: string
  Comma-separated list of days. (Required only if frequency is weekly. Example, repeat=1D. The valid range is 1 to 7 inclusive)
• endTime: string
  End time for the procedure executions (optional). If it is not specified, the procedure runs indefinitely. W3C Time format (example,2021-12-10T19:16:19.666Z25:66:00)

  Example: 2021-12-10T19:16:19.666Z25:66:00
• frequency: string
  Allowed Values: [ "INTERVAL", "WEEKLY", "MONTHLY", "YEARLY" ]

  Schedule Frequency Options
• gracePeriod: string
  Grace period in minutes (optional)
• monthsOfTheYear: string
  Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive.
• repeat: string
  Frequency with which the procedure will be repeated. (Required only if frequency is set to interval)
• startTime: string
  Time when the procedure is to start executing. W3C Time format (example,2021-11-10T19:16:19.666Z25:66:00)

  Example: 2021-11-10T19:16:19.666Z25:66:00

{
    "description":"Schedule with which the protected databases procedure will be scheduled. If the schedule option is not provided, the protected databases procedure runs immediately.",
    "type":"object",
    "properties":{
        "startTime":{
            "example":"2021-11-10T19:16:19.666Z25:66:00",
            "type":"string",
            "description":"Time when the procedure is to start executing. W3C Time format (example,2021-11-10T19:16:19.666Z25:66:00)"
        },
        "endTime":{
            "example":"2021-12-10T19:16:19.666Z25:66:00",
            "type":"string",
            "description":"End time for the procedure executions (optional). If it is not specified, the procedure runs indefinitely. W3C Time format (example,2021-12-10T19:16:19.666Z25:66:00)"
        },
        "frequency":{
            "$ref":"#/components/schemas/ScheduleFrequencyOptions"
        },
        "repeat":{
            "type":"string",
            "description":"Frequency with which the procedure will be repeated. (Required only if frequency is set to interval)"
        },
        "daysOfTheWeek":{
            "type":"string",
            "description":"Comma-separated list of days. (Required only if frequency is weekly. Example, repeat=1D. The valid range is 1 to 7 inclusive)"
        },
        "daysOfTheMonth":{
            "type":"string",
            "description":"Comma-separated list of days. (Required only if frequency is monthly, or yearly. Example, repeat=1d. The valid range is 1 to 30 inclusive)"
        },
        "monthsOfTheYear":{
            "type":"string",
            "description":"Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive."
        },
        "gracePeriod":{
            "type":"string",
            "description":"Grace period in minutes (optional)"
        }
    }
}

Nested Schema : ProtectionPoliciesPerTarget

Type: object

List of protection policies to be created on a Recovery Appliance.

Show Source

• protectionPolicies(required): array protectionPolicies
  List of protection policies.
• raAdminCred: string
  Recovery Appliance administrator credentials.
• raTargetId(required): string
  Recovery Appliance target GUID on which protection policies are to be created, deleted or updated.

{
    "description":"List of protection policies to be created on a Recovery Appliance.",
    "type":"object",
    "required":[
        "raTargetId",
        "protectionPolicies"
    ],
    "properties":{
        "raTargetId":{
            "description":"Recovery Appliance target GUID on which protection policies are to be created, deleted or updated.",
            "type":"string"
        },
        "raAdminCred":{
            "description":"Recovery Appliance administrator credentials.",
            "type":"string"
        },
        "protectionPolicies":{
            "description":"List of protection policies.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectionPolicyProperties"
            }
        }
    }
}

Nested Schema : protectionPolicies

Type: array

List of protection policies.

Show Source

• Array of: object ProtectionPolicyProperties
  Protection policy properties.

{
    "description":"List of protection policies.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectionPolicyProperties"
    }
}

Nested Schema : ProtectionPolicyProperties

Type: object

Protection policy properties.

Show Source

• allowBackupDeletion: string
  Specifies whether Recovery Appliance will allow deletion of backups via the RMAN DELETE command for databases associated with this protection policy.
• archivedLogBackupCompression: string
  Allowed Values: [ "BASIC", "ADVANCED", "MEDIUM", "HIGH" ]

  The compression algorithm that will be used for archived log backups created by the Recovery Appliance
• autotuneReservedSpace: string
  Specifies whether the Recovery Appliance will automatically define and update the reserved space for databases associated with this policy (only applicable to Recovery Appliance versions 21.1 and greater).
• backupRedoFailover: string
  Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy. If enabled, backups and redo for protected databases that use this protection policy will be stored temporarily for later forwarding to a primary Recovery Appliance, after which they will be deleted from this Recovery Appliance.
• diskRecoveryWindowGoal(required): string (period)
  A recovery window goal that Recovery Appliance should attempt to meet for point-in-time recovery using disk backups. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed). Example, P1DT5H (1 day and 5 hours)
• guaranteedBackupCopy: string
  Always accept new backups, even if it requires purging existing backups not yet copied to media or replicated.
• keepCompliance: string
  Specifies whether the Recovery Appliance should keep the backups of the databases associated with this protection policy until the "keep until time" (only applicable to Recovery Appliance versions 21.1 and greater).
• maxDiskBackupRetention: string (period)
  A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be retained beyond the disk recovery window goal as space permits. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).
• mediaManagerRecoveryWindow: string (period)
  A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).
• name(required): string
  Protection policy name.
• recoveryWindowCompliance: string
  Specifies a time range that the Recovery Appliance must ensure that all databases using this protection policy can be recovered to. If this Recovery Window Compliance attribute is set, do not set allowBackupDeletion attribute (only applicable to Recovery Appliance versions 21.1 and greater). Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed). Example, P1DT5H (1 day and 5 hours)
• unprotectedDataWindowThreshold: string (period)
  The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy. If this amount of time is exceeded for a database associated with this policy, a warning will be generated. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).

{
    "description":"Protection policy properties.",
    "type":"object",
    "required":[
        "name",
        "diskRecoveryWindowGoal"
    ],
    "properties":{
        "name":{
            "description":"Protection policy name.",
            "type":"string"
        },
        "diskRecoveryWindowGoal":{
            "description":"A recovery window goal that Recovery Appliance should attempt to meet for point-in-time recovery using disk backups. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed). Example, P1DT5H (1 day and 5 hours)",
            "type":"string",
            "format":"period"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy. If this amount of time is exceeded for a database associated with this policy, a warning will be generated. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).",
            "type":"string",
            "format":"period"
        },
        "mediaManagerRecoveryWindow":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).",
            "type":"string",
            "format":"period"
        },
        "maxDiskBackupRetention":{
            "description":"A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be retained beyond the disk recovery window goal as space permits. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).",
            "type":"string",
            "format":"period"
        },
        "guaranteedBackupCopy":{
            "description":"Always accept new backups, even if it requires purging existing backups not yet copied to media or replicated.",
            "type":"string"
        },
        "backupRedoFailover":{
            "description":"Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy. If enabled, backups and redo for protected databases that use this protection policy will be stored temporarily for later forwarding to a primary Recovery Appliance, after which they will be deleted from this Recovery Appliance.",
            "type":"string"
        },
        "allowBackupDeletion":{
            "description":"Specifies whether Recovery Appliance will allow deletion of backups via the RMAN DELETE command for databases associated with this protection policy.",
            "type":"string"
        },
        "archivedLogBackupCompression":{
            "$ref":"#/components/schemas/ArchivedLogBackupCompressionEnum"
        },
        "recoveryWindowCompliance":{
            "description":"Specifies a time range that the Recovery Appliance must ensure that all databases using this protection policy can be recovered to. If this Recovery Window Compliance attribute is set, do not set allowBackupDeletion attribute (only applicable to Recovery Appliance versions 21.1 and greater). Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed). Example, P1DT5H (1 day and 5 hours)",
            "type":"string"
        },
        "keepCompliance":{
            "description":"Specifies whether the Recovery Appliance should keep the backups of the databases associated with this protection policy until the \"keep until time\" (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        },
        "autotuneReservedSpace":{
            "description":"Specifies whether the Recovery Appliance will automatically define and update the reserved space for databases associated with this policy (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        }
    }
}

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 : ProtectionPolicyDPSubmission

Type: object

Protection policy deployment procedure status.

Show Source

• code(required): integer
  HTTP status code.
• executionId(required): string
  Procedure submission id.
• instanceName(required): string
  Procedure instance name.
• procedureId(required): string
  Procedure submission id.
• submissionBy(required): string
  Name of the Enterprise Manager user who submitted the deployment procedure.
• submissionName(required): string
  Name of the submitted deployment procedure.

{
    "description":"Protection policy deployment procedure status.",
    "type":"object",
    "required":[
        "code",
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName"
    ],
    "properties":{
        "code":{
            "description":"HTTP status code.",
            "type":"integer"
        },
        "submissionName":{
            "description":"Name of the submitted deployment procedure.",
            "type":"string"
        },
        "submissionBy":{
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure.",
            "type":"string"
        },
        "executionId":{
            "description":"Procedure submission id.",
            "type":"string"
        },
        "procedureId":{
            "description":"Procedure submission id.",
            "type":"string"
        },
        "instanceName":{
            "description":"Procedure instance name.",
            "type":"string"
        }
    }
}

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"
        }
    }
}

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"
        }
    }
}

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