{ "opencollection": "1.0.0", "info": { "name": "Oracle Database Autonomous Recovery Service Database Recovery API", "version": "20210216" }, "items": [ { "info": { "name": "databaseRecovery", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all long term backups in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/longTermBackups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment OCID." }, { "name": "id", "value": "", "type": "query", "description": "The long-term backup OCID. Use longTermBackupId to filter a long-term backup based on its unique identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire 'displayname' given." }, { "name": "protectedDatabaseId", "value": "", "type": "query", "description": "The protected database OCID. Use protectedDatabaseId to list the long-term backups of a specific protected database." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "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.\n" }, { "info": { "name": "Creates a new long-term backup for the protected database with OCID", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/longTermBackups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a long-term backup of a specified protected database.\n" }, { "info": { "name": "Get Long Term Backup", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/longTermBackups/:longTermBackupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "longTermBackupId", "value": "", "type": "path", "description": "The long term backup OCID." } ] }, "docs": "Retrieves information regarding a long-term backup." }, { "info": { "name": "Update the long term backup identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210216/longTermBackups/:longTermBackupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "longTermBackupId", "value": "", "type": "path", "description": "The long term backup OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified long term backup." }, { "info": { "name": "Delete a LongTermBackup", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210216/longTermBackups/:longTermBackupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "longTermBackupId", "value": "", "type": "path", "description": "The long term backup OCID." } ] }, "docs": "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.\n" }, { "info": { "name": "Cancels scheduled long-term backup identified by longTermBackupId", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/longTermBackups/:longTermBackupId/actions/cancel", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "longTermBackupId", "value": "", "type": "path", "description": "The long term backup OCID." } ] }, "docs": "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." }, { "info": { "name": "Gets a list of all Protected Databases in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/protectedDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire 'displayname' given." }, { "name": "id", "value": "", "type": "query", "description": "The protected database OCID." }, { "name": "protectionPolicyId", "value": "", "type": "query", "description": "The protection policy OCID." }, { "name": "recoveryServiceSubnetId", "value": "", "type": "query", "description": "The recovery service subnet OCID." }, { "name": "backupCloudLocation", "value": "", "type": "query", "description": "Filter for cloud location of protected database." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Lists the protected databases based on the specified parameters.\n" }, { "info": { "name": "Creates a new Protected Database", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectedDatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-dry-run", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Protected Database.\n" }, { "info": { "name": "Get Protected Database", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." } ] }, "docs": "Gets information about a specified protected database." }, { "info": { "name": "Update the Protected Database identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Protected Database" }, { "info": { "name": "Delete a provisioned Protected Database", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." }, { "name": "deletionSchedule", "value": "", "type": "query", "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" } ] }, "docs": "Deletes a protected database based on the specified protected database ID.\nOnly the user or the Oracle Database service that created the protected database is allowed to modify or delete it.\n" }, { "info": { "name": "Cancel the scheduled deletion of the protected database", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId/actions/cancelDeletion", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." } ] }, "docs": "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." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Associates the protected database with a new cloud service environment, such as Microsoft Azure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId/actions/changeSubscription", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates the protected database with a new cloud service environment, such as Microsoft Azure." }, { "info": { "name": "Get Protected Database tnssnames.ora file", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId/actions/getConfiguration", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Downloads the network service configuration file 'tnsnames.ora' for a specified protected database. Applies to user-defined recovery systems only." }, { "info": { "name": "Schedule deletion of the protected database", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectedDatabases/:protectedDatabaseId/actions/scheduleDeletion", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectedDatabaseId", "value": "", "type": "path", "description": "The protected database OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Defines a preferred schedule to delete a protected database after you terminate the source database.\nOnly the user or the Oracle Database service that created the protected database is allowed to modify or delete it.\n\nThe default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.\nThe alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the po" }, { "info": { "name": "Gets a list of all ProtectionPolicies in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/protectionPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire 'displayname' given." }, { "name": "protectionPolicyId", "value": "", "type": "query", "description": "The protection policy OCID." }, { "name": "owner", "value": "", "type": "query", "description": "A filter to return only the policies that match the owner as 'Customer' or 'Oracle'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. Specify a value greater than 4." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Gets a list of protection policies based on the specified parameters.\n" }, { "info": { "name": "Creates a new Protection Policy", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectionPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Protection Policy.\n" }, { "info": { "name": "Get Protection Policy", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/protectionPolicies/:protectionPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectionPolicyId", "value": "", "type": "path", "description": "The protection policy OCID." } ] }, "docs": "Gets information about a specified protection policy." }, { "info": { "name": "Update the Protection Policy identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210216/protectionPolicies/:protectionPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectionPolicyId", "value": "", "type": "path", "description": "The protection policy OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified protection policy." }, { "info": { "name": "Delete a provisioned Protection Policy", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210216/protectionPolicies/:protectionPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectionPolicyId", "value": "", "type": "path", "description": "The protection policy OCID." } ] }, "docs": "Deletes a specified protection policy. You can delete custom policies only.\nDeleting a Oracle predefined policies will result in status code 405 Method Not Allowed.\n" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/protectionPolicies/:protectionPolicyId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "protectionPolicyId", "value": "", "type": "path", "description": "The protection policy OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Gets a list of recovery service subnet resources based on the specified parameters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/recoveryServiceSubnets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the resources that match the specified lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire 'displayname' given." }, { "name": "id", "value": "", "type": "query", "description": "The recovery service subnet OCID." }, { "name": "vcnId", "value": "", "type": "query", "description": "The OCID of the virtual cloud network (VCN) associated with the recovery service subnet." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Returns a list of Recovery Service Subnets.\n" }, { "info": { "name": "Creates a new recovery service subnet.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/recoveryServiceSubnets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Recovery Service Subnet.\n" }, { "info": { "name": "Get Recovery Service Subnet", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/recoveryServiceSubnets/:recoveryServiceSubnetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recoveryServiceSubnetId", "value": "", "type": "path", "description": "The recovery service subnet OCID." } ] }, "docs": "Gets information about a specified recovery service subnet." }, { "info": { "name": "Update the Recovery Service Subnet identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210216/recoveryServiceSubnets/:recoveryServiceSubnetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recoveryServiceSubnetId", "value": "", "type": "path", "description": "The recovery service subnet OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified recovery service subnet." }, { "info": { "name": "Deletes a specified recovery service subnet.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210216/recoveryServiceSubnets/:recoveryServiceSubnetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recoveryServiceSubnetId", "value": "", "type": "path", "description": "The recovery service subnet OCID." } ] }, "docs": "Deletes a specified recovery service subnet." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210216/recoveryServiceSubnets/:recoveryServiceSubnetId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recoveryServiceSubnetId", "value": "", "type": "path", "description": "The recovery service subnet OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment OCID." }, { "name": "workRequestId", "value": "", "type": "query", "description": "Unique Oracle-assigned identifier of the work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given OperationStatus." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Gets the status of the work request based on the specified ID" }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210216/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (ASC) or descending (DESC).\nAllowed values are:\n - ASC\n - DESC" } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }