openapi: 3.2.0 info: description: Use Oracle Database Autonomous Recovery Service API to manage Protected Databases. title: Oracle Database Autonomous Recovery Service Database Recovery API version: '20210216' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/8f9c0a93bb289970624d2aa1c228e764b77b9d767acd456469cc8c844867f7fa.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Oracle Database Autonomous Recovery Service API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/8f9c0a93bb289970624d2aa1c228e764b77b9d767acd456469cc8c844867f7fa.yaml what: the harvested document for Oracle Database Autonomous Recovery Service API servers: - url: http://127.0.0.1/20210216 - url: https://127.0.0.1/20210216 tags: - name: databaseRecovery paths: /longTermBackups: get: description: 'Lists the long-term backups associated with a protected database. You can filter the results using the unique identifier (OCID) of a specific compartment, a protected database, or a long-term backup. ' operationId: ListLongTermBackups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LongTermBackupIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LongTermBackupProtectedDatabaseIdQueryParam' - $ref: '#/components/parameters/LongTermBackupLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of Long Term Backup summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LongTermBackupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all long term backups in a compartment tags: - databaseRecovery x-related-resource: '#/definitions/LongTermBackupCollection' post: description: 'Creates a long-term backup of a specified protected database. ' operationId: CreateLongTermBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The long term backup is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Relative URL of the newly created resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LongTermBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new long-term backup for the protected database with OCID tags: - databaseRecovery x-related-resource: '#/definitions/LongTermBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLongTermBackupDetails' description: Describes the parameters required to create a long term backup for a protected database. required: true /longTermBackups/{longTermBackupId}: delete: description: 'Deletes a long-term backup. You can delete a long-term backup only if the current state of the backup is ACTIVE, FAILED, or CANCELED. ' operationId: DeleteLongTermBackup parameters: - $ref: '#/components/parameters/LongTermBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Long Term Backup will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a LongTermBackup tags: - databaseRecovery x-related-resource: '#/definitions/LongTermBackup' get: description: Retrieves information regarding a long-term backup. operationId: GetLongTermBackup parameters: - $ref: '#/components/parameters/LongTermBackupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Long Term Backup with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LongTermBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Long Term Backup tags: - databaseRecovery put: description: Updates the specified long term backup. operationId: UpdateLongTermBackup parameters: - $ref: '#/components/parameters/LongTermBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The long term backup will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the long term backup identified by the id tags: - databaseRecovery x-related-resource: '#/definitions/LongTermBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLongTermBackupDetails' description: The information to be updated. required: true /longTermBackups/{longTermBackupId}/actions/cancel: post: description: Cancels a long-term backup that is being created or scheduled to be created. You must specify the unique identifier or OCID of the long-term backup that you want to cancel. You can cancel a long-term backup only if the current state of the backup resource is WAITING_FOR_BACKUP_FROM_DB, or SCHEDULED_FOR_ARCHIVAL, or ARCHIVAL_IN_PROGRESS. operationId: CancelLongTermBackup parameters: - $ref: '#/components/parameters/LongTermBackupIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Long Term Backup will be in WAITING_FOR_BACKUP_FROM_DB or SCHEDULED_FOR_ARCHIVAL or ARCHIVAL_IN_PROGRESS lifecycleState. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancels scheduled long-term backup identified by longTermBackupId tags: - databaseRecovery x-related-resource: '#/definitions/LongTermBackup' /protectedDatabases: get: description: 'Lists the protected databases based on the specified parameters. ' operationId: ListProtectedDatabases parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProtectedDatabaseLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ProtectedDatabaseIdQueryParam' - $ref: '#/components/parameters/ProtectionPolicyIdQueryParam' - $ref: '#/components/parameters/RecoveryServiceSubnetIdentifierQueryParam' - $ref: '#/components/parameters/BackupCloudLocationQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns a list of protected database summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectedDatabaseCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Protected Databases in a compartment tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabaseCollection' post: description: 'Creates a new Protected Database. ' operationId: CreateProtectedDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DryRunHeader' responses: 201: description: The Protected Database is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Relative URL of the newly created resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectedDatabase' 204: description: Dry-run for Protected Database is completed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Protected Database tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProtectedDatabaseDetails' description: Describes the parameters required to create a protected database. required: true /protectedDatabases/{protectedDatabaseId}: delete: description: 'Deletes a protected database based on the specified protected database ID. Only the user or the Oracle Database service that created the protected database is allowed to modify or delete it. ' operationId: DeleteProtectedDatabase parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/DeletionScheduleQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Protected Database will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Protected Database tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' get: description: Gets information about a specified protected database. operationId: GetProtectedDatabase parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Protected Database with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectedDatabase' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Protected Database tags: - databaseRecovery put: description: Updates the Protected Database operationId: UpdateProtectedDatabase parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Protected Database will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Protected Database identified by the id tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProtectedDatabaseDetails' description: Describes the parameters required to update a protected database. required: true /protectedDatabases/{protectedDatabaseId}/actions/cancelDeletion: post: description: Cancels the scheduled deletion of a protected database, and returns the protected database to an ACTIVE state. You can cancel the deletion only if the protected database is in the DELETE SCHEDULED state. operationId: CancelProtectedDatabaseDeletion parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Protected Database will be in ACTIVE state headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the scheduled deletion of the protected database tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' /protectedDatabases/{protectedDatabaseId}/actions/changeCompartment: post: description: Moves a protected database resource from the existing compartment to the specified compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeProtectedDatabaseCompartment parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Protected Database resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProtectedDatabaseCompartmentDetails' description: The configuration details required to move a protected database from the existing compartment to a specified compartment. required: true /protectedDatabases/{protectedDatabaseId}/actions/changeSubscription: post: description: Associates the protected database with a new cloud service environment, such as Microsoft Azure. operationId: ChangeProtectedDatabaseSubscription parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the update subscription action is being performed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Associates the protected database with a new cloud service environment, such as Microsoft Azure. tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProtectedDatabaseSubscriptionDetails' description: Associate a protected database with a different subscription. required: true /protectedDatabases/{protectedDatabaseId}/actions/getConfiguration: post: description: Downloads the network service configuration file 'tnsnames.ora' for a specified protected database. Applies to user-defined recovery systems only. operationId: FetchProtectedDatabaseConfiguration parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Retrieves the Protected Database configuration with the given id. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-checksum: description: 'Contains file checksum passed in header. ' schema: type: string opc-filename: description: 'Contains filename passed in header. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Protected Database tnssnames.ora file tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchProtectedDatabaseConfigurationDetails' description: Which configuration to get /protectedDatabases/{protectedDatabaseId}/actions/scheduleDeletion: post: description: 'Defines a preferred schedule to delete a protected database after you terminate the source database. Only the user or the Oracle Database service that created the protected database is allowed to modify or delete it. The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated. The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires. ' operationId: ScheduleProtectedDatabaseDeletion parameters: - $ref: '#/components/parameters/ProtectedDatabaseIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Protected Database is scheduled for deletion. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Schedule deletion of the protected database tags: - databaseRecovery x-related-resource: '#/definitions/ProtectedDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleProtectedDatabaseDeletionDetails' description: The details for scheduling deletion of the protected database /protectionPolicies: get: description: 'Gets a list of protection policies based on the specified parameters. ' operationId: ListProtectionPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProtectionPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ProtectionPolicyIdQueryParam' - $ref: '#/components/parameters/OwnerQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParamForPolicy' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of Protection PolicySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectionPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all ProtectionPolicies in a compartment tags: - databaseRecovery x-related-resource: '#/definitions/ProtectionPolicyCollection' post: description: 'Creates a new Protection Policy. ' operationId: CreateProtectionPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The protection policy is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Relative URL of the newly created resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectionPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Protection Policy tags: - databaseRecovery x-related-resource: '#/definitions/ProtectionPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProtectionPolicyDetails' description: Describes the parameters required to create a custom protection policy. required: true /protectionPolicies/{protectionPolicyId}: delete: description: 'Deletes a specified protection policy. You can delete custom policies only. Deleting a Oracle predefined policies will result in status code 405 Method Not Allowed. ' operationId: DeleteProtectionPolicy parameters: - $ref: '#/components/parameters/ProtectionPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Protection Policy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Protection Policy tags: - databaseRecovery x-related-resource: '#/definitions/ProtectionPolicy' get: description: Gets information about a specified protection policy. operationId: GetProtectionPolicy parameters: - $ref: '#/components/parameters/ProtectionPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Protection Policy with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectionPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Protection Policy tags: - databaseRecovery put: description: Updates the specified protection policy. operationId: UpdateProtectionPolicy parameters: - $ref: '#/components/parameters/ProtectionPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Protection Policy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Protection Policy identified by the id tags: - databaseRecovery x-related-resource: '#/definitions/ProtectionPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProtectionPolicyDetails' description: The information to be updated. required: true /protectionPolicies/{protectionPolicyId}/actions/changeCompartment: post: description: Moves a protection policy resource from the existing compartment to the specified compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeProtectionPolicyCompartment parameters: - $ref: '#/components/parameters/ProtectionPolicyIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The protection policy resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - databaseRecovery x-related-resource: '#/definitions/ProtectionPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProtectionPolicyCompartmentDetails' description: The configuration details required to move a protection policy from the existing compartment to a specified compartment. required: true /recoveryServiceSubnets: get: description: 'Returns a list of Recovery Service Subnets. ' operationId: ListRecoveryServiceSubnets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RecoveryServiceSubnetLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RecoveryServiceSubnetIdQueryParam' - $ref: '#/components/parameters/VcnIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of recovery service subnet summary objects was retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RecoveryServiceSubnetCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of recovery service subnet resources based on the specified parameters. tags: - databaseRecovery x-related-resource: '#/definitions/RecoveryServiceSubnetCollection' post: description: 'Creates a new Recovery Service Subnet. ' operationId: CreateRecoveryServiceSubnet parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The Recovery Service Subnet is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Relative URL of the newly created resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RecoveryServiceSubnet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new recovery service subnet. tags: - databaseRecovery x-related-resource: '#/definitions/RecoveryServiceSubnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRecoveryServiceSubnetDetails' description: Describes the parameters required to create a recovery service subnet. required: true /recoveryServiceSubnets/{recoveryServiceSubnetId}: delete: description: Deletes a specified recovery service subnet. operationId: DeleteRecoveryServiceSubnet parameters: - $ref: '#/components/parameters/RecoveryServiceSubnetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Recovery Service Subnet will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a specified recovery service subnet. tags: - databaseRecovery x-related-resource: '#/definitions/RecoveryServiceSubnet' get: description: Gets information about a specified recovery service subnet. operationId: GetRecoveryServiceSubnet parameters: - $ref: '#/components/parameters/RecoveryServiceSubnetIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The specified recovery service subnet resource was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RecoveryServiceSubnet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Recovery Service Subnet tags: - databaseRecovery put: description: Updates the specified recovery service subnet. operationId: UpdateRecoveryServiceSubnet parameters: - $ref: '#/components/parameters/RecoveryServiceSubnetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Recovery Service Subnet will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Recovery Service Subnet identified by the id tags: - databaseRecovery x-related-resource: '#/definitions/RecoveryServiceSubnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRecoveryServiceSubnetDetails' description: Describes the parameters required to update a recovery service subnet. required: true /recoveryServiceSubnets/{recoveryServiceSubnetId}/actions/changeCompartment: post: description: Moves a recovery service subnet resource from the existing compartment to the specified compartment. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeRecoveryServiceSubnetCompartment parameters: - $ref: '#/components/parameters/RecoveryServiceSubnetIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Recovery Service Subnet resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - databaseRecovery x-related-resource: '#/definitions/RecoveryServiceSubnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRecoveryServiceSubnetCompartmentDetails' description: The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment. required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - databaseRecovery x-related-resource: '#/definitions/WorkRequestSummaryCollection' /workRequests/{workRequestId}: get: description: Gets the status of the work request based on the specified ID operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GET Work Request Status tags: - databaseRecovery x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - databaseRecovery x-related-resource: '#/definitions/WorkRequestErrorCollection' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - databaseRecovery x-related-resource: '#/definitions/WorkRequestLogEntryCollection' components: schemas: RecoveryServiceSubnet: description: 'The details of a recovery service subnet. Recovery service subnets allows Recovery Service to access protected databases in each VCN. Each recovery service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the Oracle Cloud Database, although, it must be on a subnet that can communicate with the Oracle Cloud Database. ' properties: compartmentId: description: The compartment OCID. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user-provided name for the recovery service subnet. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The recovery service subnet OCID. type: string lifecycleDetails: description: Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state type: string lifecycleState: description: 'The current state of the recovery service subnet. ' enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' nsgIds: description: 'A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See [Network Security Groups](#/en/iaas/latest/NetworkSecurityGroup/) for more information. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true x-default-description: 'null' subnetId: description: 'Deprecated. One of the subnets associated with the Recovery Service subnet. ' type: string subnets: description: A list of OCIDs of all the subnets associated with the Recovery Service subnet. items: type: string maxItems: 10 minItems: 1 type: array uniqueItems: true systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeCreated: description: 'An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string vcnId: description: VCN Identifier. type: string required: - id - compartmentId - vcnId - subnetId type: object Error: description: Error Information. 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 required: - code - message ProtectionPolicy: description: 'The details of a protection policy.A policy defines the exact number of days to retain protected database backups created by Recovery Service. Each protected database must be associated with one protection policy. You can use Oracle-defined protection policies or create custom policies to suit your internal backup storage regulation demands. ' properties: backupRetentionPeriodInDays: description: The maximum number of days to retain backups for a protected database. Specify a period ranging from a minimum 14 days to a maximum 95 days. For example, specify the value 55 if you want to retain backups for 55 days. type: integer compartmentId: description: The OCID of the compartment that contains the protection policy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user provided name for the protection policy. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The protection policy OCID. type: string isPredefinedPolicy: description: Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies. type: boolean lifecycleDetails: description: Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state. type: string lifecycleState: description: 'The current state of the protection policy. ' enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' mustEnforceCloudLocality: default: false description: Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. type: boolean policyLockedDateTime: description: 'An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. ' type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeCreated: description: 'An RFC3339 formatted datetime string that indicates the created time for the protection policy. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string that indicates the updated time for the protection policy. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string required: - id - compartmentId - backupRetentionPeriodInDays - isPredefinedPolicy type: object WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object ProtectionPolicySummary: description: 'Recovery Service enables policy driven backup storage management. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see [Overview of the Identity Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). ' properties: backupRetentionPeriodInDays: description: The maximum number of days to retain backups for a protected database. type: integer compartmentId: description: The OCID of the compartment that contains the protection policy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user provided name for the protection policy. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The protection policy OCID. type: string isPredefinedPolicy: description: Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies. type: boolean lifecycleDetails: description: Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state. type: string lifecycleState: description: The current state of the Protection Policy. enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' mustEnforceCloudLocality: default: false description: Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. type: boolean policyLockedDateTime: description: 'An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. ' type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeCreated: description: The time the Protection Policy was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Protection Policy was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - compartmentId - backupRetentionPeriodInDays - isPredefinedPolicy type: object FetchProtectedDatabaseConfigurationDetails: description: Provides which configuration details to get. properties: configurationType: description: Currently has four config options ALL, TNSNAMES, HOSTS and CABUNDLE. All will return a zipped folder containing the contents of both tnsnames and the certificateChainPem. enum: - CABUNDLE - TNSNAMES - HOSTS - RCVCONF - ALL type: string type: object RecoveryServiceSubnetInput: description: Parameters to retrieve information about a specific recovery service subnet. properties: recoveryServiceSubnetId: description: The recovery service subnet OCID. maxLength: 255 minLength: 1 type: string required: - recoveryServiceSubnetId type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. ' type: string id: description: The ID of the work request. type: string operationType: description: Type of the work request enum: - CREATE_PROTECTED_DATABASE - UPDATE_PROTECTED_DATABASE - DELETE_PROTECTED_DATABASE - MOVE_PROTECTED_DATABASE - CREATE_PROTECTION_POLICY - UPDATE_PROTECTION_POLICY - DELETE_PROTECTION_POLICY - MOVE_PROTECTION_POLICY - CREATE_RECOVERY_SERVICE_SUBNET - UPDATE_RECOVERY_SERVICE_SUBNET - DELETE_RECOVERY_SERVICE_SUBNET - MOVE_RECOVERY_SERVICE_SUBNET - CREATE_LONG_TERM_BACKUP - DELETE_LONG_TERM_BACKUP - UPDATE_LONG_TERM_BACKUP - CANCEL_LONG_TERM_BACKUP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: The completed percentage of the operation tracked by the work request. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the current work request. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was accepted, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. The precision for this time object is in milliseconds. ' format: date-time type: string timeFinished: description: 'The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. The precision for this time object is in milliseconds. ' format: date-time type: string timeStarted: description: 'The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. The precision for this time object is in milliseconds. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted ChangeRecoveryServiceSubnetCompartmentDetails: description: The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the Recovery Service subnet should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object RecoveryServiceSubnetCollection: description: Results of a recovery service subnet search operation. The results contain recovery service subnet summary and metadata information. properties: items: description: List of recovery service subnet resources. items: $ref: '#/components/schemas/RecoveryServiceSubnetSummary' type: array required: - items type: object ChangeProtectionPolicyCompartmentDetails: description: The configuration details required to move a protection policy from the existing compartment to a specified compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the Protection Policy should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ProtectedDatabaseCollection: description: Results of a protected database search operation. The results contain protected database summary and metadata information. properties: items: description: List of protected databases. items: $ref: '#/components/schemas/ProtectedDatabaseSummary' type: array required: - items type: object ChangeProtectedDatabaseCompartmentDetails: description: The configuration details required to move a protected database from the existing compartment to a specified compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the protected database should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object LongTermBackupCollection: description: Results of a long term backup search. Contains both long term backup Summary items and other information, such as metadata. properties: items: description: List of LongTermBackups. items: $ref: '#/components/schemas/LongTermBackupSummary' type: array required: - items type: object ProtectedDatabase: description: 'A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery ' properties: backupCloudLocation: description: Indicates the cloud service environment where the protected database is provisioned. For example, Oracle Cloud or Microsoft Azure. enum: - AZURE - OCI - GCP - AWS type: string x-obmcs-top-level-enum: '#/definitions/BackupCloudLocation' changeRate: description: The percentage of data changes that exist in the database between successive incremental backups. format: double type: number compartmentId: description: The OCID of the compartment that contains the protected database. type: string compressionRatio: description: The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size. format: double type: number databaseId: description: The OCID of the protected database. type: string databaseSize: description: The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. enum: - XS - S - M - L - XL - XXL - AUTO type: string x-obmcs-top-level-enum: '#/definitions/DatabaseSizes' databaseSizeInGBs: description: The size of the database in GBs, in gigabytes. type: integer dbUniqueName: description: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: The protected database name. You can change the displayName. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object health: description: "Indicates the protection status of the database.\n\nA 'PROTECTED' status indicates that Recovery Service can ensure database recovery to any point in time within the entire recovery window. The potential data loss exposure since the last backup is:\n - Less than 10 seconds, if Real-time data protection is enabled\n - Less than 70 minutes if Real-time data protection is disabled\n\nA 'WARNING' status indicates that Recovery Service can ensure database recovery within the current recovery window - 1 day. The potential data loss exposure since the last backup is:\n - Greater than 10 seconds, if Real-time data protection is enabled\n - Greater than 60 minutes, if if Real-time data protection is disabled\n\nAn 'ALERT' status indicates that Recovery Service cannot recover the database within the current recovery window. \n" enum: - PROTECTED - WARNING - ALERT type: string x-obmcs-top-level-enum: '#/definitions/Health' healthDetails: description: A message describing the current health of the protected database. type: string id: description: The OCID of the protected database. type: string isReadOnlyResource: description: 'Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database. ' type: boolean isRedoLogsShipped: description: 'The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side. ' type: boolean lifecycleDetails: description: Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state. type: string lifecycleState: description: The current state of the Protected Database. enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' metrics: $ref: '#/components/schemas/Metrics' policyLockedDateTime: description: "An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.\n\nThe retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. \nRecovery Service enforces a 14-day delay before the retention lock set for a policy can take effect.\n" type: string protectionPolicyId: description: The OCID of the protection policy associated with the protected database. type: string recoveryServiceSubnets: description: List of recovery service subnet resources associated with the protected database. items: $ref: '#/components/schemas/RecoveryServiceSubnetDetails' type: array subscriptionId: description: The OCID of the cloud service subscription to which the protected database is linked. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeCreated: description: 'An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string vpcUserName: description: The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service. type: string required: - id - compartmentId - dbUniqueName - vpcUserName - databaseSize - protectionPolicyId - recoveryServiceSubnets type: object UpdateLongTermBackupDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user provided name for the long term backup. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object retentionPeriod: description: 'The maximum period to retain the long-term backup. Specify the retention period type and the duration for the long-term backup. If you have chosen the retention period type as ''DAYS'', then specify a duration ranging from 90 days to 3650 days. If you have chosen the retention period type as ''YEARS'', then specify a duration ranging from 1 year to 10 years. ' items: $ref: '#/components/schemas/RetentionPeriodValue' maxItems: 1 type: array type: object RetentionPeriodValue: description: 'Specifies the retention period for the long-term backup. ' properties: retentionCount: description: Specifies the duration (in days or years) to retain the long-term backup. If you have chosen the retentionPeriodType as 'DAYS', then specify a duration ranging from 90 days to 3650 days. If you have chosen the retentionPeriodType as 'YEARS', then specify a duration ranging from 1 year to 10 years. type: integer retentionPeriodType: description: Specifies the retention period type for the long-term backup. Allowed values are DAYS or YEARS. enum: - YEAR - DAY type: string required: - retentionPeriodType - retentionCount type: object UpdateProtectedDatabaseDetails: description: Describes the parameters required to update a protected database. properties: databaseSize: description: The size of the database is allowed to be decreased. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. enum: - XS - S - M - L - XL - XXL - AUTO type: string x-obmcs-top-level-enum: '#/definitions/DatabaseSizes' databaseSizeInGBs: description: The size of the database, in gigabytes. minimum: 1 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: The protected database name. You can change the displayName. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isRedoLogsShipped: description: 'The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side. ' type: boolean password: description: 'Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username "admin", regardless of casing. Password must not be same as current passsword. ' maxLength: 30 minLength: 15 type: string protectionPolicyId: description: The OCID of the protection policy associated with the protected database. maxLength: 255 minLength: 1 type: string recoveryServiceSubnets: description: List of recovery service subnet resources associated with the protected database. items: $ref: '#/components/schemas/RecoveryServiceSubnetInput' maxItems: 1 type: array type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string format: date-time type: string required: - message - timestamp WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_PROTECTED_DATABASE - UPDATE_PROTECTED_DATABASE - DELETE_PROTECTED_DATABASE - MOVE_PROTECTED_DATABASE - CREATE_PROTECTION_POLICY - UPDATE_PROTECTION_POLICY - DELETE_PROTECTION_POLICY - MOVE_PROTECTION_POLICY - CREATE_RECOVERY_SERVICE_SUBNET - UPDATE_RECOVERY_SERVICE_SUBNET - DELETE_RECOVERY_SERVICE_SUBNET - MOVE_RECOVERY_SERVICE_SUBNET - CREATE_LONG_TERM_BACKUP - DELETE_LONG_TERM_BACKUP - UPDATE_LONG_TERM_BACKUP - CANCEL_LONG_TERM_BACKUP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted CreateProtectionPolicyDetails: description: Describes the parameters required to create a custom protection policy. properties: backupRetentionPeriodInDays: description: The maximum number of days to retain backups for a protected database. maximum: 95 type: integer compartmentId: description: Compartment Identifier maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object mustEnforceCloudLocality: default: false description: 'Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. This parameter is applicable if your Oracle Database runs in a different cloud service environment, such as Microsoft Azure. If you set the mustEnforceCloudLocality parameter to TRUE, then Recovery Service stores the database backups locally in the same cloud service environment where the database resides. For example, if your Oracle Database is provisioned on Microsoft Azure, then Recovery Service stores the database backups in Azure. Note: You cannot change the mustEnforceCloudLocality setting for a protection policy after you create it. ' type: boolean policyLockedDateTime: description: 'An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. * The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. * Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date. * For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to ''2023-08-15T21:00:00.600Z'' (Aug 15, 2023, 9:00 pm), or greater. * During the 14-day delay period, you can either increase or decrease the retention period in the policy. * However, you are only allowed to increase the retention period on or after the retention lock date. * You cannot change the value of policyLockedDateTime if the retention lock is already in effect. ' maxLength: 32 minLength: 0 type: string x-default-description: 'null' required: - displayName - backupRetentionPeriodInDays - compartmentId type: object CreateRecoveryServiceSubnetDetails: description: Describes the parameters required to create a Recovery Service Subnet. properties: compartmentId: description: The compartment OCID. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object nsgIds: description: 'A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See [Network Security Groups](#/en/iaas/latest/NetworkSecurityGroup/) for more information. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true subnetId: description: 'Deprecated. One of the subnets associated with the Recovery Service subnet. ' maxLength: 255 minLength: 1 type: string subnets: description: A list of OCIDs of the subnets associated with the Recovery Service subnet. items: maxLength: 255 minLength: 1 type: string maxItems: 10 minItems: 1 type: array uniqueItems: true vcnId: description: The OCID of the virtual cloud network (VCN) that contains the recovery service subnet. You can create a single recovery service subnet per VCN. maxLength: 255 minLength: 1 type: string required: - displayName - vcnId - compartmentId type: object MetricsSummary: description: Backup performance and storage utilization metrics for the Protected Database. properties: backupSpaceEstimateInGBs: description: The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. format: float type: number backupSpaceUsedInGBs: description: Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. format: float type: number currentRetentionPeriodInSeconds: description: Number of seconds backups are currently retained for this database. format: float type: number dbSizeInGBs: description: The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. format: float type: number isRedoLogsEnabled: description: 'The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. ' type: boolean minimumRecoveryNeededInDays: description: Number of days of redo/archive to be applied to recover database. format: float type: number retentionPeriodInDays: description: The maximum number of days to retain backups for a protected database. format: float maximum: 90 minimum: 14 type: number unprotectedWindowInSeconds: description: "This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. \nThis is the time we received the last backup or last redo-log shipped.\n" format: float type: number type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier CreateProtectedDatabaseDetails: description: Describes the parameters required to create a protected database. properties: changeRate: description: The percentage of data changes that exist in the database between successive incremental backups. format: double minimum: 0 type: number compartmentId: description: The OCID of the compartment that contains the protected database. maxLength: 255 minLength: 1 type: string compressionRatio: description: The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size. format: double minimum: 1 type: number databaseId: description: The OCID of the protected database. maxLength: 255 minLength: 1 type: string databaseSize: description: The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. enum: - XS - S - M - L - XL - XXL - AUTO type: string x-obmcs-top-level-enum: '#/definitions/DatabaseSizes' databaseSizeInGBs: description: The size of the database, in gigabytes. minimum: 1 type: integer dbUniqueName: description: The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name. maxLength: 32 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: The protected database name. You can change the displayName. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isRedoLogsShipped: description: 'The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. ' type: boolean password: description: 'Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username "admin", regardless of casing. ' maxLength: 30 minLength: 15 type: string protectionPolicyId: description: The OCID of the protection policy associated with the protected database. maxLength: 255 minLength: 1 type: string recoveryServiceSubnets: description: List of recovery service subnet resources associated with the protected database. items: $ref: '#/components/schemas/RecoveryServiceSubnetInput' maxItems: 1 type: array subscriptionId: description: "The OCID of the cloud service subscription to which you want to link the protected database. \nFor example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.\n" maxLength: 255 minLength: 1 type: string required: - displayName - dbUniqueName - password - protectionPolicyId - recoveryServiceSubnets - compartmentId type: object CreateLongTermBackupDetails: description: Describes the parameters required to create an on demand long term backup. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user provided name for the long term backup. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object protectedDatabaseId: description: The OCID of the protected database for which you want to create the long-term backup. maxLength: 255 minLength: 1 type: string retentionPeriod: description: The maximum period to retain the long-term backup. Specify the retention period type and the duration for the long-term backup. If you have chosen the retention period type as 'DAYS', then specify a duration ranging from 90 days to 3650 days. If you have chosen the retention period type as 'YEARS', then specify a duration ranging from 1 year to 10 years. items: $ref: '#/components/schemas/RetentionPeriodValue' maxItems: 1 type: array retentionPointInTime: description: An RFC3339 formatted datetime string that indicates the desired target point in time in the database at which you want to create the long-term backup. For example, if you want the long-term backup to include all the changes until May 22 at 9:10 PM, then specify the value as, '2020-05-22T21:10:00.000Z'. If you want to specify the target point as an SCN value instead of the target time, then use the databaseSCN parameter. format: date-time maxLength: 255 minLength: 1 type: string retentionScn: description: The desired target point (SCN) at which you want to create the long-term backup of the database.For example, specify the value as 1000 if you want to create the long-term backup until SCN 1000. If you want to specify the target point as a time expression instead of the SCN value, then use the longTermRetentionPointInTime parameter. maxLength: 255 minLength: 1 type: integer required: - protectedDatabaseId - retentionPeriod type: object UpdateProtectionPolicyDetails: description: The information to be updated. properties: backupRetentionPeriodInDays: description: The maximum number of days to retain backups for a protected database. maximum: 95 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object policyLockedDateTime: description: 'An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. * The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. * Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date. * For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to ''2023-08-15T21:00:00.600Z'' (Aug 15, 2023, 9:00 pm), or greater. * During the 14-day delay period, you can either increase or decrease the retention period in the policy. * However, you are only allowed to increase the retention period on or after the retention lock date. * You cannot change the value of policyLockedDateTime if the retention lock is already in effect. ' maxLength: 32 minLength: 0 type: string type: object ChangeProtectedDatabaseSubscriptionDetails: description: 'Subscription details of the new cloud service environment, such as Microsoft Azure, where the protected database will be provisioned. ' properties: isDefault: description: 'Indicates whether it is a Universal Credit Model (UCM) subscription. ' type: boolean subscriptionId: description: The OCID of the new cloud service subscription to which you want to link the protected database. maxLength: 255 minLength: 1 type: string type: object Metrics: description: Backup performance and storage utilization metrics for the protected database. properties: backupSpaceEstimateInGBs: description: The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. format: float type: number backupSpaceUsedInGBs: description: Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. format: float type: number currentRetentionPeriodInSeconds: description: Number of seconds backups are currently retained for this database. format: float type: number dbSizeInGBs: description: The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. format: float type: number isRedoLogsEnabled: description: 'The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. ' type: boolean minimumRecoveryNeededInDays: description: Number of days of redo/archive to be applied to recover database. format: float type: number retentionPeriodInDays: description: The maximum number of days to retain backups for a protected database. format: float maximum: 90 minimum: 14 type: number unprotectedWindowInSeconds: description: "This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. \nThis is the time we received the last backup or last redo-log shipped.\n" format: float type: number type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp UpdateRecoveryServiceSubnetDetails: description: Describes the parameters required to update a recovery service subnet. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object nsgIds: description: 'A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See [Network Security Groups](#/en/iaas/latest/NetworkSecurityGroup/) for more information. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true subnets: description: A list of OCIDs of the subnets associated with the recovery service subnet. items: maxLength: 255 minLength: 1 type: string maxItems: 10 minItems: 1 type: array uniqueItems: true type: object RecoveryServiceSubnetDetails: description: Details of the Recovery Service Subnet. properties: lifecycleState: description: The current state of the Recovery Service Subnet. enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' recoveryServiceSubnetId: description: Recovery Service Subnet Identifier. type: string required: - recoveryServiceSubnetId type: object RecoveryServiceSubnetSummary: description: 'Each Recovery Service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the Oracle Cloud Database, although, it must be on a subnet that can communicate with the Oracle Cloud Database. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see [Overview of the Identity Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). ' properties: compartmentId: description: The compartment OCID. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: A user-provided name for the recovery service subnet. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The recovery service subnet OCID. type: string lifecycleDetails: description: Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state type: string lifecycleState: description: 'The current state of the recovery service subnet. ' enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' nsgIds: description: 'A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See [Network Security Groups](#/en/iaas/latest/NetworkSecurityGroup/) for more information. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true subnetId: description: 'Deprecated. One of the subnets associated with the Recovery Service subnet. ' type: string subnets: description: A list of OCIDs of all the subnets associated with the Recovery Service subnet. items: type: string maxItems: 10 minItems: 1 type: array uniqueItems: true systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeCreated: description: 'An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string vcnId: description: The OCID of the virtual cloud network (VCN) associated with the recovery service subnet. You can create a single recovery service subnet per VCN. type: string required: - id - compartmentId - vcnId - subnetId type: object ScheduleProtectedDatabaseDeletionDetails: description: The details for scheduling deletion of the protected database properties: deletionSchedule: description: "Defines a preferred schedule to delete a protected database after you terminate the source database. \n* The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated. \n* The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.\n" enum: - DELETE_AFTER_RETENTION_PERIOD - DELETE_AFTER_72_HOURS type: string x-obmcs-top-level-enum: '#/definitions/DeletionSchedule' type: object ProtectionPolicyCollection: description: Results of a Protection Policy search. Contains both Protection Policy Summary items and other information, such as metadata. properties: items: description: List of ProtectionPolicies. items: $ref: '#/components/schemas/ProtectionPolicySummary' type: array required: - items type: object WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object LongTermBackup: description: 'The details of a Long Term Backup. ' properties: compartmentId: description: The OCID of the compartment containing the long-term backup. type: string databaseIdentifier: description: The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. type: string databaseSizeInGBs: description: The size of the database, in gigabytes. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: The user-provided name for the long-term backup. You can change the displayName. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the long-term backup. type: string lifecycleDetails: description: A detailed message about the current lifecycle state of the long-term backup. For example, it can be used to provide actionable information for a resource in a Failed state. type: string lifecycleState: description: 'The current state of the long term backup. ' enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - CANCELING - CANCELED type: string lifecycleSubstate: description: 'More details on the state of the backup when it is in Creating lifecycleState. ' enum: - WAITING_FOR_BACKUP_FROM_DB - SCHEDULED_FOR_ARCHIVAL - ARCHIVAL_IN_PROGRESS type: string protectedDatabaseId: description: The OCID of the protected database associated with the long-term backup. type: string retentionPeriod: description: The maximum number of DAYS or YEARS to store the long-term backup. You can retain a long-term backup for a period ranging from 90-3650 days or 1-10 years. items: $ref: '#/components/schemas/RetentionPeriodValue' maxItems: 1 type: array retentionPointInTime: description: An RFC3339 formatted datetime string that indicates the target point in time until which the long-term backup is consistent. For example, '2020-05-22T21:10:29.600Z'. format: date-time type: string retentionScn: description: The unique system change number (SCN) or the target point in the database until which the long-term backup is consistent. type: integer retentionUntilDateTime: description: Indicates that Recovery Service must retain the backup for the specified long-term retention period. format: date-time type: string rmanTag: description: Recovery Manager (RMAN) assigned unique identifier for the long-term backup. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeBackupCompleted: description: An RFC3339 formatted datetime string that indicates the time when the long-term backup completed. For example, '2020-05-22T21:10:29.600Z'. format: date-time type: string timeBackupInitiated: description: An RFC3339 formatted datetime string that indicates the time when the long-term backup was created. For example, '2020-05-22T21:10:29.600Z'. format: date-time type: string timeCreated: description: 'An RFC3339 formatted datetime string that indicates the time when the long-term backup was created. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string that indicates the time when the long term backup was last updated. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string required: - id - compartmentId - protectedDatabaseId - retentionPeriod - retentionUntilDateTime - lifecycleState type: object ProtectedDatabaseSummary: description: 'A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see [Overview of the Identity Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). ' properties: backupCloudLocation: description: Indicates the cloud service environment where the protected database is provisioned. For example, Oracle Cloud or Microsoft Azure. enum: - AZURE - OCI - GCP - AWS type: string x-obmcs-top-level-enum: '#/definitions/BackupCloudLocation' compartmentId: description: The OCID of the compartment that contains the protected database. type: string databaseId: description: The OCID of the protected database. type: string databaseSize: description: The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. enum: - XS - S - M - L - XL - XXL - AUTO type: string x-obmcs-top-level-enum: '#/definitions/DatabaseSizes' dbUniqueName: description: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: The protected database name. You can change the displayName. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object health: description: The health of the Protected Database. enum: - PROTECTED - WARNING - ALERT type: string x-obmcs-top-level-enum: '#/definitions/Health' healthDetails: description: A message describing the current health of the protected database. type: string id: description: The OCID of the protected database. type: string isReadOnlyResource: description: 'Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database. ' type: boolean lifecycleDetails: description: Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state. type: string lifecycleState: description: The current state of the Protected Database. enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' metrics: $ref: '#/components/schemas/MetricsSummary' policyLockedDateTime: description: "An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.\n\nThe retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. \nRecovery Service enforces a 14-day delay before the retention lock set for a policy can take effect.\n" type: string protectionPolicyId: description: The OCID of the protection policy associated with the protected database. type: string recoveryServiceSubnets: description: List of recovery service subnet resources associated with the protected database. items: $ref: '#/components/schemas/RecoveryServiceSubnetDetails' type: array subscriptionId: description: The OCID of the cloud service subscription to which the protected database is linked. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeCreated: description: 'An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: ''2020-05-22T21:10:29.600Z'' ' format: date-time type: string vpcUserName: description: The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service. type: string required: - id - compartmentId - dbUniqueName - vpcUserName - databaseSize - protectionPolicyId type: object LongTermBackupSummary: description: 'Generate an on-demand backup and retain it long-term as per the LTR backup retention period specified. ' properties: compartmentId: description: The OCID of the compartment that contains the long term backup. type: string databaseIdentifier: description: The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. type: string databaseSizeInGBs: description: Database size type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object displayName: description: The long term backup name. You can change the displayName. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The Long Term Backup OCID. type: string lifecycleDetails: description: Detailed description about the current lifecycle state of the long term backup. For example, it can be used to provide actionable information for a resource in a Failed state. type: string lifecycleState: description: 'The current state of the long term backup. ' type: string x-obmcs-enumref: '#/definitions/LongTermBackup/lifecycleState' lifecycleSubstate: description: 'More details on the state of the backup when it is in Creating lifecycleState. ' type: string x-obmcs-enumref: '#/definitions/LongTermBackup/lifecycleSubstate' protectedDatabaseId: description: The protected database ocid. type: string retentionPeriod: description: Retain the long-term backup as per the backup retention period specified items: $ref: '#/components/schemas/RetentionPeriodValue' maxItems: 1 type: array retentionPointInTime: description: An RFC3339 formatted datetime string that indicates the time for a long term backup to be initiated. format: date-time type: string retentionScn: description: System Change Number (SCN) to which backup is consistent. type: integer retentionUntilDateTime: description: An RFC3339 formatted datetime string that indicates the time after which the long term backup will be deleted. For example '2020-05-22T21:10:29.600Z'. This timestamp has to be 95 days-10 years from the current timestamp format: date-time type: string rmanTag: description: Recovery Manager (RMAN) assigned unique identifier for the long-term backup. maxLength: 255 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object timeBackupCompleted: description: An RFC3339 formatted datetime string that indicates the time when the backup was actually completed. For example '2020-05-22T21:10:29.600Z' format: date-time type: string timeBackupInitiated: description: An RFC3339 formatted datetime string that indicates the time when the backup was actually taken. For example '2020-05-22T21:10:29.600Z' format: date-time type: string timeCreated: description: 'An RFC3339 formatted datetime string that indicates the created time for the long term backup. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string that indicates the updated time for the long term backup. For example: ''2020-05-22T21:10:29.600Z''. ' format: date-time type: string required: - id - compartmentId - protectedDatabaseId - retentionPeriod - retentionUntilDateTime - lifecycleState type: object WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string ProtectionPolicyIdQueryParam: description: The protection policy OCID. in: query name: protectionPolicyId x-default-description: 'null' schema: type: string WorkRequestLogSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated RecoveryServiceSubnetIdQueryParam: description: The recovery service subnet OCID. in: query name: id x-default-description: 'null' schema: type: string SortOrderQueryParam: description: "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC ProtectionPolicyLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED RequestIdHeader: description: Unique identifier for the request. in: header name: opc-request-id schema: type: string LongTermBackupProtectedDatabaseIdQueryParam: description: The protected database OCID. Use protectedDatabaseId to list the long-term backups of a specific protected database. in: query name: protectedDatabaseId required: false schema: type: string maxLength: 255 minLength: 1 SortByQueryParam: description: "The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If you do not specify a value, then TIMECREATED is used as the default sort order.\nAllowed values are:\n - TIMECREATED\n - DISPLAYNAME\n" in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string ProtectedDatabaseIdPathParam: description: The protected database OCID. in: path name: protectedDatabaseId required: true schema: type: string ProtectedDatabaseLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED WorkRequestStatusQueryParam: description: A filter to return only resources their lifecycleState matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED VcnIdQueryParam: description: The OCID of the virtual cloud network (VCN) associated with the recovery service subnet. in: query name: vcnId x-default-description: 'null' schema: type: string WorkRequestIdPathParam: description: The OCID of the work request. in: path name: workRequestId required: true schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire 'displayname' given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 LongTermBackupIdQueryParam: description: The long-term backup OCID. Use longTermBackupId to filter a long-term backup based on its unique identifier. in: query name: id required: false schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 ProtectionPolicyIdPathParam: description: The protection policy OCID. in: path name: protectionPolicyId required: true schema: type: string DryRunHeader: description: 'Indicates if the request is to test the preparedness for creating a protected database, without actually creating a protected database. If you set the `opcDryRun` option as `true`, then Recovery Service only performs a test run to check for any missing prerequisites or configurations required to create a protected database, and then returns error messages to warn you about any missing requirements. If an error occurs, you can review, correct, and repeat the dry run until the `createProtectedDatabase` request does not return any errors. These are the common issues that you can identify by performing a dry run of the `createProtectedDatabase` request: * The Recovery Service subnet has insufficient free IP addresses to support the required number of private endpoints. See, [troubleshooting](https://docs.oracle.com/en/cloud/paas/recovery-service/dbrsu/troubleshoot-backup-failures-recovery-service.html#GUID-05FA08B8-421D-4E52-B84B-7AFB84ADECF9) information * Recovery Service does not have permissions to manage the network resources in a chosen compartment * Recovery Service is out of capacity. See, [Service Limits](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/servicelimits.htm) for more information * Recovery Service resources exceed quota limits * A protected database, having the same database ID, already exists * The specified protection policy does not exist, or it is not in an Active state * The specified Recovery Service subnet does not exist, or it is not in an Active state See, [Prerequisites for Using Recovery Service](https://docs.oracle.com/en/cloud/paas/recovery-service/dbrsu/backup-recover-recovery-service.html#GUID-B2ABF281-DFF8-4A4E-AC85-629801AAF36A) for more information. ' in: header name: opc-dry-run required: false schema: type: boolean default: false LongTermBackupLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED RecoveryServiceSubnetLifecycleStateQueryParam: description: A filter to return only the resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETE_SCHEDULED - DELETING - DELETED - FAILED WorkRequestIdQueryParam: description: Unique Oracle-assigned identifier of the work request. in: query name: workRequestId x-default-description: 'null' schema: type: string DeletionScheduleQueryParam: description: 'Defines a preferred schedule to delete a protected database after you terminate the source database. * The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated . * The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires. ' in: query name: deletionSchedule required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DeletionSchedule' schema: type: string enum: - DELETE_AFTER_RETENTION_PERIOD - DELETE_AFTER_72_HOURS RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 ProtectedDatabaseIdQueryParam: description: The protected database OCID. in: query name: id x-default-description: 'null' schema: type: string WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted WorkRequestErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated RecoveryServiceSubnetIdPathParam: description: The recovery service subnet OCID. in: path name: recoveryServiceSubnetId required: true schema: type: string CompartmentIdQueryParam: description: The compartment OCID. in: query name: compartmentId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return per page. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 LongTermBackupIdPathParam: description: The long term backup OCID. in: path name: longTermBackupId required: true schema: type: string maxLength: 255 minLength: 1 OwnerQueryParam: description: A filter to return only the policies that match the owner as 'Customer' or 'Oracle'. in: query name: owner required: false x-default-description: 'null' schema: type: string enum: - oracle - customer PaginationLimitQueryParamForPolicy: description: The maximum number of items to return. Specify a value greater than 4. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 5 BackupCloudLocationQueryParam: description: Filter for cloud location of protected database. in: query name: backupCloudLocation x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/BackupCloudLocation' schema: type: string enum: - AZURE - OCI - GCP - AWS RecoveryServiceSubnetIdentifierQueryParam: description: The recovery service subnet OCID. in: query name: recoveryServiceSubnetId x-default-description: 'null' schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string location: description: 'Relative URL of the newly created resource. ' type: string opc-checksum: description: 'Contains file checksum passed in header. ' type: string opc-filename: description: 'Contains filename passed in header. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier of the work request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.dbrs