DatabaseClient¶
-
class
oci.database.
DatabaseClient
(config, **kwargs)¶ The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](/iaas/Content/Database/Concepts/databaseoverview.htm).
Methods
__init__
(config, **kwargs)Creates a new service client activate_exadata_infrastructure
(…)Activates the specified Exadata infrastructure resource. add_storage_capacity_cloud_exadata_infrastructure
(…)Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. add_storage_capacity_exadata_infrastructure
(…)Makes the storage capacity from additional storage servers available for VM Cluster consumption. add_virtual_machine_to_cloud_vm_cluster
(…)Add Virtual Machines to the Cloud VM cluster. add_virtual_machine_to_vm_cluster
(…)Add Virtual Machines to the VM cluster. autonomous_database_manual_refresh
(…)Initiates a data refresh for an Autonomous Database refreshable clone. cancel_backup
(backup_id, **kwargs)Cancel automatic/standalone full/incremental create backup workrequests specified by the backup Id. cancel_execution_window
(execution_window_id, …)Cancels the in progress maintenance activity under this execution window. cascading_delete_scheduling_plan
(…)Delete the scheduling plan resource along with all the scheduled actions associated with this resource. change_autonomous_container_database_compartment
(…)Move the Autonomous Container Database and its dependent resources to the specified compartment. change_autonomous_database_compartment
(…)Move the Autonomous Database and its dependent resources to the specified compartment. change_autonomous_database_software_image_compartment
(…)Move the Autonomous Database Software Image and its dependent resources to the specified compartment. change_autonomous_database_subscription
(…)Associate an Autonomous Database with a different subscription. change_autonomous_exadata_infrastructure_compartment
(…)Deprecated. Use the change_cloud_exadata_infrastructure_compartment()
operation to move an Exadata infrastructure resource to a different compartment andchange_cloud_autonomous_vm_cluster_compartment()
operation to move an Autonomous Exadata VM cluster to a different compartment.change_autonomous_vm_cluster_compartment
(…)Moves an Autonomous VM cluster and its dependent resources to another compartment. change_backup_destination_compartment
(…)Move the backup destination and its dependent resources to the specified compartment. change_cloud_autonomous_vm_cluster_compartment
(…)Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. change_cloud_exadata_infrastructure_compartment
(…)Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. change_cloud_exadata_infrastructure_subscription
(…)Associate a cloud Exadata infrastructure with a different subscription. change_cloud_vm_cluster_compartment
(…)Moves a cloud VM cluster and its dependent resources to another compartment. change_cloud_vm_cluster_subscription
(…)Associate a cloud VM cluster with a different subscription. change_database_software_image_compartment
(…)Move the Database Software Image and its dependent resources to the specified compartment. change_dataguard_role
(…)Switch the Autonomous Container Database role between Standby and Snapshot Standby. change_db_system_compartment
(…)Moves the DB system and its dependent resources to the specified compartment. change_disaster_recovery_configuration
(…)This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database, and must be run on the standby side. change_encryption_key_location
(database_id, …)Update the encryption key management location for the database change_exadata_infrastructure_compartment
(…)Moves an Exadata infrastructure resource and its dependent resources to another compartment. change_exadb_vm_cluster_compartment
(…)Moves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. change_exascale_db_storage_vault_compartment
(…)Moves a Exadata Database Storage Vault to another compartment. change_external_container_database_compartment
(…)Move the create_external_container_database_details()
and its dependent resources to the specified compartment.change_external_non_container_database_compartment
(…)Move the external non-container database and its dependent resources to the specified compartment. change_external_pluggable_database_compartment
(…)Move the create_external_pluggable_database_details()
and its dependent resources to the specified compartment.change_key_store_compartment
(…)Move the key store resource to the specified compartment. change_key_store_type
(database_id, …)Changes encryption key management type change_oneoff_patch_compartment
(…)Move the one-off patch to the specified compartment. change_scheduling_plan_compartment
(…)Moves an scheduling plan resource to another compartment. change_scheduling_policy_compartment
(…)Moves an scheduling policy resource to another compartment. change_vm_cluster_compartment
(…)Moves a VM cluster and its dependent resources to another compartment. check_external_database_connector_connection_status
(…)Check the status of the external database connection specified in this connector. complete_external_backup_job
(backup_id, …)Changes the status of the standalone backup resource to ACTIVE after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage. configure_autonomous_database_vault_key
(…)Configures the Autonomous Database Vault service `key`__. configure_exascale_exadata_infrastructure
(…)Configures Exascale on Exadata infrastructure resource. configure_saas_admin_user
(…)This operation updates SaaS administrative user configuration of the Autonomous Database. confirm_key_store_details_are_correct
(…)This is for user to confirm to DBaaS that the Oracle Key Valut (OKV) connection IPs, username and password are all correct. convert_to_pdb
(database_id, …)Converts a non-container database to a pluggable database. convert_to_regular_pluggable_database
(…)Converts a Refreshable clone to Regular pluggable database (PDB). convert_to_standalone
(database_id, …)Disassociate the standby database identified by the databaseId parameter from existing Data Guard group. create_application_vip
(…)Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide. create_autonomous_container_database
(…)Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure. create_autonomous_container_database_dataguard_association
(…)Create a new Autonomous Data Guard association. create_autonomous_database
(…)Creates a new Autonomous Database. create_autonomous_database_backup
(…)Creates a new Autonomous Database backup for the specified database based on the provided request parameters. create_autonomous_database_software_image
(…)create Autonomous Database Software Image in the specified compartment. create_autonomous_vm_cluster
(…)Creates an Autonomous VM cluster for Exadata Cloud@Customer. create_backup
(create_backup_details, **kwargs)Creates a new backup in the specified database based on the request parameters you provide. create_backup_destination
(…)Creates a backup destination in an Exadata Cloud@Customer system. create_cloud_autonomous_vm_cluster
(…)Creates an Autonomous Exadata VM cluster in the Oracle cloud. create_cloud_exadata_infrastructure
(…)Creates a cloud Exadata infrastructure resource. create_cloud_vm_cluster
(…)Creates a cloud VM cluster. create_console_connection
(…)Creates a new console connection to the specified database node. create_console_history
(…)Captures the most recent serial console data (up to a megabyte) for the specified database node. create_data_guard_association
(database_id, …)Creates a new Data Guard association. create_database
(create_new_database_details, …)Creates a new database in the specified Database Home. create_database_software_image
(…)create database software image in the specified compartment. create_db_home
(…)Creates a new Database Home in the specified database system based on the request parameters you provide. create_exadata_infrastructure
(…)Creates an Exadata infrastructure resource. create_exadb_vm_cluster
(…)Creates an Exadata VM cluster on Exascale Infrastructure create_exascale_db_storage_vault
(…)Creates an Exadata Database Storage Vault create_execution_action
(…)Creates an execution action resource. create_execution_window
(…)Creates an execution window resource. create_external_backup_job
(…)Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure. create_external_container_database
(…)Creates a new external container database resource. create_external_database_connector
(…)Creates a new external database connector. create_external_non_container_database
(…)Creates a new ExternalNonContainerDatabase resource create_external_pluggable_database
(…)Registers a new create_external_pluggable_database_details()
resource.create_key_store
(create_key_store_details, …)Creates a Key Store. create_maintenance_run
(…)Creates a maintenance run with one of the following: 1. create_oneoff_patch
(…)Creates one-off patch for specified database version to download. create_pluggable_database
(…)Creates and starts a pluggable database in the specified container database. create_scheduled_action
(…)Creates a Scheduled Action resource. create_scheduling_plan
(…)Creates a Scheduling Plan resource. create_scheduling_policy
(…)Creates a Scheduling Policy resource. create_scheduling_window
(…)Creates a Scheduling Window resource. create_vm_cluster
(create_vm_cluster_details, …)Creates an Exadata Cloud@Customer VM cluster. create_vm_cluster_network
(…)Creates the VM cluster network. db_node_action
(db_node_id, action, **kwargs)Performs one of the following power actions on the specified DB node: delete_application_vip
(application_vip_id, …)Deletes and deregisters the specified application virtual IP (VIP) address. delete_autonomous_database
(…)Deletes the specified Autonomous Database. delete_autonomous_database_backup
(…)Deletes a long-term backup. delete_autonomous_database_software_image
(…)Delete an Autonomous Database Software Image delete_autonomous_vm_cluster
(…)Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. delete_backup
(backup_id, **kwargs)Deletes a full backup. delete_backup_destination
(…)Deletes a backup destination in an Exadata Cloud@Customer system. delete_cloud_autonomous_vm_cluster
(…)Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. delete_cloud_exadata_infrastructure
(…)Deletes the cloud Exadata infrastructure resource. delete_cloud_vm_cluster
(cloud_vm_cluster_id, …)Deletes the specified cloud VM cluster. delete_console_connection
(db_node_id, …)Deletes the specified database node console connection. delete_console_history
(db_node_id, …)Deletes the specified database node console history. delete_database
(database_id, **kwargs)Deletes the specified database. delete_database_software_image
(…)Delete a database software image delete_db_home
(db_home_id, **kwargs)Deletes a Database Home. delete_exadata_infrastructure
(…)Deletes the Exadata Cloud@Customer infrastructure. delete_exadb_vm_cluster
(exadb_vm_cluster_id, …)Deletes the specified Exadata VM cluster on Exascale Infrastructure. delete_exascale_db_storage_vault
(…)Deletes the specified Exadata Database Storage Vault. delete_execution_action
(execution_action_id, …)Deletes the execution action. delete_execution_window
(execution_window_id, …)Deletes the execution window. delete_external_container_database
(…)Deletes the create_external_container_database_details()
resource.delete_external_database_connector
(…)Deletes an external database connector. delete_external_non_container_database
(…)Deletes the Oracle Cloud Infrastructure resource representing an external non-container database. delete_external_pluggable_database
(…)Deletes the create_external_pluggable_database_details()
.delete_key_store
(key_store_id, **kwargs)Deletes a key store. delete_oneoff_patch
(oneoff_patch_id, **kwargs)Deletes a one-off patch. delete_pluggable_database
(…)Deletes the specified pluggable database. delete_scheduled_action
(scheduled_action_id, …)Deletes the scheduled action. delete_scheduling_plan
(scheduling_plan_id, …)Deletes the scheduling plan. delete_scheduling_policy
(…)Deletes the scheduling policy. delete_scheduling_window
(…)Deletes the scheduling window. delete_vm_cluster
(vm_cluster_id, **kwargs)Deletes the specified VM cluster. delete_vm_cluster_network
(…)Deletes the specified VM cluster network. deregister_autonomous_database_data_safe
(…)Asynchronously deregisters this Autonomous Database with Data Safe. disable_autonomous_database_management
(…)Disables Database Management for the Autonomous Database resource. disable_autonomous_database_operations_insights
(…)Disables Operations Insights for the Autonomous Database resource. disable_database_management
(database_id, …)Disables the Database Management service for the database. disable_external_container_database_database_management
(…)Disable Database Management service for the external container database. disable_external_container_database_stack_monitoring
(…)Disable Stack Monitoring for the external container database. disable_external_non_container_database_database_management
(…)Disable Database Management Service for the external non-container database. disable_external_non_container_database_operations_insights
(…)Disable Operations Insights for the external non-container database. disable_external_non_container_database_stack_monitoring
(…)Disable Stack Monitoring for the external non-container database. disable_external_pluggable_database_database_management
(…)Disable Database Management Service for the external pluggable database. disable_external_pluggable_database_operations_insights
(…)Disable Operations Insights for the external pluggable database. disable_external_pluggable_database_stack_monitoring
(…)Disable Stack Monitoring for the external pluggable database. disable_pluggable_database_management
(…)Disables the Database Management service for the pluggable database. download_exadata_infrastructure_config_file
(…)Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure. download_oneoff_patch
(oneoff_patch_id, **kwargs)Download one-off patch. download_validation_report
(…)Downloads the network validation report file for the specified VM cluster network. download_vm_cluster_network_config_file
(…)Downloads the configuration file for the specified VM cluster network. enable_autonomous_database_management
(…)Enables Database Management for Autonomous Database. enable_autonomous_database_operations_insights
(…)Enables the specified Autonomous Database with Operations Insights. enable_database_management
(database_id, …)Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. enable_external_container_database_database_management
(…)Enables Database Management Service for the external container database. enable_external_container_database_stack_monitoring
(…)Enable Stack Monitoring for the external container database. enable_external_non_container_database_database_management
(…)Enable Database Management Service for the external non-container database. enable_external_non_container_database_operations_insights
(…)Enable Operations Insights for the external non-container database. enable_external_non_container_database_stack_monitoring
(…)Enable Stack Monitoring for the external non-container database. enable_external_pluggable_database_database_management
(…)Enable Database Management Service for the external pluggable database. enable_external_pluggable_database_operations_insights
(…)Enable Operations Insights for the external pluggable database. enable_external_pluggable_database_stack_monitoring
(…)Enable Stack Monitoring for the external pluggable database. enable_pluggable_database_management
(…)Enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. fail_over_autonomous_database
(…)Initiates a failover of the specified Autonomous Database to the associated peer database. failover_autonomous_container_database_dataguard_association
(…)Fails over the standby Autonomous Container Database identified by the autonomousContainerDatabaseId parameter to the primary Autonomous Container Database after the existing primary Autonomous Container Database fails or becomes unreachable. failover_data_guard
(database_id, …)Performs a failover to transition the standby database identified by the databaseId path parameter into the primary role after the existing primary database fails or becomes unreachable. failover_data_guard_association
(database_id, …)Performs a failover to transition the standby database identified by the databaseId parameter into the specified Data Guard association’s primary role after the existing primary database fails or becomes unreachable. generate_autonomous_database_wallet
(…)Creates and downloads a wallet for the specified Autonomous Database. generate_recommended_vm_cluster_network
(…)Generates a recommended Cloud@Customer VM cluster network configuration. get_application_vip
(application_vip_id, **kwargs)Gets information about a specified application virtual IP (VIP) address. get_autonomous_container_database
(…)Gets information about the specified Autonomous Container Database. get_autonomous_container_database_dataguard_association
(…)Gets an Autonomous Container Database enabled with Autonomous Data Guard associated with the specified Autonomous Container Database. get_autonomous_container_database_resource_usage
(…)Get resource usage details for the specified Autonomous Container Database. get_autonomous_database
(…)Gets the details of the specified Autonomous Database. get_autonomous_database_backup
(…)Gets information about the specified Autonomous Database backup. get_autonomous_database_dataguard_association
(…)Gets an Autonomous Data Guard-enabled database associated with the specified Autonomous Database. get_autonomous_database_regional_wallet
(**kwargs)Gets the Autonomous Database regional wallet details. get_autonomous_database_software_image
(…)Gets information about the specified Autonomous Database Software Image. get_autonomous_database_wallet
(…)Gets the wallet details for the specified Autonomous Database. get_autonomous_exadata_infrastructure
(…)Deprecated. Use the get_cloud_exadata_infrastructure()
operation to get details of an Exadata Infrastructure resource and theget_cloud_autonomous_vm_cluster()
operation to get details of an Autonomous Exadata VM cluster.get_autonomous_patch
(autonomous_patch_id, …)Gets information about a specific autonomous patch. get_autonomous_virtual_machine
(…)Gets the details of specific Autonomous Virtual Machine. get_autonomous_vm_cluster
(…)Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. get_autonomous_vm_cluster_resource_usage
(…)Get the resource usage details for the specified Autonomous Exadata VM cluster. get_backup
(backup_id, **kwargs)Gets information about the specified backup. get_backup_destination
(…)Gets information about the specified backup destination in an Exadata Cloud@Customer system. get_cloud_autonomous_vm_cluster
(…)Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. get_cloud_autonomous_vm_cluster_resource_usage
(…)Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster. get_cloud_exadata_infrastructure
(…)Gets information about the specified cloud Exadata infrastructure resource. get_cloud_exadata_infrastructure_unallocated_resources
(…)Gets unallocated resources information for the specified Cloud Exadata infrastructure. get_cloud_vm_cluster
(cloud_vm_cluster_id, …)Gets information about the specified cloud VM cluster. get_cloud_vm_cluster_iorm_config
(…)Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. get_cloud_vm_cluster_update
(…)Gets information about a specified maintenance update package for a cloud VM cluster. get_cloud_vm_cluster_update_history_entry
(…)Gets the maintenance update history details for the specified update history entry. get_console_connection
(db_node_id, …)Gets the specified database node console connection’s information. get_console_history
(db_node_id, …)Gets information about the specified database node console history. get_console_history_content
(db_node_id, …)Retrieves the specified database node console history contents upto a megabyte. get_data_guard_association
(database_id, …)Gets the specified Data Guard association’s configuration information. get_database
(database_id, **kwargs)Gets information about the specified database. get_database_software_image
(…)Gets information about the specified database software image. get_database_upgrade_history_entry
(…)gets the upgrade history for a specified database. get_db_home
(db_home_id, **kwargs)Gets information about the specified Database Home. get_db_home_patch
(db_home_id, patch_id, **kwargs)Gets information about a specified patch package. get_db_home_patch_history_entry
(db_home_id, …)Gets the patch history details for the specified patchHistoryEntryId get_db_node
(db_node_id, **kwargs)Gets information about the specified database node. get_db_server
(exadata_infrastructure_id, …)Gets information about the Exadata Db server. get_db_system
(db_system_id, **kwargs)Gets information about the specified DB system. get_db_system_patch
(db_system_id, patch_id, …)Gets information the specified patch. get_db_system_patch_history_entry
(…)Gets the details of the specified patch operation on the specified DB system. get_db_system_upgrade_history_entry
(…)Gets the details of the specified operating system upgrade operation for the specified DB system. get_exadata_infrastructure
(…)Gets information about the specified Exadata infrastructure. get_exadata_infrastructure_ocpus
(…)Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource. get_exadata_infrastructure_un_allocated_resources
(…)Gets un allocated resources information for the specified Exadata infrastructure. get_exadata_iorm_config
(db_system_id, **kwargs)Gets the IORM configuration settings for the specified cloud Exadata DB system. get_exadb_vm_cluster
(exadb_vm_cluster_id, …)Gets information about the specified Exadata VM cluster on Exascale Infrastructure. get_exadb_vm_cluster_update
(…)Gets information about a specified maintenance update package for a Exadata VM cluster on Exascale Infrastructure. get_exadb_vm_cluster_update_history_entry
(…)Gets the maintenance update history details for the specified update history entry. get_exascale_db_storage_vault
(…)Gets information about the specified Exadata Database Storage Vaults in the specified compartment. get_execution_action
(execution_action_id, …)Gets information about the specified execution action. get_execution_window
(execution_window_id, …)Gets information about the specified execution window. get_external_backup_job
(backup_id, **kwargs)Gets information about the specified external backup job. get_external_container_database
(…)Gets information about the specified external container database. get_external_database_connector
(…)Gets information about the specified external database connector. get_external_non_container_database
(…)Gets information about a specific external non-container database. get_external_pluggable_database
(…)Gets information about a specific create_external_pluggable_database_details()
resource.get_infrastructure_target_versions
(…)Gets details of the Exadata Infrastructure target system software versions that can be applied to the specified infrastructure resource for maintenance updates. get_key_store
(key_store_id, **kwargs)Gets information about the specified key store. get_maintenance_run
(maintenance_run_id, **kwargs)Gets information about the specified maintenance run. get_maintenance_run_history
(…)Gets information about the specified maintenance run history. get_oneoff_patch
(oneoff_patch_id, **kwargs)Gets information about the specified one-off patch. get_pdb_conversion_history_entry
(…)Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB). get_pluggable_database
(…)Gets information about the specified pluggable database. get_scheduled_action
(scheduled_action_id, …)Gets information about the specified Scheduled Action. get_scheduling_plan
(scheduling_plan_id, **kwargs)Gets information about the specified Scheduling Plan. get_scheduling_policy
(scheduling_policy_id, …)Gets information about the specified Scheduling Policy. get_scheduling_window
(scheduling_policy_id, …)Gets information about the specified Scheduling Window. get_vm_cluster
(vm_cluster_id, **kwargs)Gets information about the VM cluster. get_vm_cluster_network
(…)Gets information about the specified VM cluster network. get_vm_cluster_patch
(vm_cluster_id, …)Gets information about a specified patch package. get_vm_cluster_patch_history_entry
(…)Gets the patch history details for the specified patch history entry. get_vm_cluster_update
(vm_cluster_id, …)Gets information about a specified maintenance update package for a VM cluster. get_vm_cluster_update_history_entry
(…)Gets the maintenance update history details for the specified update history entry. launch_autonomous_exadata_infrastructure
(…)Deprecated To create a new Autonomous Database system on dedicated Exadata Infrastructure, use the create_cloud_exadata_infrastructure()
andcreate_cloud_autonomous_vm_cluster()
operations instead. Note that to create an Autonomous VM cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster.launch_db_system
(launch_db_system_details, …)Creates a new DB system in the specified compartment and availability domain. list_application_vips
(compartment_id, …)Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster. list_autonomous_container_database_dataguard_associations
(…)Gets a list of the Autonomous Container Databases with Autonomous Data Guard-enabled associated with the specified Autonomous Container Database. list_autonomous_container_database_versions
(…)Gets a list of supported Autonomous Container Database versions. list_autonomous_container_databases
(…)Gets a list of the Autonomous Container Databases in the specified compartment. list_autonomous_database_backups
(**kwargs)Gets a list of Autonomous Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter. list_autonomous_database_character_sets
(**kwargs)Gets a list of supported character sets. list_autonomous_database_clones
(…)Lists the Autonomous Database clones for the specified Autonomous Database. list_autonomous_database_dataguard_associations
(…)Gets a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous Database. list_autonomous_database_peers
(…)Lists the Autonomous Database peers for the specified Autonomous Database. list_autonomous_database_refreshable_clones
(…)Lists the OCIDs of the Autonomous Database local and connected remote refreshable clones with the region where they exist for the specified source database. list_autonomous_database_software_images
(…)Gets a list of the Autonomous Database Software Images in the specified compartment. list_autonomous_databases
(compartment_id, …)Gets a list of Autonomous Databases based on the query parameters specified. list_autonomous_db_preview_versions
(…)Gets a list of supported Autonomous Database versions. list_autonomous_db_versions
(compartment_id, …)Gets a list of supported Autonomous Database versions. list_autonomous_exadata_infrastructure_shapes
(…)Deprecated. list_autonomous_exadata_infrastructures
(…)Deprecated. Use the list_cloud_exadata_infrastructures()
operation to list Exadata Infrastructures in the Oracle cloud and thelist_cloud_autonomous_vm_clusters()
operation to list Autonomous Exadata VM clusters.list_autonomous_virtual_machines
(…)Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment. list_autonomous_vm_cluster_acd_resource_usage
(…)Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster. list_autonomous_vm_clusters
(compartment_id, …)Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. list_backup_destination
(compartment_id, **kwargs)Gets a list of backup destinations in the specified compartment. list_backups
(**kwargs)Gets a list of backups based on the databaseId or compartmentId specified. list_cloud_autonomous_vm_cluster_acd_resource_usage
(…)Gets the list of resource usage details for all the Cloud Autonomous Container Database in the specified Cloud Autonomous Exadata VM cluster. list_cloud_autonomous_vm_clusters
(…)Lists Autonomous Exadata VM clusters in the Oracle cloud. list_cloud_exadata_infrastructures
(…)Gets a list of the cloud Exadata infrastructure resources in the specified compartment. list_cloud_vm_cluster_update_history_entries
(…)Gets the history of the maintenance update actions performed on the specified cloud VM cluster. list_cloud_vm_cluster_updates
(…)Lists the maintenance updates that can be applied to the specified cloud VM cluster. list_cloud_vm_clusters
(compartment_id, **kwargs)Gets a list of the cloud VM clusters in the specified compartment. list_console_connections
(db_node_id, **kwargs)Lists the console connections for the specified database node. list_console_histories
(db_node_id, **kwargs)Lists the console histories for the specified database node. list_container_database_patches
(…)Lists the patches applicable to the requested container database. list_data_guard_associations
(database_id, …)Lists all Data Guard associations for the specified database. list_database_software_images
(…)Gets a list of the database software images in the specified compartment. list_database_upgrade_history_entries
(…)Gets the upgrade history for a specified database in a bare metal or virtual machine DB system. list_databases
(compartment_id, **kwargs)Gets a list of the databases in the specified Database Home. list_db_home_patch_history_entries
(…)Lists the history of patch operations on the specified Database Home. list_db_home_patches
(db_home_id, **kwargs)Lists patches applicable to the requested Database Home. list_db_homes
(compartment_id, **kwargs)Lists the Database Homes in the specified DB system and compartment. list_db_nodes
(compartment_id, **kwargs)Lists the database nodes in the specified DB system and compartment. list_db_servers
(compartment_id, …)Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment. list_db_system_compute_performances
(**kwargs)Gets a list of expected compute performance parameters for a virtual machine DB system based on system configuration. list_db_system_patch_history_entries
(…)Gets the history of the patch actions performed on the specified DB system. list_db_system_patches
(db_system_id, **kwargs)Lists the patches applicable to the specified DB system. list_db_system_shapes
(compartment_id, **kwargs)Gets a list of the shapes that can be used to launch a new DB system. list_db_system_storage_performances
(…)Gets a list of possible expected storage performance parameters of a VMDB System based on Configuration. list_db_system_upgrade_history_entries
(…)Gets the history of the upgrade actions performed on the specified DB system. list_db_systems
(compartment_id, **kwargs)Lists the DB systems in the specified compartment. list_db_versions
(compartment_id, **kwargs)Gets a list of supported Oracle Database versions. list_exadata_infrastructures
(compartment_id, …)Lists the Exadata infrastructure resources in the specified compartment. list_exadb_vm_cluster_update_history_entries
(…)Gets the history of the maintenance update actions performed on the specified Exadata VM cluster on Exascale Infrastructure. list_exadb_vm_cluster_updates
(…)Lists the maintenance updates that can be applied to the specified Exadata VM cluster on Exascale Infrastructure. list_exadb_vm_clusters
(compartment_id, **kwargs)Gets a list of the Exadata VM clusters on Exascale Infrastructure in the specified compartment. list_exascale_db_storage_vaults
(…)Gets a list of the Exadata Database Storage Vaults in the specified compartment. list_execution_actions
(compartment_id, **kwargs)Lists the execution action resources in the specified compartment. list_execution_windows
(compartment_id, **kwargs)Lists the execution window resources in the specified compartment. list_external_container_databases
(…)Gets a list of the external container databases in the specified compartment. list_external_database_connectors
(…)Gets a list of the external database connectors in the specified compartment. list_external_non_container_databases
(…)Gets a list of the ExternalNonContainerDatabases in the specified compartment. list_external_pluggable_databases
(…)Gets a list of the create_external_pluggable_database_details()
resources in the specified compartment.list_flex_components
(compartment_id, **kwargs)Gets a list of the flex components that can be used to launch a new DB system. list_gi_version_minor_versions
(version, **kwargs)Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family. list_gi_versions
(compartment_id, **kwargs)Gets a list of supported GI versions. list_key_stores
(compartment_id, **kwargs)Gets a list of key stores in the specified compartment. list_maintenance_run_history
(compartment_id, …)Gets a list of the maintenance run histories in the specified compartment. list_maintenance_runs
(compartment_id, **kwargs)Gets a list of the maintenance runs in the specified compartment. list_oneoff_patches
(compartment_id, **kwargs)Lists one-off patches in the specified compartment. list_params_for_action_type
(type, **kwargs)List all the action params and their possible values for a given action type list_pdb_conversion_history_entries
(…)Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system. list_pluggable_databases
(**kwargs)Gets a list of the pluggable databases in a database or compartment. list_recommended_scheduled_actions
(…)Returns a recommended Scheduled Actions configuration for a given resource, plan intent and scheduling policy. list_scheduled_actions
(compartment_id, **kwargs)Lists the Scheduled Action resources in the specified compartment. list_scheduling_plans
(compartment_id, **kwargs)Lists the Scheduling Plan resources in the specified compartment. list_scheduling_policies
(compartment_id, …)Lists the Scheduling Policy resources in the specified compartment. list_scheduling_windows
(…)Lists the Scheduling Window resources in the specified compartment. list_system_versions
(compartment_id, shape, …)Gets a list of supported Exadata system versions for a given shape and GI version. list_vm_cluster_networks
(…)Gets a list of the VM cluster networks in the specified compartment. list_vm_cluster_patch_history_entries
(…)Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system. list_vm_cluster_patches
(vm_cluster_id, **kwargs)Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system. list_vm_cluster_update_history_entries
(…)Gets the history of the maintenance update actions performed on the specified VM cluster. list_vm_cluster_updates
(vm_cluster_id, **kwargs)Lists the maintenance updates that can be applied to the specified VM cluster. list_vm_clusters
(compartment_id, **kwargs)Lists the VM clusters in the specified compartment. local_clone_pluggable_database
(…)Deprecated. Use create_pluggable_database()
for Pluggable Database LocalClone Operation.migrate_data_guard_association_to_multi_data_guards
(…)Migrates the existing Data Guard association to new Data Guard model to support multiple standby databases functionality. migrate_exadata_db_system_resource_model
(…)Migrates the Exadata DB system to the new `Exadata resource model`__. migrate_vault_key
(database_id, …)Changes encryption key management from customer-managed, using the `Vault service`__, to Oracle-managed. modify_database_management
(database_id, …)Updates one or more attributes of the Database Management service for the database. modify_pluggable_database_management
(…)Updates one or more attributes of the Database Management service for the pluggable database. move_execution_action_member
(…)Moves an execution action member to this execution action resource from another. refresh_pluggable_database
(…)Refreshes a pluggable database (PDB) Refreshable clone. register_autonomous_database_data_safe
(…)Asynchronously registers this Autonomous Database with Data Safe. reinstate_autonomous_container_database_dataguard_association
(…)Reinstates a disabled standby Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter, to an active standby Autonomous Container Database. reinstate_data_guard
(database_id, …)Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association. reinstate_data_guard_association
(…)Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association. remote_clone_pluggable_database
(…)Deprecated. Use create_pluggable_database()
for Pluggable Database RemoteClone Operation.remove_virtual_machine_from_cloud_vm_cluster
(…)Remove Virtual Machines from the Cloud VM cluster. remove_virtual_machine_from_exadb_vm_cluster
(…)Remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. remove_virtual_machine_from_vm_cluster
(…)Remove Virtual Machines from the VM cluster. reorder_execution_actions
(…)Reorders the execution actions under this execution window resource. reorder_scheduled_actions
(…)Re-order the scheduled actions under this scheduling plan resource. resize_vm_cluster_network
(…)Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. resource_pool_shapes
(**kwargs)Lists available resource pools shapes. restart_autonomous_container_database
(…)Rolling restarts the specified Autonomous Container Database. restart_autonomous_database
(…)Restarts the specified Autonomous Database. restore_autonomous_database
(…)Restores an Autonomous Database based on the provided request parameters. restore_database
(database_id, …)Restore a Database based on the request parameters you provide. rotate_autonomous_container_database_encryption_key
(…)Creates a new version of an existing `Vault service`__ key. rotate_autonomous_database_encryption_key
(…)Rotate existing AutonomousDatabase `Vault service`__ key. rotate_autonomous_vm_cluster_ords_certs
(…)Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster. rotate_autonomous_vm_cluster_ssl_certs
(…)Rotates the SSL certificates for Autonomous Exadata VM cluster. rotate_cloud_autonomous_vm_cluster_ords_certs
(…)Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster. rotate_cloud_autonomous_vm_cluster_ssl_certs
(…)Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster. rotate_ords_certs
(…)Deprecated. Use the rotate_cloud_autonomous_vm_cluster_ords_certs()
to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead.rotate_pluggable_database_encryption_key
(…)Create a new version of the existing encryption key. rotate_ssl_certs
(…)Deprecated. Use the rotate_cloud_autonomous_vm_cluster_ssl_certs()
to rotate SSL certs for an Autonomous Exadata VM cluster instead.rotate_vault_key
(database_id, **kwargs)Creates a new version of an existing `Vault service`__ key. saas_admin_user_status
(…)This operation gets SaaS administrative user status of the Autonomous Database. scan_external_container_database_pluggable_databases
(…)Scans for pluggable databases in the specified external container database. set_db_key_version
(database_id, …)Sets a new version of an existing `Vault service`__ key. set_pdb_key_version
(pluggable_database_id, …)Sets a new version of an existing `Vault service`__ key. shrink_autonomous_database
(…)This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). start_autonomous_database
(…)Starts the specified Autonomous Database. start_pluggable_database
(…)Starts a stopped pluggable database. stop_autonomous_database
(…)Stops the specified Autonomous Database. stop_pluggable_database
(…)Stops a pluggable database. switch_over_data_guard
(database_id, …)Performs a switchover to transition primary database of this Data Guard association into a standby role. switchover_autonomous_container_database_dataguard_association
(…)Switches over the primary Autonomous Container Database of an Autonomous Data Guard peer association to standby role. switchover_autonomous_database
(…)Initiates a switchover of the specified Autonomous Database to the associated peer database. switchover_data_guard_association
(…)Performs a switchover to transition the primary database of a Data Guard association into a standby role. terminate_autonomous_container_database
(…)Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. terminate_autonomous_exadata_infrastructure
(…)Deprecated. To terminate an Exadata Infrastructure resource in the Oracle cloud, use the delete_cloud_exadata_infrastructure()
operation. To delete an Autonomous Exadata VM cluster in the Oracle cloud, use thedelete_cloud_autonomous_vm_cluster()
operation.terminate_db_system
(db_system_id, **kwargs)Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. update_autonomous_container_database
(…)Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags. update_autonomous_container_database_dataguard_association
(…)Update Autonomous Data Guard association. update_autonomous_database
(…)Updates one or more attributes of the specified Autonomous Database. update_autonomous_database_backup
(…)Updates the Autonomous Database backup of the specified database based on the request parameters. update_autonomous_database_regional_wallet
(…)Updates the Autonomous Database regional wallet. update_autonomous_database_software_image
(…)Updates the properties of an Autonomous Database Software Image, like add tags update_autonomous_database_wallet
(…)Updates the wallet for the specified Autonomous Database. update_autonomous_exadata_infrastructure
(…)Deprecated. Use the update_cloud_exadata_infrastructure()
operation to update an Exadata Infrastructure resource andupdate_cloud_autonomous_vm_cluster()
operation to update an Autonomous Exadata VM cluster.update_autonomous_vm_cluster
(…)Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see update_cloud_autonomous_vm_cluster()
.update_backup_destination
(…)If no database is associated with the backup destination: - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users. update_cloud_autonomous_vm_cluster
(…)Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. update_cloud_exadata_infrastructure
(…)Updates the Cloud Exadata infrastructure resource. update_cloud_vm_cluster
(cloud_vm_cluster_id, …)Updates the specified cloud VM cluster. update_cloud_vm_cluster_iorm_config
(…)Updates the IORM settings for the specified cloud VM cluster in an Exadata Cloud Service instance. update_console_connection
(db_node_id, …)Updates the specified database node console connection. update_console_history
(db_node_id, …)Updates the specified database node console history. update_data_guard
(database_id, …)Update an existing Data Guard member. update_data_guard_association
(database_id, …)Updates the Data Guard association the specified database. update_database
(database_id, …)Update the specified database based on the request parameters provided. update_database_software_image
(…)Updates the properties of a Database Software Image, like Display Nmae update_db_home
(db_home_id, …)Patches the specified Database Home. update_db_node
(db_node_id, …)Updates the specified database node. update_db_system
(db_system_id, …)Updates the properties of the specified DB system. update_exadata_infrastructure
(…)Updates the Exadata infrastructure resource. update_exadata_iorm_config
(db_system_id, …)Updates IORM settings for the specified Exadata DB system. update_exadb_vm_cluster
(exadb_vm_cluster_id, …)Updates the specified Exadata VM cluster on Exascale Infrastructure. update_exascale_db_storage_vault
(…)Updates the specified Exadata Database Storage Vault. update_execution_action
(execution_action_id, …)Updates the execution action resource. update_execution_window
(execution_window_id, …)Updates the execution window resource. update_external_container_database
(…)Updates the properties of an create_external_container_database_details()
resource, such as the display name.update_external_database_connector
(…)Updates the properties of an external database connector, such as the display name. update_external_non_container_database
(…)Updates the properties of an external non-container database, such as the display name. update_external_pluggable_database
(…)Updates the properties of an create_external_pluggable_database_details()
resource, such as the display name.update_key_store
(key_store_id, …)Edit the key store. update_maintenance_run
(maintenance_run_id, …)Updates the properties of a maintenance run, such as the state of a maintenance run. update_oneoff_patch
(oneoff_patch_id, …)Updates the properties of the specified one-off patch. update_pluggable_database
(…)Updates the specified pluggable database. update_scheduled_action
(scheduled_action_id, …)Updates the Scheduled Action resource. update_scheduling_policy
(…)Updates the Scheduling Policy resource. update_scheduling_window
(…)Updates the Scheduling Window resource. update_vm_cluster
(vm_cluster_id, …)Updates the specified VM cluster. update_vm_cluster_network
(…)Updates the specified VM cluster network. upgrade_database
(database_id, …)Upgrades the specified Oracle Database instance. upgrade_db_system
(db_system_id, …)Upgrades the operating system and grid infrastructure of the DB system. validate_vm_cluster_network
(…)Validates the specified VM cluster network. -
__init__
(config, **kwargs)¶ Creates a new service client
Parameters: - config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
from_file()
method can be used to load configuration from a file. Alternatively, adict
can be passed. You can validate_config the dict usingvalidate_config()
- service_endpoint (str) – (optional)
The endpoint of the service to call using this client. For example
https://iaas.us-ashburn-1.oraclecloud.com
. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint. - timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
- signer (
AbstractBaseSigner
) –(optional) The signer to use when signing requests made by the service client. The default is to use a
Signer
based on the values provided in the config parameter.One use case for this parameter is for Instance Principals authentication by passing an instance of
InstancePrincipalsSecurityTokenSigner
as the value for this keyword argument - retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a
retry_strategy
keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.This should be one of the strategies available in the
retry
module. A convenienceDEFAULT_RETRY_STRATEGY
is also available. The specifics of the default retry strategy are described here. - circuit_breaker_strategy (obj) – (optional)
A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level).
This client uses
DEFAULT_CIRCUIT_BREAKER_STRATEGY
as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here. - circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
- client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
- allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
-
activate_exadata_infrastructure
(exadata_infrastructure_id, activate_exadata_infrastructure_details, **kwargs)¶ Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- activate_exadata_infrastructure_details (oci.database.models.ActivateExadataInfrastructureDetails) – (required) The activation details for the Exadata infrastructure and the additional storage servers requested.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExadataInfrastructure
Return type: Example: Click here to see an example of how to use activate_exadata_infrastructure API.
- exadata_infrastructure_id (str) –
-
add_storage_capacity_cloud_exadata_infrastructure
(cloud_exadata_infrastructure_id, **kwargs)¶ Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
Parameters: - cloud_exadata_infrastructure_id (str) –
(required) The cloud Exadata infrastructure `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudExadataInfrastructure
Return type: Example: Click here to see an example of how to use add_storage_capacity_cloud_exadata_infrastructure API.
- cloud_exadata_infrastructure_id (str) –
-
add_storage_capacity_exadata_infrastructure
(exadata_infrastructure_id, **kwargs)¶ Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExadataInfrastructure
Return type: Example: Click here to see an example of how to use add_storage_capacity_exadata_infrastructure API.
- exadata_infrastructure_id (str) –
-
add_virtual_machine_to_cloud_vm_cluster
(add_virtual_machine_to_cloud_vm_cluster_details, cloud_vm_cluster_id, **kwargs)¶ Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.
Parameters: - add_virtual_machine_to_cloud_vm_cluster_details (oci.database.models.AddVirtualMachineToCloudVmClusterDetails) – (required) Request to add Virtual Machines to the Cloud VM cluster.
- cloud_vm_cluster_id (str) –
(required) The cloud VM cluster `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudVmCluster
Return type: Example: Click here to see an example of how to use add_virtual_machine_to_cloud_vm_cluster API.
-
add_virtual_machine_to_vm_cluster
(add_virtual_machine_to_vm_cluster_details, vm_cluster_id, **kwargs)¶ Add Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only.
Parameters: - add_virtual_machine_to_vm_cluster_details (oci.database.models.AddVirtualMachineToVmClusterDetails) – (required) Request to add Virtual Machines to the VM cluster.
- vm_cluster_id (str) –
(required) The VM cluster `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use add_virtual_machine_to_vm_cluster API.
-
autonomous_database_manual_refresh
(autonomous_database_id, autonomous_database_manual_refresh_details, **kwargs)¶ Initiates a data refresh for an Autonomous Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- autonomous_database_manual_refresh_details (oci.database.models.AutonomousDatabaseManualRefreshDetails) – (required) Request details for manually refreshing an Autonomous Database refreshable clone.
- if_match (str) – (optional) 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.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabase
Return type: Example: Click here to see an example of how to use autonomous_database_manual_refresh API.
- autonomous_database_id (str) –
-
cancel_backup
(backup_id, **kwargs)¶ Cancel automatic/standalone full/incremental create backup workrequests specified by the backup Id.
Parameters: - backup_id (str) –
(required) The backup `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use cancel_backup API.
- backup_id (str) –
-
cancel_execution_window
(execution_window_id, cancel_execution_window_details, **kwargs)¶ Cancels the in progress maintenance activity under this execution window.
Parameters: - execution_window_id (str) –
(required) The execution window `OCID`__.
- cancel_execution_window_details (oci.database.models.CancelExecutionWindowDetails) – (required) Request to cancel the in progress maintenance activity under this execution window.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExecutionWindow
Return type: Example: Click here to see an example of how to use cancel_execution_window API.
- execution_window_id (str) –
-
cascading_delete_scheduling_plan
(scheduling_plan_id, **kwargs)¶ Delete the scheduling plan resource along with all the scheduled actions associated with this resource.
Parameters: - scheduling_plan_id (str) –
(required) The Schedule Plan `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use cascading_delete_scheduling_plan API.
- scheduling_plan_id (str) –
-
change_autonomous_container_database_compartment
(change_compartment_details, autonomous_container_database_id, **kwargs)¶ Move the Autonomous Container Database and its dependent resources to the specified compartment. For more information about moving Autonomous Container Databases, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move Autonomous Container Database to a different compartment
- autonomous_container_database_id (str) –
(required) The Autonomous Container Database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_autonomous_container_database_compartment API.
-
change_autonomous_database_compartment
(change_compartment_details, autonomous_database_id, **kwargs)¶ Move the Autonomous Database and its dependent resources to the specified compartment. For more information about moving Autonomous Databases, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move Autonomous Database to a different compartment
- autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_autonomous_database_compartment API.
-
change_autonomous_database_software_image_compartment
(change_autonomous_database_software_image_compartment_details, autonomous_database_software_image_id, **kwargs)¶ Move the Autonomous Database Software Image and its dependent resources to the specified compartment.
Parameters: - change_autonomous_database_software_image_compartment_details (oci.database.models.ChangeAutonomousDatabaseSoftwareImageCompartmentDetails) – (required) Request to move Autonomous Database Software Image to a different compartment
- autonomous_database_software_image_id (str) –
(required) The Autonomous Database Software Image `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_autonomous_database_software_image_compartment API.
-
change_autonomous_database_subscription
(change_autonomous_database_subscription_details, autonomous_database_id, **kwargs)¶ Associate an Autonomous Database with a different subscription.
Parameters: - change_autonomous_database_subscription_details (oci.database.models.ChangeAutonomousDatabaseSubscriptionDetails) – (required) Associate an Autonomous Database with a different subscription.
- autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_autonomous_database_subscription API.
-
change_autonomous_exadata_infrastructure_compartment
(change_compartment_details, autonomous_exadata_infrastructure_id, **kwargs)¶ Deprecated. Use the
change_cloud_exadata_infrastructure_compartment()
operation to move an Exadata infrastructure resource to a different compartment andchange_cloud_autonomous_vm_cluster_compartment()
operation to move an Autonomous Exadata VM cluster to a different compartment. For more information, see `Moving Database Resources to a Different Compartment`__.Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move an Autonomous Exadata Infrastructure resource to a different compartment.
- autonomous_exadata_infrastructure_id (str) –
(required) The Autonomous Exadata Infrastructure `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_autonomous_exadata_infrastructure_compartment API.
-
change_autonomous_vm_cluster_compartment
(change_autonomous_vm_cluster_compartment_details, autonomous_vm_cluster_id, **kwargs)¶ Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see
change_autonomous_vm_cluster_compartment()
.Parameters: - change_autonomous_vm_cluster_compartment_details (oci.database.models.ChangeAutonomousVmClusterCompartmentDetails) – (required) Request to move Autonomous VM cluster to a different compartment
- autonomous_vm_cluster_id (str) –
(required) The autonomous VM cluster `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_autonomous_vm_cluster_compartment API.
-
change_backup_destination_compartment
(change_compartment_details, backup_destination_id, **kwargs)¶ Move the backup destination and its dependent resources to the specified compartment. For more information, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move backup destination to a different compartment.
- backup_destination_id (str) –
(required) The `OCID`__ of the backup destination.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_backup_destination_compartment API.
-
change_cloud_autonomous_vm_cluster_compartment
(change_cloud_autonomous_vm_cluster_compartment_details, cloud_autonomous_vm_cluster_id, **kwargs)¶ Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see
change_autonomous_vm_cluster_compartment()
.Parameters: - change_cloud_autonomous_vm_cluster_compartment_details (oci.database.models.ChangeCloudAutonomousVmClusterCompartmentDetails) – (required) Request to move cloud Autonomous VM cluster to a different compartment
- cloud_autonomous_vm_cluster_id (str) –
(required) The Cloud VM cluster `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_cloud_autonomous_vm_cluster_compartment API.
-
change_cloud_exadata_infrastructure_compartment
(change_cloud_exadata_infrastructure_compartment_details, cloud_exadata_infrastructure_id, **kwargs)¶ Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.For more information about moving resources to a different compartment, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_cloud_exadata_infrastructure_compartment_details (oci.database.models.ChangeCloudExadataInfrastructureCompartmentDetails) – (required) Request to move cloud Exadata infrastructure resource to a different compartment.
- cloud_exadata_infrastructure_id (str) –
(required) The cloud Exadata infrastructure `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_cloud_exadata_infrastructure_compartment API.
-
change_cloud_exadata_infrastructure_subscription
(change_cloud_exadata_infrastructure_subscription_details, cloud_exadata_infrastructure_id, **kwargs)¶ Associate a cloud Exadata infrastructure with a different subscription.
Parameters: - change_cloud_exadata_infrastructure_subscription_details (oci.database.models.ChangeCloudExadataInfrastructureSubscriptionDetails) – (required) Associate a cloud Exadata infrastructure with a different subscription.
- cloud_exadata_infrastructure_id (str) –
(required) The cloud Exadata infrastructure `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_cloud_exadata_infrastructure_subscription API.
-
change_cloud_vm_cluster_compartment
(change_cloud_vm_cluster_compartment_details, cloud_vm_cluster_id, **kwargs)¶ Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
Parameters: - change_cloud_vm_cluster_compartment_details (oci.database.models.ChangeCloudVmClusterCompartmentDetails) – (required) Request to move cloud VM cluster to a different compartment
- cloud_vm_cluster_id (str) –
(required) The cloud VM cluster `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_cloud_vm_cluster_compartment API.
-
change_cloud_vm_cluster_subscription
(change_cloud_vm_cluster_subscription_details, cloud_vm_cluster_id, **kwargs)¶ Associate a cloud VM cluster with a different subscription.
Parameters: - change_cloud_vm_cluster_subscription_details (oci.database.models.ChangeCloudVmClusterSubscriptionDetails) – (required) Associate a cloud VM cluster with a different subscription.
- cloud_vm_cluster_id (str) –
(required) The cloud VM cluster `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_cloud_vm_cluster_subscription API.
-
change_database_software_image_compartment
(change_compartment_details, database_software_image_id, **kwargs)¶ Move the Database Software Image and its dependent resources to the specified compartment. For more information about moving Databse Software Images, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move Database Software Image to a different compartment
- database_software_image_id (str) –
(required) The DB system `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_database_software_image_compartment API.
-
change_dataguard_role
(change_dataguard_role_details, autonomous_container_database_id, **kwargs)¶ Switch the Autonomous Container Database role between Standby and Snapshot Standby. For more information about changing Autonomous Container Databases Dataguard Role, see `Convert Physical Standby to Snapshot Standby`__ and `Convert Snapshot Standby to Physical Standby`__.
Parameters: - change_dataguard_role_details (oci.database.models.ChangeDataguardRoleDetails) – (required) Request to Change the Autonomous Container Database Dataguard role.
- autonomous_container_database_id (str) –
(required) The Autonomous Container Database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousContainerDatabase
Return type: Example: Click here to see an example of how to use change_dataguard_role API.
-
change_db_system_compartment
(change_compartment_details, db_system_id, **kwargs)¶ Moves the DB system and its dependent resources to the specified compartment. For more information about moving DB systems, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) –
(required) Request to move the DB system to a different compartment.
Note: Deprecated for Exadata Cloud Service systems. Use the `new resource model APIs`__ instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See `Switching an Exadata DB System to the New Resource Model and APIs`__ for details on converting existing Exadata DB systems to the new resource model.
- db_system_id (str) –
(required) The DB system `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_db_system_compartment API.
- change_compartment_details (oci.database.models.ChangeCompartmentDetails) –
-
change_disaster_recovery_configuration
(autonomous_database_id, change_disaster_recovery_configuration_details, **kwargs)¶ This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database, and must be run on the standby side.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- change_disaster_recovery_configuration_details (oci.database.models.ChangeDisasterRecoveryConfigurationDetails) – (required) Request to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabase
Return type: Example: Click here to see an example of how to use change_disaster_recovery_configuration API.
- autonomous_database_id (str) –
-
change_encryption_key_location
(database_id, encryption_key_location_details, **kwargs)¶ Update the encryption key management location for the database
Parameters: - database_id (str) –
(required) The database `OCID`__.
- encryption_key_location_details (oci.database.models.EncryptionKeyLocationDetails) – (required) Request to change the source of the encryption key for the database.
- if_match (str) – (optional) 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.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_encryption_key_location API.
- database_id (str) –
-
change_exadata_infrastructure_compartment
(change_exadata_infrastructure_compartment_details, exadata_infrastructure_id, **kwargs)¶ Moves an Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move an Exadata Cloud Service infrastructure resource to another compartment, use the
change_cloud_exadata_infrastructure_compartment()
operation.Parameters: - change_exadata_infrastructure_compartment_details (oci.database.models.ChangeExadataInfrastructureCompartmentDetails) – (required) Request to move Exadata infrastructure to a different compartment
- exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_exadata_infrastructure_compartment API.
-
change_exadb_vm_cluster_compartment
(change_exadb_vm_cluster_compartment_details, exadb_vm_cluster_id, **kwargs)¶ Moves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only.
Parameters: - change_exadb_vm_cluster_compartment_details (oci.database.models.ChangeExadbVmClusterCompartmentDetails) – (required) Request to move Exadata VM cluster on Exascale Infrastructure to a different compartment
- exadb_vm_cluster_id (str) –
(required) The Exadata VM cluster `OCID`__ on Exascale Infrastructure.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_exadb_vm_cluster_compartment API.
-
change_exascale_db_storage_vault_compartment
(change_exascale_db_storage_vault_compartment_details, exascale_db_storage_vault_id, **kwargs)¶ Moves a Exadata Database Storage Vault to another compartment.
Parameters: - change_exascale_db_storage_vault_compartment_details (oci.database.models.ChangeExascaleDbStorageVaultCompartmentDetails) – (required) Request to move Exadata Database Storage Vault to a different compartment
- exascale_db_storage_vault_id (str) –
(required) The Exadata Database Storage Vault `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_exascale_db_storage_vault_compartment API.
-
change_external_container_database_compartment
(change_compartment_details, external_container_database_id, **kwargs)¶ Move the
create_external_container_database_details()
and its dependent resources to the specified compartment. For more information about moving external container databases, see `Moving Database Resources to a Different Compartment`__.Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move the external container database to a different compartment.
- external_container_database_id (str) –
(required) The ExternalContainerDatabase `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_external_container_database_compartment API.
-
change_external_non_container_database_compartment
(change_compartment_details, external_non_container_database_id, **kwargs)¶ Move the external non-container database and its dependent resources to the specified compartment. For more information about moving external non-container databases, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move the external non-container database to a different compartment.
- external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_external_non_container_database_compartment API.
-
change_external_pluggable_database_compartment
(change_compartment_details, external_pluggable_database_id, **kwargs)¶ Move the
create_external_pluggable_database_details()
and its dependent resources to the specified compartment. For more information about moving external pluggable databases, see `Moving Database Resources to a Different Compartment`__.Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required)
Request to move the
create_external_pluggable_database_details()
resource to a different compartment. - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_external_pluggable_database_compartment API.
- change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required)
Request to move the
-
change_key_store_compartment
(change_key_store_compartment_details, key_store_id, **kwargs)¶ Move the key store resource to the specified compartment. For more information about moving key stores, see `Moving Database Resources to a Different Compartment`__.
Parameters: - change_key_store_compartment_details (oci.database.models.ChangeKeyStoreCompartmentDetails) – (required) Request to move key store to a different compartment
- key_store_id (str) –
(required) The `OCID`__ of the key store.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_key_store_compartment API.
-
change_key_store_type
(database_id, change_key_store_type_details, **kwargs)¶ Changes encryption key management type
Parameters: - database_id (str) –
(required) The database `OCID`__.
- change_key_store_type_details (oci.database.models.ChangeKeyStoreTypeDetails) – (required) Request to change the source of the encryption key for the database.
- if_match (str) – (optional) 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.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_key_store_type API.
- database_id (str) –
-
change_oneoff_patch_compartment
(change_compartment_details, oneoff_patch_id, **kwargs)¶ Move the one-off patch to the specified compartment.
Parameters: - change_compartment_details (oci.database.models.ChangeCompartmentDetails) – (required) Request to move one-off patch to a different compartment
- oneoff_patch_id (str) –
(required) The one-off patch `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_oneoff_patch_compartment API.
-
change_scheduling_plan_compartment
(change_scheduling_plan_compartment_details, scheduling_plan_id, **kwargs)¶ Moves an scheduling plan resource to another compartment.
Parameters: - change_scheduling_plan_compartment_details (oci.database.models.ChangeSchedulingPlanCompartmentDetails) – (required) Request to move scheduling plan to a different compartment
- scheduling_plan_id (str) –
(required) The Schedule Plan `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_scheduling_plan_compartment API.
-
change_scheduling_policy_compartment
(change_scheduling_policy_compartment_details, scheduling_policy_id, **kwargs)¶ Moves an scheduling policy resource to another compartment.
Parameters: - change_scheduling_policy_compartment_details (oci.database.models.ChangeSchedulingPolicyCompartmentDetails) – (required) Request to move scheduling policy to a different compartment
- scheduling_policy_id (str) –
(required) The Scheduling Policy `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_scheduling_policy_compartment API.
-
change_vm_cluster_compartment
(change_vm_cluster_compartment_details, vm_cluster_id, **kwargs)¶ Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the
change_cloud_vm_cluster_compartment()
operation.Parameters: - change_vm_cluster_compartment_details (oci.database.models.ChangeVmClusterCompartmentDetails) – (required) Request to move the Exadata Cloud@Customer VM cluster to a different compartment.
- vm_cluster_id (str) –
(required) The VM cluster `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use change_vm_cluster_compartment API.
-
check_external_database_connector_connection_status
(external_database_connector_id, **kwargs)¶ Check the status of the external database connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.
Parameters: - external_database_connector_id (str) –
(required) The `OCID`__ of the external database connector resource (ExternalDatabaseConnectorId).
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use check_external_database_connector_connection_status API.
- external_database_connector_id (str) –
-
complete_external_backup_job
(backup_id, complete_external_backup_job_details, **kwargs)¶ Changes the status of the standalone backup resource to ACTIVE after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage.
Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See `Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud`__ for more information.
Parameters: - backup_id (str) –
(required) The backup `OCID`__.
- complete_external_backup_job_details (oci.database.models.CompleteExternalBackupJobDetails) – (required) Updates the status of the backup resource.
- if_match (str) – (optional) 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.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExternalBackupJob
Return type: Example: Click here to see an example of how to use complete_external_backup_job API.
- backup_id (str) –
-
configure_autonomous_database_vault_key
(autonomous_database_id, configure_autonomous_database_vault_key_details, **kwargs)¶ Configures the Autonomous Database Vault service `key`__.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- configure_autonomous_database_vault_key_details (oci.database.models.ConfigureAutonomousDatabaseVaultKeyDetails) –
(required) Configuration details for the Autonomous Database Vault service `key`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use configure_autonomous_database_vault_key API.
- autonomous_database_id (str) –
-
configure_exascale_exadata_infrastructure
(exadata_infrastructure_id, configure_exascale_exadata_infrastructure_details, **kwargs)¶ Configures Exascale on Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- configure_exascale_exadata_infrastructure_details (oci.database.models.ConfigureExascaleExadataInfrastructureDetails) – (required) The exascale config details for the Exadata infrastructure with the total storage needed.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExadataInfrastructure
Return type: Example: Click here to see an example of how to use configure_exascale_exadata_infrastructure API.
- exadata_infrastructure_id (str) –
-
configure_saas_admin_user
(autonomous_database_id, configure_saas_admin_user_details, **kwargs)¶ This operation updates SaaS administrative user configuration of the Autonomous Database.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- configure_saas_admin_user_details (oci.database.models.ConfigureSaasAdminUserDetails) – (required) Request to update SaaS administrative user configuration of the Autonomous Database.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabase
Return type: Example: Click here to see an example of how to use configure_saas_admin_user API.
- autonomous_database_id (str) –
-
confirm_key_store_details_are_correct
(key_store_id, **kwargs)¶ This is for user to confirm to DBaaS that the Oracle Key Valut (OKV) connection IPs, username and password are all correct. This operation will put the Key Store back into Active state. If details are incorrect, your OKV account may get locked after some unsuccessful attempts to connect.
Parameters: - key_store_id (str) –
(required) The `OCID`__ of the key store.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use confirm_key_store_details_are_correct API.
- key_store_id (str) –
-
convert_to_pdb
(database_id, convert_to_pdb_details, **kwargs)¶ Converts a non-container database to a pluggable database.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- convert_to_pdb_details (oci.database.models.ConvertToPdbDetails) – (required) Request to convert a non-container database to a pluggable database.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use convert_to_pdb API.
- database_id (str) –
-
convert_to_regular_pluggable_database
(convert_to_regular_pluggable_database_details, pluggable_database_id, **kwargs)¶ Converts a Refreshable clone to Regular pluggable database (PDB). Pluggable Database will be in READ_WRITE openmode after conversion.
Parameters: - convert_to_regular_pluggable_database_details (oci.database.models.ConvertToRegularPluggableDatabaseDetails) – (required) Request to convert a Refreshable clone pluggable database (PDB) to a Regular pluggable database.
- pluggable_database_id (str) –
(required) The database `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typePluggableDatabase
Return type: Example: Click here to see an example of how to use convert_to_regular_pluggable_database API.
-
convert_to_standalone
(database_id, convert_to_standalone_details, **kwargs)¶ Disassociate the standby database identified by the databaseId parameter from existing Data Guard group.
Convert the standby to a standalone database.
This operation should be performed on respective standby database.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- convert_to_standalone_details (oci.database.models.ConvertToStandaloneDetails) – (required) A request to update an existing Data Guard member.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use convert_to_standalone API.
- database_id (str) –
-
create_application_vip
(create_application_vip_details, **kwargs)¶ Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.
Parameters: - create_application_vip_details (oci.database.models.CreateApplicationVipDetails) – (required) Request to create a new application virtual IP (VIP) address.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeApplicationVip
Return type: Example: Click here to see an example of how to use create_application_vip API.
-
create_autonomous_container_database
(create_autonomous_container_database_details, **kwargs)¶ Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.
Parameters: - create_autonomous_container_database_details (oci.database.models.CreateAutonomousContainerDatabaseDetails) – (required) Request to create an Autonomous Container Database in a specified Autonomous Exadata Infrastructure or in Autonomous VM Cluster.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousContainerDatabase
Return type: Example: Click here to see an example of how to use create_autonomous_container_database API.
-
create_autonomous_container_database_dataguard_association
(autonomous_container_database_id, create_autonomous_container_database_dataguard_association_details, **kwargs)¶ Create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the specified Autonomous Container database and a peer Autonomous Container database. For more information, see `Using Oracle Data Guard`__.
All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see `Resource Identifiers`__.
Parameters: - autonomous_container_database_id (str) –
(required) The Autonomous Container Database `OCID`__.
- create_autonomous_container_database_dataguard_association_details (oci.database.models.CreateAutonomousContainerDatabaseDataguardAssociationDetails) – (required) A request to create an Autonomous Data Guard association.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousContainerDatabaseDataguardAssociation
Return type: Example: Click here to see an example of how to use create_autonomous_container_database_dataguard_association API.
- autonomous_container_database_id (str) –
-
create_autonomous_database
(create_autonomous_database_details, **kwargs)¶ Creates a new Autonomous Database.
Parameters: - create_autonomous_database_details (oci.database.models.CreateAutonomousDatabaseBase) – (required) Request to create a new Autonomous Database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabase
Return type: Example: Click here to see an example of how to use create_autonomous_database API.
-
create_autonomous_database_backup
(create_autonomous_database_backup_details, **kwargs)¶ Creates a new Autonomous Database backup for the specified database based on the provided request parameters.
Parameters: - create_autonomous_database_backup_details (oci.database.models.CreateAutonomousDatabaseBackupDetails) – (required) Request to create a new Autonomous Database backup.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabaseBackup
Return type: Example: Click here to see an example of how to use create_autonomous_database_backup API.
-
create_autonomous_database_software_image
(create_autonomous_database_software_image_details, **kwargs)¶ create Autonomous Database Software Image in the specified compartment.
Parameters: - create_autonomous_database_software_image_details (oci.database.models.CreateAutonomousDatabaseSoftwareImageDetails) – (required) Request to create Autonomous Database Software Image.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabaseSoftwareImage
Return type: Example: Click here to see an example of how to use create_autonomous_database_software_image API.
-
create_autonomous_vm_cluster
(create_autonomous_vm_cluster_details, **kwargs)¶ Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see
create_cloud_autonomous_vm_cluster()
.Parameters: - create_autonomous_vm_cluster_details (oci.database.models.CreateAutonomousVmClusterDetails) – (required) Request to create an Autonomous VM cluster.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousVmCluster
Return type: Example: Click here to see an example of how to use create_autonomous_vm_cluster API.
-
create_backup
(create_backup_details, **kwargs)¶ Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
Parameters: - create_backup_details (oci.database.models.CreateBackupDetails) – (required) Request to create a new database backup.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_backup API.
-
create_backup_destination
(create_backup_destination_details, **kwargs)¶ Creates a backup destination in an Exadata Cloud@Customer system.
Parameters: - create_backup_destination_details (oci.database.models.CreateBackupDestinationDetails) – (required) Request to create a new backup destination.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeBackupDestination
Return type: Example: Click here to see an example of how to use create_backup_destination API.
-
create_cloud_autonomous_vm_cluster
(create_cloud_autonomous_vm_cluster_details, **kwargs)¶ Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see
create_autonomous_vm_cluster()
.Parameters: - create_cloud_autonomous_vm_cluster_details (oci.database.models.CreateCloudAutonomousVmClusterDetails) – (required) Request to create a cloud Autonomous VM cluster.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudAutonomousVmCluster
Return type: Example: Click here to see an example of how to use create_cloud_autonomous_vm_cluster API.
-
create_cloud_exadata_infrastructure
(create_cloud_exadata_infrastructure_details, **kwargs)¶ Creates a cloud Exadata infrastructure resource. This resource is used to create either an `Exadata Cloud Service`__ instance or an Autonomous Database on dedicated Exadata infrastructure.
Parameters: - create_cloud_exadata_infrastructure_details (oci.database.models.CreateCloudExadataInfrastructureDetails) –
(required) Request to create a cloud Exadata infrastructure resource in an `Exadata Cloud Service`__ instance.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudExadataInfrastructure
Return type: Example: Click here to see an example of how to use create_cloud_exadata_infrastructure API.
- create_cloud_exadata_infrastructure_details (oci.database.models.CreateCloudExadataInfrastructureDetails) –
-
create_cloud_vm_cluster
(create_cloud_vm_cluster_details, **kwargs)¶ Creates a cloud VM cluster.
Parameters: - create_cloud_vm_cluster_details (oci.database.models.CreateCloudVmClusterDetails) –
(required) Request to create a cloud VM cluster. Applies to Exadata Cloud Service instances only. See `The New Exadata Cloud Service Resource Model`__ for information on this resource type.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudVmCluster
Return type: Example: Click here to see an example of how to use create_cloud_vm_cluster API.
- create_cloud_vm_cluster_details (oci.database.models.CreateCloudVmClusterDetails) –
-
create_console_connection
(create_console_connection_details, db_node_id, **kwargs)¶ Creates a new console connection to the specified database node. After the console connection has been created and is available, you connect to the console using SSH.
Parameters: - create_console_connection_details (oci.database.models.CreateConsoleConnectionDetails) – (required) Request object for creating an CreateConsoleConnection
- db_node_id (str) –
(required) The database node `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeConsoleConnection
Return type: Example: Click here to see an example of how to use create_console_connection API.
-
create_console_history
(create_console_history_details, db_node_id, **kwargs)¶ Captures the most recent serial console data (up to a megabyte) for the specified database node.
Parameters: - create_console_history_details (oci.database.models.CreateConsoleHistoryDetails) – (required) Request object for creating a console history.
- db_node_id (str) –
(required) The database node `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeConsoleHistory
Return type: Example: Click here to see an example of how to use create_console_history API.
-
create_data_guard_association
(database_id, create_data_guard_association_details, **kwargs)¶ Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see `Using Oracle Data Guard`__.
All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see `Resource Identifiers`__.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- create_data_guard_association_details (oci.database.models.CreateDataGuardAssociationDetails) – (required) A request to create a Data Guard association.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDataGuardAssociation
Return type: Example: Click here to see an example of how to use create_data_guard_association API.
- database_id (str) –
-
create_database
(create_new_database_details, **kwargs)¶ Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems.
Parameters: - create_new_database_details (oci.database.models.CreateDatabaseBase) – (required) Request to create a new database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_database API.
-
create_database_software_image
(create_database_software_image_details, **kwargs)¶ create database software image in the specified compartment.
Parameters: - create_database_software_image_details (oci.database.models.CreateDatabaseSoftwareImageDetails) – (required) Request to create database software image.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDatabaseSoftwareImage
Return type: Example: Click here to see an example of how to use create_database_software_image API.
-
create_db_home
(create_db_home_with_db_system_id_details, **kwargs)¶ Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems.
Parameters: - create_db_home_with_db_system_id_details (oci.database.models.CreateDbHomeBase) – (required) Request to create a new Database Home.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_db_home API.
-
create_exadata_infrastructure
(create_exadata_infrastructure_details, **kwargs)¶ Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To create an Exadata Cloud Service infrastructure resource, use the
create_cloud_exadata_infrastructure()
operation.Parameters: - create_exadata_infrastructure_details (oci.database.models.CreateExadataInfrastructureDetails) – (required) Request to create Exadata Cloud@Customer infrastructure.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExadataInfrastructure
Return type: Example: Click here to see an example of how to use create_exadata_infrastructure API.
-
create_exadb_vm_cluster
(create_exadb_vm_cluster_details, **kwargs)¶ Creates an Exadata VM cluster on Exascale Infrastructure
Parameters: - create_exadb_vm_cluster_details (oci.database.models.CreateExadbVmClusterDetails) –
(required) Request to create a Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only. See `The New Exadata Cloud Service Resource Model`__ for information on this resource type.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExadbVmCluster
Return type: Example: Click here to see an example of how to use create_exadb_vm_cluster API.
- create_exadb_vm_cluster_details (oci.database.models.CreateExadbVmClusterDetails) –
-
create_exascale_db_storage_vault
(create_exascale_db_storage_vault_details, **kwargs)¶ Creates an Exadata Database Storage Vault
Parameters: - create_exascale_db_storage_vault_details (oci.database.models.CreateExascaleDbStorageVaultDetails) – (required) Request to create a Exadata Database Storage Vault.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExascaleDbStorageVault
Return type: Example: Click here to see an example of how to use create_exascale_db_storage_vault API.
-
create_execution_action
(create_execution_action_details, **kwargs)¶ Creates an execution action resource.
Parameters: - create_execution_action_details (oci.database.models.CreateExecutionActionDetails) – (required) Request to create execution action.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExecutionAction
Return type: Example: Click here to see an example of how to use create_execution_action API.
-
create_execution_window
(create_execution_window_details, **kwargs)¶ Creates an execution window resource.
Parameters: - create_execution_window_details (oci.database.models.CreateExecutionWindowDetails) – (required) Request to create execution window.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExecutionWindow
Return type: Example: Click here to see an example of how to use create_execution_window API.
-
create_external_backup_job
(create_external_backup_job_details, **kwargs)¶ Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.
Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See `Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud`__ for more information.
Parameters: - create_external_backup_job_details (oci.database.models.CreateExternalBackupJobDetails) – (required) Request to create a cloud backup resource for a database running outside the cloud.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExternalBackupJob
Return type: Example: Click here to see an example of how to use create_external_backup_job API.
-
create_external_container_database
(create_external_container_database_details, **kwargs)¶ Creates a new external container database resource.
Parameters: - create_external_container_database_details (oci.database.models.CreateExternalContainerDatabaseDetails) – (required) Request to create a new external container database resource.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExternalContainerDatabase
Return type: Example: Click here to see an example of how to use create_external_container_database API.
-
create_external_database_connector
(create_external_database_connector_details, **kwargs)¶ Creates a new external database connector.
Parameters: - create_external_database_connector_details (oci.database.models.CreateExternalDatabaseConnectorDetails) – (required) Request to create a connector to an external database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExternalDatabaseConnector
Return type: Example: Click here to see an example of how to use create_external_database_connector API.
-
create_external_non_container_database
(create_external_non_container_database_details, **kwargs)¶ Creates a new ExternalNonContainerDatabase resource
Parameters: - create_external_non_container_database_details (oci.database.models.CreateExternalNonContainerDatabaseDetails) – (required) Request to create a new external non-container database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExternalNonContainerDatabase
Return type: Example: Click here to see an example of how to use create_external_non_container_database API.
-
create_external_pluggable_database
(create_external_pluggable_database_details, **kwargs)¶ Registers a new
create_external_pluggable_database_details()
resource.Parameters: - create_external_pluggable_database_details (oci.database.models.CreateExternalPluggableDatabaseDetails) – (required) Request to create a new external pluggable database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeExternalPluggableDatabase
Return type: Example: Click here to see an example of how to use create_external_pluggable_database API.
-
create_key_store
(create_key_store_details, **kwargs)¶ Creates a Key Store.
Parameters: - create_key_store_details (oci.database.models.CreateKeyStoreDetails) – (required) Request to create a new key store.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_key_store API.
-
create_maintenance_run
(create_maintenance_run_details, **kwargs)¶ Creates a maintenance run with one of the following: 1. The latest available release update patch (RUP) for the Autonomous Container Database. 2. The latest available RUP and DST time-zone (TZ) file updates for the Autonomous Container Database. 3. The DST TZ file updates for the Autonomous Container Database.
Parameters: - create_maintenance_run_details (oci.database.models.CreateMaintenanceRunDetails) – (required) Request to create a Maintenance Run for the resource.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeMaintenanceRun
Return type: Example: Click here to see an example of how to use create_maintenance_run API.
-
create_oneoff_patch
(create_oneoff_patch_details, **kwargs)¶ Creates one-off patch for specified database version to download.
Parameters: - create_oneoff_patch_details (oci.database.models.CreateOneoffPatchDetails) – (required) Request to create a one-off patch to download.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeOneoffPatch
Return type: Example: Click here to see an example of how to use create_oneoff_patch API.
-
create_pluggable_database
(create_pluggable_database_details, **kwargs)¶ Creates and starts a pluggable database in the specified container database. Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. Use the
start_pluggable_database()
andstop_pluggable_database()
APIs to start and stop the pluggable database.Parameters: - create_pluggable_database_details (oci.database.models.CreatePluggableDatabaseDetails) – (required) Request to create pluggable database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typePluggableDatabase
Return type: Example: Click here to see an example of how to use create_pluggable_database API.
-
create_scheduled_action
(create_scheduled_action_details, **kwargs)¶ Creates a Scheduled Action resource.
Parameters: - create_scheduled_action_details (oci.database.models.CreateScheduledActionDetails) – (required) Request to create Scheduled Action.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeScheduledAction
Return type: Example: Click here to see an example of how to use create_scheduled_action API.
-
create_scheduling_plan
(create_scheduling_plan_details, **kwargs)¶ Creates a Scheduling Plan resource.
Parameters: - create_scheduling_plan_details (oci.database.models.CreateSchedulingPlanDetails) – (required) Request to create Scheduling Plan.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeSchedulingPlan
Return type: Example: Click here to see an example of how to use create_scheduling_plan API.
-
create_scheduling_policy
(create_scheduling_policy_details, **kwargs)¶ Creates a Scheduling Policy resource.
Parameters: - create_scheduling_policy_details (oci.database.models.CreateSchedulingPolicyDetails) – (required) Request to create Scheduling Policy.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeSchedulingPolicy
Return type: Example: Click here to see an example of how to use create_scheduling_policy API.
-
create_scheduling_window
(scheduling_policy_id, create_scheduling_window_details, **kwargs)¶ Creates a Scheduling Window resource.
Parameters: - scheduling_policy_id (str) –
(required) The Scheduling Policy `OCID`__.
- create_scheduling_window_details (oci.database.models.CreateSchedulingWindowDetails) – (required) Request to create Scheduling Window.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeSchedulingWindow
Return type: Example: Click here to see an example of how to use create_scheduling_window API.
- scheduling_policy_id (str) –
-
create_vm_cluster
(create_vm_cluster_details, **kwargs)¶ Creates an Exadata Cloud@Customer VM cluster.
Parameters: - create_vm_cluster_details (oci.database.models.CreateVmClusterDetails) – (required)
Request to create a VM cluster. Applies to Exadata Cloud@Customer instances only.
See
create_cloud_vm_cluster_details()
for details on creating a cloud VM cluster in an Exadata Cloud Service instance. - opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use create_vm_cluster API.
- create_vm_cluster_details (oci.database.models.CreateVmClusterDetails) – (required)
Request to create a VM cluster. Applies to Exadata Cloud@Customer instances only.
See
-
create_vm_cluster_network
(exadata_infrastructure_id, vm_cluster_network_details, **kwargs)¶ Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a cloud VM cluster in an Exadata Cloud Service instance, use the
create_cloud_vm_cluster()
operation.Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- vm_cluster_network_details (oci.database.models.VmClusterNetworkDetails) – (required) Request to create the Cloud@Customer VM cluster network.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeVmClusterNetwork
Return type: Example: Click here to see an example of how to use create_vm_cluster_network API.
- exadata_infrastructure_id (str) –
-
db_node_action
(db_node_id, action, **kwargs)¶ Performs one of the following power actions on the specified DB node: - start - power on - stop - power off - softreset - ACPI shutdown and power on - reset - power off and power on
Note: Stopping a node affects billing differently, depending on the type of DB system: Bare metal and Exadata systems - The _stop_ state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system (
terminate_db_system()
) to remove its resources from billing and quotas. Virtual machine DB systems - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.Parameters: - db_node_id (str) –
(required) The database node `OCID`__.
- action (str) –
(required) The action to perform on the DB Node.
Allowed values are: “STOP”, “START”, “SOFTRESET”, “RESET”
- opc_retry_token (str) – (optional) 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 may be rejected).
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use db_node_action API.
- db_node_id (str) –
-
delete_application_vip
(application_vip_id, **kwargs)¶ Deletes and deregisters the specified application virtual IP (VIP) address.
Parameters: - application_vip_id (str) –
(required) The `OCID`__ of the application virtual IP (VIP) address.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_application_vip API.
- application_vip_id (str) –
-
delete_autonomous_database
(autonomous_database_id, **kwargs)¶ Deletes the specified Autonomous Database.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_autonomous_database API.
- autonomous_database_id (str) –
-
delete_autonomous_database_backup
(autonomous_database_backup_id, **kwargs)¶ Deletes a long-term backup. You cannot delete other backups using this API.
Parameters: - autonomous_database_backup_id (str) –
(required) The `OCID`__ of the Autonomous Database backup.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_autonomous_database_backup API.
- autonomous_database_backup_id (str) –
-
delete_autonomous_database_software_image
(autonomous_database_software_image_id, **kwargs)¶ Delete an Autonomous Database Software Image
Parameters: - autonomous_database_software_image_id (str) –
(required) The Autonomous Database Software Image `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_autonomous_database_software_image API.
- autonomous_database_software_image_id (str) –
-
delete_autonomous_vm_cluster
(autonomous_vm_cluster_id, **kwargs)¶ Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see
delete_cloud_autonomous_vm_cluster()
.Parameters: - autonomous_vm_cluster_id (str) –
(required) The autonomous VM cluster `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_autonomous_vm_cluster API.
- autonomous_vm_cluster_id (str) –
-
delete_backup
(backup_id, **kwargs)¶ Deletes a full backup. You cannot delete automatic backups using this API.
Parameters: - backup_id (str) –
(required) The backup `OCID`__.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_backup API.
- backup_id (str) –
-
delete_backup_destination
(backup_destination_id, **kwargs)¶ Deletes a backup destination in an Exadata Cloud@Customer system.
Parameters: - backup_destination_id (str) –
(required) The `OCID`__ of the backup destination.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_backup_destination API.
- backup_destination_id (str) –
-
delete_cloud_autonomous_vm_cluster
(cloud_autonomous_vm_cluster_id, **kwargs)¶ Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see
delete_autonomous_vm_cluster()
.Parameters: - cloud_autonomous_vm_cluster_id (str) –
(required) The Cloud VM cluster `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_cloud_autonomous_vm_cluster API.
- cloud_autonomous_vm_cluster_id (str) –
-
delete_cloud_exadata_infrastructure
(cloud_exadata_infrastructure_id, **kwargs)¶ Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
Parameters: - cloud_exadata_infrastructure_id (str) –
(required) The cloud Exadata infrastructure `OCID`__.
- if_match (str) – (optional) 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.
- is_delete_vm_clusters (bool) – (optional) If true, forces the deletion the specified cloud Exadata infrastructure resource as well as all associated VM clusters. If false, the cloud Exadata infrastructure resource can be deleted only if it has no associated VM clusters. Default value is false.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_cloud_exadata_infrastructure API.
- cloud_exadata_infrastructure_id (str) –
-
delete_cloud_vm_cluster
(cloud_vm_cluster_id, **kwargs)¶ Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
Parameters: - cloud_vm_cluster_id (str) –
(required) The cloud VM cluster `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_cloud_vm_cluster API.
- cloud_vm_cluster_id (str) –
-
delete_console_connection
(db_node_id, console_connection_id, **kwargs)¶ Deletes the specified database node console connection.
Parameters: - db_node_id (str) –
(required) The database node `OCID`__.
- console_connection_id (str) – (required) The OCID of the console connection.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_console_connection API.
- db_node_id (str) –
-
delete_console_history
(db_node_id, console_history_id, **kwargs)¶ Deletes the specified database node console history.
Parameters: - db_node_id (str) –
(required) The database node `OCID`__.
- console_history_id (str) – (required) The OCID of the console history.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_console_history API.
- db_node_id (str) –
-
delete_database
(database_id, **kwargs)¶ Deletes the specified database. Applies only to Exadata systems.
The data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the performFinalBackup parameter to have the Exadata system database backed up before it is deleted.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- if_match (str) – (optional) 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.
- perform_final_backup (bool) –
(optional) Whether to perform a final backup of the database or not. Default is false.
If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_database API.
- database_id (str) –
-
delete_database_software_image
(database_software_image_id, **kwargs)¶ Delete a database software image
Parameters: - database_software_image_id (str) –
(required) The DB system `OCID`__.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_database_software_image API.
- database_software_image_id (str) –
-
delete_db_home
(db_home_id, **kwargs)¶ Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems.
Oracle recommends that you use the performFinalBackup parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the performFinalBackup parameter to back up data.
Parameters: - db_home_id (str) –
(required) The Database Home `OCID`__.
- if_match (str) – (optional) 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.
- perform_final_backup (bool) –
(optional) Whether to perform a final backup of the database or not. Default is false.
If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_db_home API.
- db_home_id (str) –
-
delete_exadata_infrastructure
(exadata_infrastructure_id, **kwargs)¶ Deletes the Exadata Cloud@Customer infrastructure.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_exadata_infrastructure API.
- exadata_infrastructure_id (str) –
-
delete_exadb_vm_cluster
(exadb_vm_cluster_id, **kwargs)¶ Deletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.
Parameters: - exadb_vm_cluster_id (str) –
(required) The Exadata VM cluster `OCID`__ on Exascale Infrastructure.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_exadb_vm_cluster API.
- exadb_vm_cluster_id (str) –
-
delete_exascale_db_storage_vault
(exascale_db_storage_vault_id, **kwargs)¶ Deletes the specified Exadata Database Storage Vault.
Parameters: - exascale_db_storage_vault_id (str) –
(required) The Exadata Database Storage Vault `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_exascale_db_storage_vault API.
- exascale_db_storage_vault_id (str) –
-
delete_execution_action
(execution_action_id, **kwargs)¶ Deletes the execution action.
Parameters: - execution_action_id (str) –
(required) The execution action `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_execution_action API.
- execution_action_id (str) –
-
delete_execution_window
(execution_window_id, **kwargs)¶ Deletes the execution window.
Parameters: - execution_window_id (str) –
(required) The execution window `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_execution_window API.
- execution_window_id (str) –
-
delete_external_container_database
(external_container_database_id, **kwargs)¶ Deletes the
create_external_container_database_details()
resource. Any external pluggable databases registered under this container database must be deleted in your Oracle Cloud Infrastructure tenancy prior to this operation.Parameters: - external_container_database_id (str) –
(required) The ExternalContainerDatabase `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_external_container_database API.
- external_container_database_id (str) –
-
delete_external_database_connector
(external_database_connector_id, **kwargs)¶ Deletes an external database connector. Any services enabled using the external database connector must be deleted prior to this operation.
Parameters: - external_database_connector_id (str) –
(required) The `OCID`__ of the external database connector resource (ExternalDatabaseConnectorId).
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_external_database_connector API.
- external_database_connector_id (str) –
-
delete_external_non_container_database
(external_non_container_database_id, **kwargs)¶ Deletes the Oracle Cloud Infrastructure resource representing an external non-container database.
Parameters: - external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_external_non_container_database API.
- external_non_container_database_id (str) –
-
delete_external_pluggable_database
(external_pluggable_database_id, **kwargs)¶ Deletes the
create_external_pluggable_database_details()
. resource.Parameters: - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_external_pluggable_database API.
- external_pluggable_database_id (str) –
-
delete_key_store
(key_store_id, **kwargs)¶ Deletes a key store.
Parameters: - key_store_id (str) –
(required) The `OCID`__ of the key store.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_key_store API.
- key_store_id (str) –
-
delete_oneoff_patch
(oneoff_patch_id, **kwargs)¶ Deletes a one-off patch.
Parameters: - oneoff_patch_id (str) –
(required) The one-off patch `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_oneoff_patch API.
- oneoff_patch_id (str) –
-
delete_pluggable_database
(pluggable_database_id, **kwargs)¶ Deletes the specified pluggable database.
Parameters: - pluggable_database_id (str) –
(required) The database `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_pluggable_database API.
- pluggable_database_id (str) –
-
delete_scheduled_action
(scheduled_action_id, **kwargs)¶ Deletes the scheduled action.
Parameters: - scheduled_action_id (str) –
(required) The Scheduled Action `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_scheduled_action API.
- scheduled_action_id (str) –
-
delete_scheduling_plan
(scheduling_plan_id, **kwargs)¶ Deletes the scheduling plan.
Parameters: - scheduling_plan_id (str) –
(required) The Schedule Plan `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_scheduling_plan API.
- scheduling_plan_id (str) –
-
delete_scheduling_policy
(scheduling_policy_id, **kwargs)¶ Deletes the scheduling policy.
Parameters: - scheduling_policy_id (str) –
(required) The Scheduling Policy `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_scheduling_policy API.
- scheduling_policy_id (str) –
-
delete_scheduling_window
(scheduling_policy_id, scheduling_window_id, **kwargs)¶ Deletes the scheduling window.
Parameters: - scheduling_policy_id (str) –
(required) The Scheduling Policy `OCID`__.
- scheduling_window_id (str) –
(required) The Scheduling Window `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_scheduling_window API.
- scheduling_policy_id (str) –
-
delete_vm_cluster
(vm_cluster_id, **kwargs)¶ Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.
Parameters: - vm_cluster_id (str) –
(required) The VM cluster `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_vm_cluster API.
- vm_cluster_id (str) –
-
delete_vm_cluster_network
(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)¶ Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To delete a cloud VM cluster in an Exadata Cloud Service instance, use the
delete_cloud_vm_cluster()
operation.Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- vm_cluster_network_id (str) –
(required) The VM cluster network `OCID`__.
- if_match (str) – (optional) 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.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use delete_vm_cluster_network API.
- exadata_infrastructure_id (str) –
-
deregister_autonomous_database_data_safe
(autonomous_database_id, **kwargs)¶ Asynchronously deregisters this Autonomous Database with Data Safe.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- deregister_autonomous_database_data_safe_details (oci.database.models.DeregisterAutonomousDatabaseDataSafeDetails) – (optional) Details for deregistering an Autonomous Database with Data Safe.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use deregister_autonomous_database_data_safe API.
- autonomous_database_id (str) –
-
disable_autonomous_database_management
(autonomous_database_id, **kwargs)¶ Disables Database Management for the Autonomous Database resource.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_autonomous_database_management API.
- autonomous_database_id (str) –
-
disable_autonomous_database_operations_insights
(autonomous_database_id, **kwargs)¶ Disables Operations Insights for the Autonomous Database resource.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_autonomous_database_operations_insights API.
- autonomous_database_id (str) –
-
disable_database_management
(database_id, **kwargs)¶ Disables the Database Management service for the database.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use disable_database_management API.
- database_id (str) –
-
disable_external_container_database_database_management
(external_container_database_id, **kwargs)¶ Disable Database Management service for the external container database.
Parameters: - external_container_database_id (str) –
(required) The ExternalContainerDatabase `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_container_database_database_management API.
- external_container_database_id (str) –
-
disable_external_container_database_stack_monitoring
(external_container_database_id, **kwargs)¶ Disable Stack Monitoring for the external container database.
Parameters: - external_container_database_id (str) –
(required) The ExternalContainerDatabase `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_container_database_stack_monitoring API.
- external_container_database_id (str) –
-
disable_external_non_container_database_database_management
(external_non_container_database_id, **kwargs)¶ Disable Database Management Service for the external non-container database. For more information about the Database Management Service, see `Database Management Service`__.
Parameters: - external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_non_container_database_database_management API.
- external_non_container_database_id (str) –
-
disable_external_non_container_database_operations_insights
(external_non_container_database_id, **kwargs)¶ Disable Operations Insights for the external non-container database.
Parameters: - external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_non_container_database_operations_insights API.
- external_non_container_database_id (str) –
-
disable_external_non_container_database_stack_monitoring
(external_non_container_database_id, **kwargs)¶ Disable Stack Monitoring for the external non-container database.
Parameters: - external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_non_container_database_stack_monitoring API.
- external_non_container_database_id (str) –
-
disable_external_pluggable_database_database_management
(external_pluggable_database_id, **kwargs)¶ Disable Database Management Service for the external pluggable database. For more information about the Database Management Service, see `Database Management Service`__.
Parameters: - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_pluggable_database_database_management API.
- external_pluggable_database_id (str) –
-
disable_external_pluggable_database_operations_insights
(external_pluggable_database_id, **kwargs)¶ Disable Operations Insights for the external pluggable database.
Parameters: - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_pluggable_database_operations_insights API.
- external_pluggable_database_id (str) –
-
disable_external_pluggable_database_stack_monitoring
(external_pluggable_database_id, **kwargs)¶ Disable Stack Monitoring for the external pluggable database.
Parameters: - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use disable_external_pluggable_database_stack_monitoring API.
- external_pluggable_database_id (str) –
-
disable_pluggable_database_management
(pluggable_database_id, **kwargs)¶ Disables the Database Management service for the pluggable database.
Parameters: - pluggable_database_id (str) –
(required) The database `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typePluggableDatabase
Return type: Example: Click here to see an example of how to use disable_pluggable_database_management API.
- pluggable_database_id (str) –
-
download_exadata_infrastructure_config_file
(exadata_infrastructure_id, **kwargs)¶ Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type streamReturn type: Example: Click here to see an example of how to use download_exadata_infrastructure_config_file API.
- exadata_infrastructure_id (str) –
-
download_oneoff_patch
(oneoff_patch_id, **kwargs)¶ Download one-off patch.
Parameters: - oneoff_patch_id (str) –
(required) The one-off patch `OCID`__.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDownloadOneoffPatch
Return type: Example: Click here to see an example of how to use download_oneoff_patch API.
- oneoff_patch_id (str) –
-
download_validation_report
(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)¶ Downloads the network validation report file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- vm_cluster_network_id (str) –
(required) The VM cluster network `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type streamReturn type: Example: Click here to see an example of how to use download_validation_report API.
- exadata_infrastructure_id (str) –
-
download_vm_cluster_network_config_file
(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)¶ Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- vm_cluster_network_id (str) –
(required) The VM cluster network `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type streamReturn type: Example: Click here to see an example of how to use download_vm_cluster_network_config_file API.
- exadata_infrastructure_id (str) –
-
enable_autonomous_database_management
(autonomous_database_id, **kwargs)¶ Enables Database Management for Autonomous Database.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_autonomous_database_management API.
- autonomous_database_id (str) –
-
enable_autonomous_database_operations_insights
(autonomous_database_id, **kwargs)¶ Enables the specified Autonomous Database with Operations Insights.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_autonomous_database_operations_insights API.
- autonomous_database_id (str) –
-
enable_database_management
(database_id, enable_database_management_details, **kwargs)¶ Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- enable_database_management_details (oci.database.models.EnableDatabaseManagementDetails) – (required) Request to enable the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use enable_database_management API.
- database_id (str) –
-
enable_external_container_database_database_management
(external_container_database_id, enable_external_container_database_database_management_details, **kwargs)¶ Enables Database Management Service for the external container database. For more information about the Database Management Service, see `Database Management Service`__.
Parameters: - external_container_database_id (str) –
(required) The ExternalContainerDatabase `OCID`__.
- enable_external_container_database_database_management_details (oci.database.models.EnableExternalContainerDatabaseDatabaseManagementDetails) – (required) Request to enable the Database Management Service for an external container database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_container_database_database_management API.
- external_container_database_id (str) –
-
enable_external_container_database_stack_monitoring
(external_container_database_id, enable_external_container_database_stack_monitoring_details, **kwargs)¶ Enable Stack Monitoring for the external container database.
Parameters: - external_container_database_id (str) –
(required) The ExternalContainerDatabase `OCID`__.
- enable_external_container_database_stack_monitoring_details (oci.database.models.EnableExternalContainerDatabaseStackMonitoringDetails) – (required) Details to enable Stack Monitoring on the external container database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_container_database_stack_monitoring API.
- external_container_database_id (str) –
-
enable_external_non_container_database_database_management
(external_non_container_database_id, enable_external_non_container_database_database_management_details, **kwargs)¶ Enable Database Management Service for the external non-container database. For more information about the Database Management Service, see `Database Management Service`__.
Parameters: - external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- enable_external_non_container_database_database_management_details (oci.database.models.EnableExternalNonContainerDatabaseDatabaseManagementDetails) – (required) Request to enable the Database Management Service for an external non-container database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_non_container_database_database_management API.
- external_non_container_database_id (str) –
-
enable_external_non_container_database_operations_insights
(external_non_container_database_id, enable_external_non_container_database_operations_insights_details, **kwargs)¶ Enable Operations Insights for the external non-container database.
Parameters: - external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- enable_external_non_container_database_operations_insights_details (oci.database.models.EnableExternalNonContainerDatabaseOperationsInsightsDetails) – (required) Details to enable Operations Insights on the external non-container database
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_non_container_database_operations_insights API.
- external_non_container_database_id (str) –
-
enable_external_non_container_database_stack_monitoring
(external_non_container_database_id, enable_external_non_container_database_stack_monitoring_details, **kwargs)¶ Enable Stack Monitoring for the external non-container database.
Parameters: - external_non_container_database_id (str) –
(required) The external non-container database `OCID`__.
- enable_external_non_container_database_stack_monitoring_details (oci.database.models.EnableExternalNonContainerDatabaseStackMonitoringDetails) – (required) Details to enable Stack Monitoring on the external non-container database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_non_container_database_stack_monitoring API.
- external_non_container_database_id (str) –
-
enable_external_pluggable_database_database_management
(external_pluggable_database_id, enable_external_pluggable_database_database_management_details, **kwargs)¶ Enable Database Management Service for the external pluggable database. For more information about the Database Management Service, see `Database Management Service`__.
Parameters: - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- enable_external_pluggable_database_database_management_details (oci.database.models.EnableExternalPluggableDatabaseDatabaseManagementDetails) – (required) Request to enable the Database Management Service for an external database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_pluggable_database_database_management API.
- external_pluggable_database_id (str) –
-
enable_external_pluggable_database_operations_insights
(external_pluggable_database_id, enable_external_pluggable_database_operations_insights_details, **kwargs)¶ Enable Operations Insights for the external pluggable database.
Parameters: - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- enable_external_pluggable_database_operations_insights_details (oci.database.models.EnableExternalPluggableDatabaseOperationsInsightsDetails) – (required) Details to enable Operations Insights on the external pluggable database
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_pluggable_database_operations_insights API.
- external_pluggable_database_id (str) –
-
enable_external_pluggable_database_stack_monitoring
(external_pluggable_database_id, enable_external_pluggable_database_stack_monitoring_details, **kwargs)¶ Enable Stack Monitoring for the external pluggable database.
Parameters: - external_pluggable_database_id (str) –
(required) The ExternalPluggableDatabaseId `OCID`__.
- enable_external_pluggable_database_stack_monitoring_details (oci.database.models.EnableExternalPluggableDatabaseStackMonitoringDetails) – (required) Details to enable Stack Monitoring on the external pluggable database.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type NoneReturn type: Example: Click here to see an example of how to use enable_external_pluggable_database_stack_monitoring API.
- external_pluggable_database_id (str) –
-
enable_pluggable_database_management
(pluggable_database_id, enable_pluggable_database_management_details, **kwargs)¶ Enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. This service allows the pluggable database to access tools including Metrics and Performance hub. Database Management is enabled at the pluggable database (PDB) level.
Parameters: - pluggable_database_id (str) –
(required) The database `OCID`__.
- enable_pluggable_database_management_details (oci.database.models.EnablePluggableDatabaseManagementDetails) – (required) Request to enable the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typePluggableDatabase
Return type: Example: Click here to see an example of how to use enable_pluggable_database_management API.
- pluggable_database_id (str) –
-
fail_over_autonomous_database
(autonomous_database_id, **kwargs)¶ Initiates a failover of the specified Autonomous Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. This API should be called in the remote region where the peer database resides. Below parameter is optional:
- peerDbId Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. If this parameter is not provided, the failover will happen in the same region.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- if_match (str) – (optional) 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.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- peer_db_id (str) – (optional) The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabase
Return type: Example: Click here to see an example of how to use fail_over_autonomous_database API.
-
failover_autonomous_container_database_dataguard_association
(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, **kwargs)¶ Fails over the standby Autonomous Container Database identified by the autonomousContainerDatabaseId parameter to the primary Autonomous Container Database after the existing primary Autonomous Container Database fails or becomes unreachable.
A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.
Parameters: - autonomous_container_database_id (str) –
(required) The Autonomous Container Database `OCID`__.
- autonomous_container_database_dataguard_association_id (str) –
(required) The Autonomous Container Database-Autonomous Data Guard association `OCID`__.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousContainerDatabaseDataguardAssociation
Return type: Example: Click here to see an example of how to use failover_autonomous_container_database_dataguard_association API.
- autonomous_container_database_id (str) –
-
failover_data_guard
(database_id, failover_data_guard_details, **kwargs)¶ Performs a failover to transition the standby database identified by the databaseId path parameter into the primary role after the existing primary database fails or becomes unreachable.
A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.
This operation should be performed on respective standby database.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- failover_data_guard_details (oci.database.models.FailoverDataGuardDetails) – (required) A request to update an existing Data Guard member.
- opc_retry_token (str) – (optional) 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 may be rejected).
- opc_request_id (str) – (optional) Unique identifier for the request.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use failover_data_guard API.
- database_id (str) –
-
failover_data_guard_association
(database_id, data_guard_association_id, failover_data_guard_association_details, **kwargs)¶ Performs a failover to transition the standby database identified by the databaseId parameter into the specified Data Guard association’s primary role after the existing primary database fails or becomes unreachable.
A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.
Parameters: - database_id (str) –
(required) The database `OCID`__.
- data_guard_association_id (str) –
(required) The Data Guard association’s `OCID`__.
- failover_data_guard_association_details (oci.database.models.FailoverDataGuardAssociationDetails) – (required) A request to perform a failover, transitioning a standby database into a primary database.
- if_match (str) – (optional) 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.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeDataGuardAssociation
Return type: Example: Click here to see an example of how to use failover_data_guard_association API.
- database_id (str) –
-
generate_autonomous_database_wallet
(autonomous_database_id, generate_autonomous_database_wallet_details, **kwargs)¶ Creates and downloads a wallet for the specified Autonomous Database.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- generate_autonomous_database_wallet_details (oci.database.models.GenerateAutonomousDatabaseWalletDetails) – (required) Request to create a new Autonomous Database wallet.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of type streamReturn type: Example: Click here to see an example of how to use generate_autonomous_database_wallet API.
- autonomous_database_id (str) –
-
generate_recommended_vm_cluster_network
(exadata_infrastructure_id, generate_recommended_network_details, **kwargs)¶ Generates a recommended Cloud@Customer VM cluster network configuration.
Parameters: - exadata_infrastructure_id (str) –
(required) The Exadata infrastructure `OCID`__.
- generate_recommended_network_details (oci.database.models.GenerateRecommendedNetworkDetails) – (required) Request to generate a recommended Cloud@Customer VM cluster network configuration.
- opc_request_id (str) – (optional) Unique identifier for the request.
- opc_retry_token (str) – (optional) 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 may be rejected).
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeVmClusterNetworkDetails
Return type: Example: Click here to see an example of how to use generate_recommended_vm_cluster_network API.
- exadata_infrastructure_id (str) –
-
get_application_vip
(application_vip_id, **kwargs)¶ Gets information about a specified application virtual IP (VIP) address.
Parameters: - application_vip_id (str) –
(required) The `OCID`__ of the application virtual IP (VIP) address.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeApplicationVip
Return type: Example: Click here to see an example of how to use get_application_vip API.
- application_vip_id (str) –
-
get_autonomous_container_database
(autonomous_container_database_id, **kwargs)¶ Gets information about the specified Autonomous Container Database.
Parameters: - autonomous_container_database_id (str) –
(required) The Autonomous Container Database `OCID`__.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousContainerDatabase
Return type: Example: Click here to see an example of how to use get_autonomous_container_database API.
- autonomous_container_database_id (str) –
-
get_autonomous_container_database_dataguard_association
(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, **kwargs)¶ Gets an Autonomous Container Database enabled with Autonomous Data Guard associated with the specified Autonomous Container Database.
Parameters: - autonomous_container_database_id (str) –
(required) The Autonomous Container Database `OCID`__.
- autonomous_container_database_dataguard_association_id (str) –
(required) The Autonomous Container Database-Autonomous Data Guard association `OCID`__.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousContainerDatabaseDataguardAssociation
Return type: Example: Click here to see an example of how to use get_autonomous_container_database_dataguard_association API.
- autonomous_container_database_id (str) –
-
get_autonomous_container_database_resource_usage
(autonomous_container_database_id, **kwargs)¶ Get resource usage details for the specified Autonomous Container Database.
Parameters: - autonomous_container_database_id (str) –
(required) The Autonomous Container Database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousContainerDatabaseResourceUsage
Return type: Example: Click here to see an example of how to use get_autonomous_container_database_resource_usage API.
- autonomous_container_database_id (str) –
-
get_autonomous_database
(autonomous_database_id, **kwargs)¶ Gets the details of the specified Autonomous Database.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabase
Return type: Example: Click here to see an example of how to use get_autonomous_database API.
- autonomous_database_id (str) –
-
get_autonomous_database_backup
(autonomous_database_backup_id, **kwargs)¶ Gets information about the specified Autonomous Database backup.
Parameters: - autonomous_database_backup_id (str) –
(required) The `OCID`__ of the Autonomous Database backup.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabaseBackup
Return type: Example: Click here to see an example of how to use get_autonomous_database_backup API.
- autonomous_database_backup_id (str) –
-
get_autonomous_database_dataguard_association
(autonomous_database_id, autonomous_database_dataguard_association_id, **kwargs)¶ Gets an Autonomous Data Guard-enabled database associated with the specified Autonomous Database.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- autonomous_database_dataguard_association_id (str) –
(required) The Autonomous Container Database-Autonomous Data Guard association `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabaseDataguardAssociation
Return type: Example: Click here to see an example of how to use get_autonomous_database_dataguard_association API.
- autonomous_database_id (str) –
-
get_autonomous_database_regional_wallet
(**kwargs)¶ Gets the Autonomous Database regional wallet details.
Parameters: - opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabaseWallet
Return type: Example: Click here to see an example of how to use get_autonomous_database_regional_wallet API.
-
get_autonomous_database_software_image
(autonomous_database_software_image_id, **kwargs)¶ Gets information about the specified Autonomous Database Software Image.
Parameters: - autonomous_database_software_image_id (str) –
(required) The Autonomous Database Software Image `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabaseSoftwareImage
Return type: Example: Click here to see an example of how to use get_autonomous_database_software_image API.
- autonomous_database_software_image_id (str) –
-
get_autonomous_database_wallet
(autonomous_database_id, **kwargs)¶ Gets the wallet details for the specified Autonomous Database.
Parameters: - autonomous_database_id (str) –
(required) The database `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousDatabaseWallet
Return type: Example: Click here to see an example of how to use get_autonomous_database_wallet API.
- autonomous_database_id (str) –
-
get_autonomous_exadata_infrastructure
(autonomous_exadata_infrastructure_id, **kwargs)¶ Deprecated. Use the
get_cloud_exadata_infrastructure()
operation to get details of an Exadata Infrastructure resource and theget_cloud_autonomous_vm_cluster()
operation to get details of an Autonomous Exadata VM cluster.Parameters: - autonomous_exadata_infrastructure_id (str) –
(required) The Autonomous Exadata Infrastructure `OCID`__.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousExadataInfrastructure
Return type: Example: Click here to see an example of how to use get_autonomous_exadata_infrastructure API.
- autonomous_exadata_infrastructure_id (str) –
-
get_autonomous_patch
(autonomous_patch_id, **kwargs)¶ Gets information about a specific autonomous patch.
Parameters: - autonomous_patch_id (str) –
(required) The autonomous patch `OCID`__.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousPatch
Return type: Example: Click here to see an example of how to use get_autonomous_patch API.
- autonomous_patch_id (str) –
-
get_autonomous_virtual_machine
(autonomous_virtual_machine_id, **kwargs)¶ Gets the details of specific Autonomous Virtual Machine.
Parameters: - autonomous_virtual_machine_id (str) –
(required) The Autonomous Virtual machine `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousVirtualMachine
Return type: Example: Click here to see an example of how to use get_autonomous_virtual_machine API.
- autonomous_virtual_machine_id (str) –
-
get_autonomous_vm_cluster
(autonomous_vm_cluster_id, **kwargs)¶ Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see
get_cloud_autonomous_vm_cluster()
.Parameters: - autonomous_vm_cluster_id (str) –
(required) The autonomous VM cluster `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousVmCluster
Return type: Example: Click here to see an example of how to use get_autonomous_vm_cluster API.
- autonomous_vm_cluster_id (str) –
-
get_autonomous_vm_cluster_resource_usage
(autonomous_vm_cluster_id, **kwargs)¶ Get the resource usage details for the specified Autonomous Exadata VM cluster.
Parameters: - autonomous_vm_cluster_id (str) –
(required) The autonomous VM cluster `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeAutonomousVmClusterResourceUsage
Return type: Example: Click here to see an example of how to use get_autonomous_vm_cluster_resource_usage API.
- autonomous_vm_cluster_id (str) –
-
get_backup
(backup_id, **kwargs)¶ Gets information about the specified backup.
Parameters: - backup_id (str) –
(required) The backup `OCID`__.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: Return type: Example: Click here to see an example of how to use get_backup API.
- backup_id (str) –
-
get_backup_destination
(backup_destination_id, **kwargs)¶ Gets information about the specified backup destination in an Exadata Cloud@Customer system.
Parameters: - backup_destination_id (str) –
(required) The `OCID`__ of the backup destination.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeBackupDestination
Return type: Example: Click here to see an example of how to use get_backup_destination API.
- backup_destination_id (str) –
-
get_cloud_autonomous_vm_cluster
(cloud_autonomous_vm_cluster_id, **kwargs)¶ Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see
get_autonomous_vm_cluster()
.Parameters: - cloud_autonomous_vm_cluster_id (str) –
(required) The Cloud VM cluster `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudAutonomousVmCluster
Return type: Example: Click here to see an example of how to use get_cloud_autonomous_vm_cluster API.
- cloud_autonomous_vm_cluster_id (str) –
-
get_cloud_autonomous_vm_cluster_resource_usage
(cloud_autonomous_vm_cluster_id, **kwargs)¶ Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster.
Parameters: - cloud_autonomous_vm_cluster_id (str) –
(required) The Cloud VM cluster `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudAutonomousVmClusterResourceUsage
Return type: Example: Click here to see an example of how to use get_cloud_autonomous_vm_cluster_resource_usage API.
- cloud_autonomous_vm_cluster_id (str) –
-
get_cloud_exadata_infrastructure
(cloud_exadata_infrastructure_id, **kwargs)¶ Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
Parameters: - cloud_exadata_infrastructure_id (str) –
(required) The cloud Exadata infrastructure `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
. - allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns: A
Response
object with data of typeCloudExadataInfrastructure
Return type: Example: Click here to see an example of how to use get_cloud_exadata_infrastructure API.
- cloud_exadata_infrastructure_id (str) –
-
get_cloud_exadata_infrastructure_unallocated_resources
(cloud_exadata_infrastructure_id, **kwargs)¶ Gets unallocated resources information for the specified Cloud Exadata infrastructure.
Parameters: - cloud_exadata_infrastructure_id (str) –
(required) The cloud Exadata infrastructure `OCID`__.
- opc_request_id (str) – (optional) Unique identifier for the request.
- db_servers (list[str]) –
(optional) The list of `OCIDs`__ of the Db servers.
- retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
This should be one of the strategies available in the
retry
module. This operation will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.To have this operation explicitly not perform any retries, pass an instance of
NoneRetryStrategy
- cloud_exadata_infrastructure_id (str) –
-