Jump to

• Request
• Response

Get Protection Policy Details

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/protectionPolicies/{protectionPolicyName}

Get attributes of a protection policy on a Recovery Appliance.

Request

Path Parameters

• protectionPolicyName(required): string
  Protection policy name.

  Example:

  SILVER

• raTargetId(required): string
  Recovery Appliance Target id.

  Example:

  F76BBCCBD8A0D4719A8AA588375FA8BE

Header Parameters

• ORCL-EM-ZDLRATARGET-AUTHORIZATION(required):
  Recovery Appliance Administrator Credentials. The format must be NAMED: (e.g. NAMED:ORSADMIN) or PREFERRED: (e.g. PREFERRED:PREF_ORSADMIN). If no value is specified, the system will use preferred credentials.

  Example:

  NAMED:ORSADMIN

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Operation

Body ()

Root Schema : ProtectionPolicySummary

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).

  Example: YES
• 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.
• diskRecoveryWindowGoal: string
  A recovery window goal that Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.
• enableSecureMode: string
  Specifies whether the backups of the databases associated with this protection policy must be encrypted. If secure mode is enabled, backups and redo must be encrypted. Non-encrypted backups or redo logs will be rejected. Example values, "YES", "NO". (only applicable to Recovery Appliance versions 23.1 and greater).

  Example: YES
• 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).

  Example: YES
• level0Refresh: string
  Specifies how often a new L0 backup of the whole database must be taken. A periodic L0 backup will reduce the number of encryption keys needed for a restore. Example value, "P365D" (365 days). (only applicable to Recovery Appliance versions 23.1 and greater).

  Example: P365D
• maxDiskBackupRetention: string
  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.
• mediaManagerRecoveryWindow: string
  A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.
• name: string
  Protection policy name.
• protectedDatbasesCount: number
  The number of protected databases using this protection policy.
• recoveryWindowCompliance: string
  Specifies a time range that the Recovery Appliance must ensure that all databases using this protection policy can be recovered to (only applicable to Recovery Appliance versions 21.1 and greater).
• unprotectedDataWindowThreshold: string
  The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy

{
    "description":"Protection policy properties.",
    "type":"object",
    "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.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy",
            "type":"string"
        },
        "mediaManagerRecoveryWindow":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "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.",
            "type":"string"
        },
        "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.",
            "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 (only applicable to Recovery Appliance versions 21.1 and greater).",
            "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",
            "example":"YES"
        },
        "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",
            "example":"YES"
        },
        "enableSecureMode":{
            "description":"Specifies whether the backups of the databases associated with this protection policy must be encrypted. If secure mode is enabled, backups and redo must be encrypted. Non-encrypted backups or redo logs will be rejected. Example values, \"YES\", \"NO\". (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"YES"
        },
        "level0Refresh":{
            "description":"Specifies how often a new L0 backup of the whole database must be taken. A periodic L0 backup will reduce the number of encryption keys needed for a restore. Example value, \"P365D\" (365 days). (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"P365D"
        },
        "protectedDatbasesCount":{
            "description":"The number of protected databases using this protection policy.",
            "type":"number"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

Match All

Protection policy properties.

Protection policy properties.

Show Source

• object ChildDetailsLink
  Object details Link.
• object ProtectionPolicySummary-allOf[1]

{
    "description":"Protection policy properties.",
    "type":"object",
    "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.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy",
            "type":"string"
        },
        "mediaManagerRecoveryWindow":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "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.",
            "type":"string"
        },
        "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.",
            "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 (only applicable to Recovery Appliance versions 21.1 and greater).",
            "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",
            "example":"YES"
        },
        "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",
            "example":"YES"
        },
        "enableSecureMode":{
            "description":"Specifies whether the backups of the databases associated with this protection policy must be encrypted. If secure mode is enabled, backups and redo must be encrypted. Non-encrypted backups or redo logs will be rejected. Example values, \"YES\", \"NO\". (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"YES"
        },
        "level0Refresh":{
            "description":"Specifies how often a new L0 backup of the whole database must be taken. A periodic L0 backup will reduce the number of encryption keys needed for a restore. Example value, \"P365D\" (365 days). (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"P365D"
        },
        "protectedDatbasesCount":{
            "description":"The number of protected databases using this protection policy.",
            "type":"number"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ChildDetailsLink

Type: object

Object details Link.

Show Source

• links(required): object links
  Navigation links.

{
    "description":"Object details Link.",
    "type":"object",
    "required":[
        "links"
    ],
    "properties":{
        "links":{
            "type":"object",
            "description":"Navigation links.",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : ProtectionPolicySummary-allOf[1]

Type: object

Nested Schema : links

Type: object

Navigation links.

Show Source

• self: object Link
  A link referencing a REST API.

{
    "type":"object",
    "description":"Navigation links.",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : Link

Type: object

A link referencing a REST API.

Show Source

• href: string
  Link URL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

• object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

• object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

• object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Common Error response.

Show Source

• object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Response sent back in the case of an error.

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top