List Protected Databases
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/protectedDatabases
Get protected databases on a Recovery Appliance.
Request
Path Parameters
-
raTargetId(required): string
Recovery Appliance Target id.Example:
F76BBCCBD8A0D4719A8AA588375FA8BE
Query Parameters
-
limit: integer(int32)
Minimum Value:
1
Maximum Value:2000
to limit the number of rows returned. If the result set is greater follow the previous and next links in the results.Example:20
-
nameOnly: string
Retrieve only protected database names.
-
page: string
system generated page token used in the self, next and previous links.
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 : ProtectedDatabaseSummary
Type:
object
Collection of protected database objects.
Show Source
-
items(required): array
items
List of protected database objects.
Match All
Show Source
-
object
CommonProperties
Collection of summary objects.
-
object
ProtectedDatabaseSummary-allOf[1]
Nested Schema : items
Type:
array
List of protected database objects.
Show Source
-
Array of:
object ProtectedDatabase
Protected database properties.
Nested Schema : CommonProperties
Type:
object
Collection of summary objects.
Show Source
-
count(required): integer
Count of summary objects in this page.Example:
1
-
links(required): object
links
Navigation links.
-
nextPage: string
For pagination of a list of items. When paging through a list, if this value appears in the response, then there are additional items still to get. Include this value as the page parameter for the subsequent "List" request.
Nested Schema : ProtectedDatabaseSummary-allOf[1]
Type:
object
Nested Schema : ProtectedDatabase
Type:
object
Protected database properties.
Show Source
-
allowBackupDeletion: string
The setting that controls whether RMAN backups for databases that use this protection policy can be deleted.
-
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.
-
copyToCloudEnabled: string
Enabled (YES) or disabled (NO) of copy-to-cloud operation for this database.
-
copyToTapeEnabled: string
Enabled (YES) or disabled (NO) of copy-to-tape operation for this database.
-
creationTime: string
The time of task creation.
-
databaseKey: string
The primary key for this database in the Recovery Appliance metadata database.
-
databaseSize: string
Database size.
-
databaseVersion: string
Database version.
-
dbid: string
The DBID for this protected database.
-
dbUniqueName: string
Database unique name.
-
deduplicationFactor: string
The ratio of the total size of virtual full backups to the actual consumed space on the appliance for this protected database.
-
deleting: string
YES if this database is currently being deleted.
-
diskRecoveryWindowCurrent: string
The current value (in seconds) of the recovery window for this protected database.
-
diskRecoveryWindowGoal: string
Recovery window goal that the Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.
-
diskRecoveryWindowNeededSpace: string
The estimated space (in GB) that is needed to meet the recovery window goal.
-
diskReservedSpace: string
The amount of disk space(in GB) reserved for the exclusive use of this database.
-
finalChangeNumber: string
The highest SCN to which this database can be recovered when using backups and redo logs available on Recovery Appliance.
-
guaranteedBackupCopy: string
Always accept new backups even if it requires purging existing backups not yet copied to media or replicated.
-
keepSpace: string
The space used to hold KEEP backups for the database.
-
lastCompleteBackup: string
The latest time for which a backup of all datafiles in the database exists.
-
lastCopyToCloud: string
The timestamp of the last complete copy-to-cloud operation for this database.
-
lastCopyToTape: string
The timestamp of the last complete copy-to-tape operation for this database.
-
lastReplication: string
The timestamp of the last complete replication operation for this database.
-
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 be retained beyond the disk recovery window goal as space permits.
-
mediaManagerRecoveryWindowGoal: string
A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.
-
minimumRecoveryNeeded: string
The minimum interval needed to restore the protected database to the present.
-
name: string
Protected database target name or database unique name.
-
nzdlActive: string
YES if real-time redo transport is active. NO if redo has not recently been received.
-
protectionPolicyName: string
The name of the protection policy used by this database.
-
replicationEnabled: string
Enabled (YES) or disabled (NO) of replication operation for this database.
-
replicationServerList: string
The list of replication server configurations associated with this protection policy.
-
replicationSetupStatus: string
The status of the setup for the downstream replication appliance for this database.
-
restoreWindow: string
The time range used to compute the value of the estimated space that is needed to meet the recovery window goal.
-
spaceUsage: string
The amount of disk space (in GB) currently used by this protected database.
-
storageLocation: string
The name of the Recovery Appliance storage location used by this protected database.
-
targetName: string
Protected database target name.
-
targetType: string
Target type corresponding to the target specified by targetName. This can be oracle_database, rac_database or composite.
-
timeZone: string
The time zone offset of the protected database.
-
unprotectedDataWindowCurrent: string
The point beyond which recovery is impossible unless additional redo is available.
-
unprotectedDataWindowThreshold: string
The maximum amount of time in which there is potential data loss exposure for databases associated with this protected database.
-
vpcUser: string
The list of Recovery Appliance recovery catalog user for this protected database.
Match All
Show Source
-
object
ChildDetailsLink
Object details Link.
-
object
ProtectedDatabase-allOf[1]
Nested Schema : ChildDetailsLink
Type:
object
Object details Link.
Show Source
-
links(required): object
links
Navigation links.
Nested Schema : ProtectedDatabase-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
Nested Schema : links
Type:
object
Navigation links.
Show Source
-
next: object
Link
Represents a link(could be self, previous or next)
-
self: object
Link
Represents a link(could be self, previous or next)
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