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.
-
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 TopResponse
Supported Media Types
- application/json
200 Response
Successful Operation
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).
-
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.
-
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
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
Match All
Show Source
-
object
ChildDetailsLink
Object details Link.
-
object
ProtectionPolicySummary-allOf[1]
Nested Schema : ChildDetailsLink
Type:
object
Object details Link.
Show Source
-
links(required): object
links
Navigation links.
Nested Schema : ProtectionPolicySummary-allOf[1]
Type:
object
Nested Schema : links
Type:
object
Navigation links.
Show Source
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
400 Response
Bad Request
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.
Match All
Show Source
-
object
ErrorResponse
Error response
Nested Schema : errors
Type:
array
List of errors and their details.
Show Source
-
Array of:
object ErrorResponse
Error response
Nested 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
401 Response
Unauthorized
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.
Match All
Show Source
-
object
ErrorResponse
Error response
Nested Schema : errors
Type:
array
List of errors and their details.
Show Source
-
Array of:
object ErrorResponse
Error response
Nested 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
403 Response
Forbidden
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.
Match All
Show Source
-
object
ErrorResponse
Error response
Nested Schema : errors
Type:
array
List of errors and their details.
Show Source
-
Array of:
object ErrorResponse
Error response
Nested 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
404 Response
Not Found
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.
Match All
Show Source
-
object
ErrorResponse
Error response
Nested Schema : errors
Type:
array
List of errors and their details.
Show Source
-
Array of:
object ErrorResponse
Error response
Nested 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
500 Response
Internal Server Error. Exception in execution of REST API.
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
503 Response
Service Unavailable. The server is unable to process the request.
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