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_exadata_infrastructure(…) Makes the storage capacity from additional storage servers available for VM Cluster consumption.
autonomous_database_manual_refresh(…) Initiates a data refresh for an Autonomous Database refreshable clone.
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_exadata_infrastructure_compartment(…) Moves the Autonomous Exadata Infrastructure resource and its dependent resources to the specified compartment.
change_autonomous_vm_cluster_compartment(…) To move an Autonomous VM cluster and its dependent resources to another compartment, use the change_autonomous_vm_cluster_compartment() operation.
change_backup_destination_compartment(…) Move the backup destination and its dependent resources to the specified compartment.
change_cloud_exadata_infrastructure_compartment(…) Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment.
change_cloud_vm_cluster_compartment(…) Moves a cloud VM cluster and its dependent resources to another compartment.
change_database_software_image_compartment(…) Move the Database Software Image and its dependent resources to the specified compartment.
change_db_system_compartment(…) Moves the DB system and its dependent resources to the specified compartment.
change_exadata_infrastructure_compartment(…) Moves an Exadata infrastructure resource and its dependent resources 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_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`__.
create_autonomous_container_database(…) Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.
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_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_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_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_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_pluggable_database(…) Creates and starts a pluggable database in the specified container database.
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_autonomous_database(…) Deletes the specified Autonomous Database.
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_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_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_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_pluggable_database(…) Deletes the specified pluggable database.
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_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_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_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.
download_exadata_infrastructure_config_file(…) Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure.
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_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_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_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.
fail_over_autonomous_database(…) Initiates a failover the specified Autonomous Database to a standby.
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_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_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_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_wallet(…) Gets the wallet details for the specified Autonomous Database.
get_autonomous_exadata_infrastructure(…) Gets information about the specified Autonomous Exadata Infrastructure resource.
get_autonomous_patch(autonomous_patch_id, …) Gets information about a specific autonomous patch.
get_autonomous_vm_cluster(…) Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system.
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_exadata_infrastructure(…) Gets information about the specified cloud Exadata infrastructure resource.
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_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_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_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_iorm_config(db_system_id, **kwargs) Gets the IORM configuration settings for the specified cloud Exadata DB system.
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_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_pluggable_database(…) Gets information about the specified pluggable database.
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(…) Creates a new Autonomous Exadata Infrastructure in the specified compartment and availability domain.
launch_db_system(launch_db_system_details, …) Creates a new DB system in the specified compartment and availability domain.
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_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_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_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(…) Gets a list of the shapes that can be used to launch a new Autonomous Exadata Infrastructure resource.
list_autonomous_exadata_infrastructures(…) Gets a list of the Autonomous Exadata Infrastructures in the specified compartment.
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_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_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_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_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_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_versions(compartment_id, **kwargs) Gets a list of supported GI versions for the Exadata Cloud@Customer VM cluster.
list_key_stores(compartment_id, **kwargs) Gets a list of key stores in the specified compartment.
list_maintenance_runs(compartment_id, **kwargs) Gets a list of the maintenance runs in the specified compartment.
list_pluggable_databases(**kwargs) Gets a list of the pluggable databases in a database or compartment.
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(…) Clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB.
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.
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_association(…) Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association.
remote_clone_pluggable_database(…) Clones a pluggable database (PDB) to a different database from the source PDB.
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_ords_certs(…) Rotates Oracle REST Data Services (ORDS) certs for an Autonomous Exadata Infrastructure resource.
rotate_ssl_certs(…) Rotates SSL certs for an Autonomous Exadata Infrastructure resource.
rotate_vault_key(database_id, **kwargs) Creates a new version of an existing `Vault service`__ key.
scan_external_container_database_pluggable_databases(…) Scans for pluggable databases in the specified external container database.
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.
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 standby 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(…) Terminates an Autonomous Exadata Infrastructure, which permanently deletes the infrastructure resource and any container databases and databases contained in the resource.
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 the OCPU core count and storage size.
update_autonomous_database(…) Updates one or more attributes of the specified Autonomous Database.
update_autonomous_database_regional_wallet(…) Updates the Autonomous Database regional wallet.
update_autonomous_database_wallet(…) Updates the wallet for the specified Autonomous Database.
update_autonomous_exadata_infrastructure(…) Updates the properties of an Autonomous Exadata Infrastructure, such as the CPU core count.
update_autonomous_vm_cluster(…) Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.
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_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_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_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_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, …) If no database is associated with the key store, 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_pluggable_database(…) Updates the specified pluggable database.
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.
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, a dict can be passed. You can validate_config the dict using validate_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 convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use activate_exadata_infrastructure API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use add_storage_capacity_exadata_infrastructure 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use autonomous_database_manual_refresh API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_autonomous_database_compartment API.

change_autonomous_exadata_infrastructure_compartment(change_compartment_details, autonomous_exadata_infrastructure_id, **kwargs)

Moves the Autonomous Exadata Infrastructure resource 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 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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)

To move an Autonomous VM cluster and its dependent resources to another compartment, use the change_autonomous_vm_cluster_compartment() operation.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_backup_destination_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 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_cloud_exadata_infrastructure_compartment 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 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_cloud_vm_cluster_compartment 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_database_software_image_compartment 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_db_system_compartment API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_exadata_infrastructure_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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_external_pluggable_database_compartment API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_key_store_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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use check_external_database_connector_connection_status API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalBackupJob

Return type:

Response

Example:

Click here to see an example of how to use complete_external_backup_job API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use configure_autonomous_database_vault_key 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

Example:

Click here to see an example of how to use create_autonomous_container_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseBackup

Return type:

Response

Example:

Click here to see an example of how to use create_autonomous_database_backup API.

create_autonomous_vm_cluster(create_autonomous_vm_cluster_details, **kwargs)

Creates an Autonomous VM cluster for Exadata Cloud@Customer.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousVmCluster

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Backup

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BackupDestination

Return type:

Response

Example:

Click here to see an example of how to use create_backup_destination API.

create_cloud_exadata_infrastructure(create_cloud_exadata_infrastructure_details, **kwargs)

Creates a cloud Exadata infrastructure resource. This resource is used to create an `Exadata Cloud Service`__ instance.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CloudExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use create_cloud_exadata_infrastructure API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CloudVmCluster

Return type:

Response

Example:

Click here to see an example of how to use create_cloud_vm_cluster API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConsoleConnection

Return type:

Response

Example:

Click here to see an example of how to use create_console_connection 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

Example:

Click here to see an example of how to use create_data_guard_association API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DatabaseSoftwareImage

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbHome

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use create_exadata_infrastructure 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalBackupJob

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalContainerDatabase

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalDatabaseConnector

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalNonContainerDatabase

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalPluggableDatabase

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type KeyStore

Return type:

Response

Example:

Click here to see an example of how to use create_key_store API.

create_pluggable_database(create_pluggable_database_details, **kwargs)

Creates and starts a pluggable database in the specified container database. Use the [StartPluggableDatabase](#/en/database/latest/PluggableDatabase/StartPluggableDatabase] and [StopPluggableDatabase](#/en/database/latest/PluggableDatabase/StopPluggableDatabase] 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PluggableDatabase

Return type:

Response

Example:

Click here to see an example of how to use create_pluggable_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmCluster

Return type:

Response

Example:

Click here to see an example of how to use create_vm_cluster API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetwork

Return type:

Response

Example:

Click here to see an example of how to use create_vm_cluster_network API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbNode

Return type:

Response

Example:

Click here to see an example of how to use db_node_action API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_autonomous_database API.

delete_autonomous_vm_cluster(autonomous_vm_cluster_id, **kwargs)

Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_autonomous_vm_cluster API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_backup API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_backup_destination API.

delete_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, **kwargs)

Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_cloud_exadata_infrastructure API.

delete_cloud_vm_cluster(cloud_vm_cluster_id, **kwargs)

Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_cloud_vm_cluster API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_console_connection API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_database_software_image API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_db_home API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_exadata_infrastructure API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_external_container_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_external_database_connector API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_external_non_container_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_external_pluggable_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_key_store API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_pluggable_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_vm_cluster API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_vm_cluster_network API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use deregister_autonomous_database_data_safe API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_autonomous_database_operations_insights API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

Example:

Click here to see an example of how to use disable_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_external_container_database_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_external_non_container_database_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_external_non_container_database_operations_insights API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_external_pluggable_database_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_external_pluggable_database_operations_insights API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_exadata_infrastructure_config_file API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_validation_report API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_vm_cluster_network_config_file API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_autonomous_database_operations_insights API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

Example:

Click here to see an example of how to use enable_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_external_container_database_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_external_non_container_database_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_external_non_container_database_operations_insights API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_external_pluggable_database_database_management API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_external_pluggable_database_operations_insights API.

fail_over_autonomous_database(autonomous_database_id, **kwargs)

Initiates a failover the specified Autonomous Database to a standby. To perform a failover to a standby located in a remote region, specify the `OCID`__ of the remote standby using the peerDbId parameter.

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`__ of the Autonomous Data Guard standby database located in a different (remote) region from the source primary Autonomous 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabaseDataguardAssociation

Return type:

Response

Example:

Click here to see an example of how to use failover_autonomous_container_database_dataguard_association API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

Example:

Click here to see an example of how to use failover_data_guard_association API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use generate_autonomous_database_wallet API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetworkDetails

Return type:

Response

Example:

Click here to see an example of how to use generate_recommended_vm_cluster_network API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_container_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabaseDataguardAssociation

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_container_database_dataguard_association API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_database API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseBackup

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_database_backup API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseDataguardAssociation

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_database_dataguard_association API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseWallet

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_database_regional_wallet API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabaseWallet

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_database_wallet API.

get_autonomous_exadata_infrastructure(autonomous_exadata_infrastructure_id, **kwargs)

Gets information about the specified Autonomous Exadata Infrastructure resource.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_exadata_infrastructure API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousPatch

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_patch API.

get_autonomous_vm_cluster(autonomous_vm_cluster_id, **kwargs)

Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousVmCluster

Return type:

Response

Example:

Click here to see an example of how to use get_autonomous_vm_cluster API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Backup

Return type:

Response

Example:

Click here to see an example of how to use get_backup API.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BackupDestination

Return type:

Response

Example:

Click here to see an example of how to use get_backup_destination API.

get_cloud_exadata_infrastructure(cloud_exadata_infrastructure_id, **kwargs)

Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CloudExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use get_cloud_exadata_infrastructure API.

get_cloud_vm_cluster(cloud_vm_cluster_id, **kwargs)

Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Parameters:
  • cloud_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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CloudVmCluster

Return type:

Response

Example:

Click here to see an example of how to use get_cloud_vm_cluster API.

get_cloud_vm_cluster_iorm_config(cloud_vm_cluster_id, **kwargs)

Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. If you have not specified an IORM configuration, the default configuration is returned.

Parameters:
  • cloud_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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataIormConfig

Return type:

Response

Example:

Click here to see an example of how to use get_cloud_vm_cluster_iorm_config API.

get_cloud_vm_cluster_update(cloud_vm_cluster_id, update_id, **kwargs)

Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only.

Parameters:
  • cloud_vm_cluster_id (str) –

    (required) The cloud VM cluster `OCID`__.

  • update_id (str) –

    (required) The `OCID`__ of the maintenance update.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Update

Return type:

Response

Example:

Click here to see an example of how to use get_cloud_vm_cluster_update API.

get_cloud_vm_cluster_update_history_entry(cloud_vm_cluster_id, update_history_entry_id, **kwargs)

Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only.

Parameters:
  • cloud_vm_cluster_id (str) –

    (required) The cloud VM cluster `OCID`__.

  • update_history_entry_id (str) –

    (required) The `OCID`__ of the maintenance update history entry.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UpdateHistoryEntry

Return type:

Response

Example:

Click here to see an example of how to use get_cloud_vm_cluster_update_history_entry API.

get_console_connection(db_node_id, console_connection_id, **kwargs)

Gets the specified database node console connection’s information.

Parameters:
  • db_node_id (str) –

    (required) The database node `OCID`__.

  • console_connection_id (str) – (required) The OCID of the console connection.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConsoleConnection

Return type:

Response

Example:

Click here to see an example of how to use get_console_connection API.

get_data_guard_association(database_id, data_guard_association_id, **kwargs)

Gets the specified Data Guard association’s configuration information.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • data_guard_association_id (str) –

    (required) The Data Guard association’s `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

Example:

Click here to see an example of how to use get_data_guard_association API.

get_database(database_id, **kwargs)

Gets information about the specified database.

Parameters:
  • database_id (str) –

    (required) The 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

Example:

Click here to see an example of how to use get_database API.

get_database_software_image(database_software_image_id, **kwargs)

Gets information about the specified database software image.

Parameters:
  • database_software_image_id (str) –

    (required) The DB system `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DatabaseSoftwareImage

Return type:

Response

Example:

Click here to see an example of how to use get_database_software_image API.

get_database_upgrade_history_entry(database_id, upgrade_history_entry_id, **kwargs)

gets the upgrade history for a specified database.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • upgrade_history_entry_id (str) –

    (required) The database upgrade History `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DatabaseUpgradeHistoryEntry

Return type:

Response

Example:

Click here to see an example of how to use get_database_upgrade_history_entry API.

get_db_home(db_home_id, **kwargs)

Gets information about the specified Database Home.

Parameters:
  • db_home_id (str) –

    (required) The Database Home `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbHome

Return type:

Response

Example:

Click here to see an example of how to use get_db_home API.

get_db_home_patch(db_home_id, patch_id, **kwargs)

Gets information about a specified patch package.

Parameters:
  • db_home_id (str) –

    (required) The Database Home `OCID`__.

  • patch_id (str) –

    (required) The `OCID`__ of the patch.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

Example:

Click here to see an example of how to use get_db_home_patch API.

get_db_home_patch_history_entry(db_home_id, patch_history_entry_id, **kwargs)

Gets the patch history details for the specified patchHistoryEntryId

Parameters:
  • db_home_id (str) –

    (required) The Database Home `OCID`__.

  • patch_history_entry_id (str) –

    (required) The `OCID`__ of the patch history entry.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PatchHistoryEntry

Return type:

Response

Example:

Click here to see an example of how to use get_db_home_patch_history_entry API.

get_db_node(db_node_id, **kwargs)

Gets information about the specified database node.

Parameters:
  • db_node_id (str) –

    (required) The database node `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbNode

Return type:

Response

Example:

Click here to see an example of how to use get_db_node API.

get_db_system(db_system_id, **kwargs)

Gets information about the specified DB system.

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.

Parameters:
  • db_system_id (str) –

    (required) The DB system `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbSystem

Return type:

Response

Example:

Click here to see an example of how to use get_db_system API.

get_db_system_patch(db_system_id, patch_id, **kwargs)

Gets information the specified patch.

Parameters:
  • db_system_id (str) –

    (required) The DB system `OCID`__.

  • patch_id (str) –

    (required) The `OCID`__ of the patch.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

Example:

Click here to see an example of how to use get_db_system_patch API.

get_db_system_patch_history_entry(db_system_id, patch_history_entry_id, **kwargs)

Gets the details of the specified patch operation on the specified DB system.

Parameters:
  • db_system_id (str) –

    (required) The DB system `OCID`__.

  • patch_history_entry_id (str) –

    (required) The `OCID`__ of the patch history entry.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PatchHistoryEntry

Return type:

Response

Example:

Click here to see an example of how to use get_db_system_patch_history_entry API.

get_exadata_infrastructure(exadata_infrastructure_id, **kwargs)

Gets information about the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. To get information on an Exadata Cloud Service infrastructure resource, use the get_cloud_exadata_infrastructure() operation.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use get_exadata_infrastructure API.

get_exadata_infrastructure_ocpus(autonomous_exadata_infrastructure_id, **kwargs)

Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource.

Parameters:
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type OCPUs

Return type:

Response

Example:

Click here to see an example of how to use get_exadata_infrastructure_ocpus API.

get_exadata_iorm_config(db_system_id, **kwargs)

Gets the IORM configuration settings for the specified cloud Exadata DB system. All Exadata service instances have default IORM settings.

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.

The get_cloud_vm_cluster_iorm_config() API is used for this operation with Exadata systems using the new resource model.

Parameters:
  • db_system_id (str) –

    (required) The DB system `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataIormConfig

Return type:

Response

Example:

Click here to see an example of how to use get_exadata_iorm_config API.

get_external_backup_job(backup_id, **kwargs)

Gets information about the specified external backup job.

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`__.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalBackupJob

Return type:

Response

Example:

Click here to see an example of how to use get_external_backup_job API.

get_external_container_database(external_container_database_id, **kwargs)

Gets information about the specified external container database.

Parameters:
  • external_container_database_id (str) –

    (required) The ExternalContainerDatabase `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalContainerDatabase

Return type:

Response

Example:

Click here to see an example of how to use get_external_container_database API.

get_external_database_connector(external_database_connector_id, **kwargs)

Gets information about the specified external database connector.

Parameters:
  • external_database_connector_id (str) –

    (required) The `OCID`__ of the external database connector resource (ExternalDatabaseConnectorId).

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalDatabaseConnector

Return type:

Response

Example:

Click here to see an example of how to use get_external_database_connector API.

get_external_non_container_database(external_non_container_database_id, **kwargs)

Gets information about a specific external non-container database.

Parameters:
  • external_non_container_database_id (str) –

    (required) The external non-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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalNonContainerDatabase

Return type:

Response

Example:

Click here to see an example of how to use get_external_non_container_database API.

get_external_pluggable_database(external_pluggable_database_id, **kwargs)

Gets information about a specific 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExternalPluggableDatabase

Return type:

Response

Example:

Click here to see an example of how to use get_external_pluggable_database API.

get_key_store(key_store_id, **kwargs)

Gets information about the specified key store.

Parameters:
  • key_store_id (str) –

    (required) The `OCID`__ of the key store.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type KeyStore

Return type:

Response

Example:

Click here to see an example of how to use get_key_store API.

get_maintenance_run(maintenance_run_id, **kwargs)

Gets information about the specified maintenance run.

Parameters:
  • maintenance_run_id (str) – (required) The maintenance run 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MaintenanceRun

Return type:

Response

Example:

Click here to see an example of how to use get_maintenance_run API.

get_pluggable_database(pluggable_database_id, **kwargs)

Gets information about the specified pluggable database.

Parameters:
  • pluggable_database_id (str) –

    (required) The 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PluggableDatabase

Return type:

Response

Example:

Click here to see an example of how to use get_pluggable_database API.

get_vm_cluster(vm_cluster_id, **kwargs)

Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:
  • vm_cluster_id (str) –

    (required) The 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmCluster

Return type:

Response

Example:

Click here to see an example of how to use get_vm_cluster API.

get_vm_cluster_network(exadata_infrastructure_id, vm_cluster_network_id, **kwargs)

Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the get_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`__.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterNetwork

Return type:

Response

Example:

Click here to see an example of how to use get_vm_cluster_network API.

get_vm_cluster_patch(vm_cluster_id, patch_id, **kwargs)

Gets information about a specified patch package.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • patch_id (str) –

    (required) The `OCID`__ of the patch.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

Example:

Click here to see an example of how to use get_vm_cluster_patch API.

get_vm_cluster_patch_history_entry(vm_cluster_id, patch_history_entry_id, **kwargs)

Gets the patch history details for the specified patch history entry.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • patch_history_entry_id (str) –

    (required) The `OCID`__ of the patch history entry.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PatchHistoryEntry

Return type:

Response

Example:

Click here to see an example of how to use get_vm_cluster_patch_history_entry API.

get_vm_cluster_update(vm_cluster_id, update_id, **kwargs)

Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • update_id (str) –

    (required) The `OCID`__ of the maintenance update.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterUpdate

Return type:

Response

Example:

Click here to see an example of how to use get_vm_cluster_update API.

get_vm_cluster_update_history_entry(vm_cluster_id, update_history_entry_id, **kwargs)

Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • update_history_entry_id (str) –

    (required) The `OCID`__ of the maintenance update history entry.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VmClusterUpdateHistoryEntry

Return type:

Response

Example:

Click here to see an example of how to use get_vm_cluster_update_history_entry API.

launch_autonomous_exadata_infrastructure(launch_autonomous_exadata_infrastructure_details, **kwargs)

Creates a new Autonomous Exadata Infrastructure in the specified compartment and availability domain.

Parameters:
  • launch_autonomous_exadata_infrastructure_details (oci.database.models.LaunchAutonomousExadataInfrastructureDetails) – (required) Request to create an Autonomous Exadata Infrastructure 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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousExadataInfrastructure

Return type:

Response

Example:

Click here to see an example of how to use launch_autonomous_exadata_infrastructure API.

launch_db_system(launch_db_system_details, **kwargs)

Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.

An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see `Bare metal and virtual machine DB system default options.`__

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.

Use the create_cloud_exadata_infrastructure() and create_cloud_vm_cluster() APIs to provision a new Exadata Cloud Service instance.

Parameters:
  • launch_db_system_details (oci.database.models.LaunchDbSystemBase) –

    (required) Request to launch a DB system.

    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.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DbSystem

Return type:

Response

Example:

Click here to see an example of how to use launch_db_system API.

list_autonomous_container_database_dataguard_associations(autonomous_container_database_id, **kwargs)

Gets a list of the Autonomous Container Databases with Autonomous Data Guard-enabled associated with the specified Autonomous Container Database.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousContainerDatabaseDataguardAssociation

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_container_database_dataguard_associations API.

list_autonomous_container_databases(compartment_id, **kwargs)

Gets a list of the Autonomous Container Databases in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • autonomous_exadata_infrastructure_id (str) –

    (optional) The Autonomous Exadata Infrastructure `OCID`__.

  • autonomous_vm_cluster_id (str) –

    (optional) The Autonomous VM Cluster `OCID`__.

  • infrastructure_type (str) –

    (optional) A filter to return only resources that match the given Infrastructure Type.

    Allowed values are: “CLOUD”, “CLOUD_AT_CUSTOMER”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “BACKUP_IN_PROGRESS”, “RESTORING”, “RESTORE_FAILED”, “RESTARTING”, “MAINTENANCE_IN_PROGRESS”, “ROLE_CHANGE_IN_PROGRESS”, “UNAVAILABLE”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • service_level_agreement_type (str) – (optional) A filter to return only resources that match the given service-level agreement type exactly.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousContainerDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_container_databases API.

list_autonomous_database_backups(**kwargs)

Gets a list of Autonomous Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.

Parameters:
  • autonomous_database_id (str) –

    (optional) The database `OCID`__.

  • compartment_id (str) –

    (optional) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDatabaseBackupSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_database_backups API.

list_autonomous_database_clones(compartment_id, autonomous_database_id, **kwargs)

Lists the Autonomous Database clones for the specified Autonomous Database.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • autonomous_database_id (str) –

    (required) The database `OCID`__.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “UNAVAILABLE”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “SCALE_IN_PROGRESS”, “AVAILABLE_NEEDS_ATTENTION”, “UPDATING”, “MAINTENANCE_IN_PROGRESS”, “RESTARTING”, “RECREATING”, “ROLE_CHANGE_IN_PROGRESS”, “UPGRADING”, “INACCESSIBLE”

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “NONE”, “TIMECREATED”, “DISPLAYNAME”

  • clone_type (str) –

    (optional) A filter to return only resources that match the given clone type exactly.

    Allowed values are: “REFRESHABLE_CLONE”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_database_clones API.

list_autonomous_database_dataguard_associations(autonomous_database_id, **kwargs)

Gets a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous Database.

Parameters:
  • autonomous_database_id (str) –

    (required) The database `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDatabaseDataguardAssociation

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_database_dataguard_associations API.

list_autonomous_databases(compartment_id, **kwargs)

Gets a list of Autonomous Databases based on the query parameters specified.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • autonomous_container_database_id (str) –

    (optional) The Autonomous Container Database `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • infrastructure_type (str) –

    (optional) A filter to return only resources that match the given Infrastructure Type.

    Allowed values are: “CLOUD”, “CLOUD_AT_CUSTOMER”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “UNAVAILABLE”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “SCALE_IN_PROGRESS”, “AVAILABLE_NEEDS_ATTENTION”, “UPDATING”, “MAINTENANCE_IN_PROGRESS”, “RESTARTING”, “RECREATING”, “ROLE_CHANGE_IN_PROGRESS”, “UPGRADING”, “INACCESSIBLE”

  • db_workload (str) –

    (optional) A filter to return only autonomous database resources that match the specified workload type.

    Allowed values are: “OLTP”, “DW”, “AJD”, “APEX”

  • db_version (str) – (optional) A filter to return only autonomous database resources that match the specified dbVersion.
  • is_free_tier (bool) – (optional) Filter on the value of the resource’s ‘isFreeTier’ property. A value of true returns only Always Free resources. A value of false excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • is_refreshable_clone (bool) – (optional) Filter on the value of the resource’s ‘isRefreshableClone’ property. A value of true returns only refreshable clones. A value of false excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones.
  • is_data_guard_enabled (bool) – (optional) A filter to return only resources that have Data Guard enabled.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_databases API.

list_autonomous_db_preview_versions(compartment_id, **kwargs)

Gets a list of supported Autonomous Database versions. Note that preview version software is only available for databases with `shared Exadata infrastructure`__.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for DBWORKLOAD is ascending.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “DBWORKLOAD”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDbPreviewVersionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_db_preview_versions API.

list_autonomous_db_versions(compartment_id, **kwargs)

Gets a list of supported Autonomous Database versions.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • db_workload (str) –

    (optional) A filter to return only autonomous database resources that match the specified workload type.

    Allowed values are: “OLTP”, “DW”, “AJD”, “APEX”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousDbVersionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_db_versions API.

list_autonomous_exadata_infrastructure_shapes(availability_domain, compartment_id, **kwargs)

Gets a list of the shapes that can be used to launch a new Autonomous Exadata Infrastructure resource. The shape determines resources to allocate (CPU cores, memory and storage).

Parameters:
  • availability_domain (str) – (required) The name of the Availability Domain.
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousExadataInfrastructureShapeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_exadata_infrastructure_shapes API.

list_autonomous_exadata_infrastructures(compartment_id, **kwargs)

Gets a list of the Autonomous Exadata Infrastructures in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousExadataInfrastructureSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_exadata_infrastructures API.

list_autonomous_vm_clusters(compartment_id, **kwargs)

Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • exadata_infrastructure_id (str) – (optional) If provided, filters the results for the given Exadata Infrastructure.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousVmClusterSummary

Return type:

Response

Example:

Click here to see an example of how to use list_autonomous_vm_clusters API.

list_backup_destination(compartment_id, **kwargs)

Gets a list of backup destinations in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • type (str) – (optional) A filter to return only resources that match the given type of the Backup Destination.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of BackupDestinationSummary

Return type:

Response

Example:

Click here to see an example of how to use list_backup_destination API.

list_backups(**kwargs)

Gets a list of backups based on the databaseId or compartmentId specified. Either one of these query parameters must be provided.

Parameters:
  • database_id (str) –

    (optional) The `OCID`__ of the database.

  • compartment_id (str) –

    (optional) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of BackupSummary

Return type:

Response

Example:

Click here to see an example of how to use list_backups API.

list_cloud_exadata_infrastructures(compartment_id, **kwargs)

Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances only.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CloudExadataInfrastructureSummary

Return type:

Response

Example:

Click here to see an example of how to use list_cloud_exadata_infrastructures API.

list_cloud_vm_cluster_update_history_entries(cloud_vm_cluster_id, **kwargs)

Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Parameters:
  • cloud_vm_cluster_id (str) –

    (required) The cloud VM cluster `OCID`__.

  • update_type (str) –

    (optional) A filter to return only resources that match the given update type exactly.

    Allowed values are: “GI_UPGRADE”, “GI_PATCH”, “OS_UPDATE”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of UpdateHistoryEntrySummary

Return type:

Response

Example:

Click here to see an example of how to use list_cloud_vm_cluster_update_history_entries API.

list_cloud_vm_cluster_updates(cloud_vm_cluster_id, **kwargs)

Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Parameters:
  • cloud_vm_cluster_id (str) –

    (required) The cloud VM cluster `OCID`__.

  • update_type (str) –

    (optional) A filter to return only resources that match the given update type exactly.

    Allowed values are: “GI_UPGRADE”, “GI_PATCH”, “OS_UPDATE”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of UpdateSummary

Return type:

Response

Example:

Click here to see an example of how to use list_cloud_vm_cluster_updates API.

list_cloud_vm_clusters(compartment_id, **kwargs)

Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances only.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • cloud_exadata_infrastructure_id (str) – (optional) If provided, filters the results for the specified cloud Exadata infrastructure.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only cloud VM clusters that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CloudVmClusterSummary

Return type:

Response

Example:

Click here to see an example of how to use list_cloud_vm_clusters API.

list_console_connections(db_node_id, **kwargs)

Lists the console connections for the specified database node.

Parameters:
  • db_node_id (str) –

    (required) The database node `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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ConsoleConnectionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_console_connections API.

list_container_database_patches(autonomous_container_database_id, compartment_id, **kwargs)

Lists the patches applicable to the requested container database.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous Container Database `OCID`__.

  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutonomousPatchSummary

Return type:

Response

Example:

Click here to see an example of how to use list_container_database_patches API.

list_data_guard_associations(database_id, **kwargs)

Lists all Data Guard associations for the specified database.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DataGuardAssociationSummary

Return type:

Response

Example:

Click here to see an example of how to use list_data_guard_associations API.

list_database_software_images(compartment_id, **kwargs)

Gets a list of the database software images in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “DELETING”, “DELETED”, “FAILED”, “TERMINATING”, “TERMINATED”, “UPDATING”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • image_type (str) –

    (optional) A filter to return only resources that match the given image type exactly.

    Allowed values are: “GRID_IMAGE”, “DATABASE_IMAGE”

  • image_shape_family (str) –

    (optional) A filter to return only resources that match the given image shape family exactly.

    Allowed values are: “VM_BM_SHAPE”, “EXADATA_SHAPE”, “EXACC_SHAPE”

  • is_upgrade_supported (bool) – (optional) If provided, filters the results to the set of database versions which are supported for Upgrade.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DatabaseSoftwareImageSummary

Return type:

Response

Example:

Click here to see an example of how to use list_database_software_images API.

list_database_upgrade_history_entries(database_id, **kwargs)

Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • upgrade_action (str) –

    (optional) A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.

    Allowed values are: “PRECHECK”, “UPGRADE”, “ROLLBACK”

  • lifecycle_state (str) –

    (optional) A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly.

    Allowed values are: “SUCCEEDED”, “FAILED”, “IN_PROGRESS”

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is ascending.

    Allowed values are: “TIMESTARTED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DatabaseUpgradeHistoryEntrySummary

Return type:

Response

Example:

Click here to see an example of how to use list_database_upgrade_history_entries API.

list_databases(compartment_id, **kwargs)

Gets a list of the databases in the specified Database Home.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • db_home_id (str) –

    (optional) A Database Home `OCID`__.

  • system_id (str) –

    (optional) The `OCID`__ of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive.

    Allowed values are: “DBNAME”, “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “BACKUP_IN_PROGRESS”, “UPGRADING”, “TERMINATING”, “TERMINATED”, “RESTORE_FAILED”, “FAILED”

  • db_name (str) – (optional) A filter to return only resources that match the entire database name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_databases API.

list_db_home_patch_history_entries(db_home_id, **kwargs)

Lists the history of patch operations on the specified Database Home.

Parameters:
  • db_home_id (str) –

    (required) The Database Home `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchHistoryEntrySummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_home_patch_history_entries API.

list_db_home_patches(db_home_id, **kwargs)

Lists patches applicable to the requested Database Home.

Parameters:
  • db_home_id (str) –

    (required) The Database Home `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchSummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_home_patches API.

list_db_homes(compartment_id, **kwargs)

Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • db_system_id (str) –

    (optional) The DB system `OCID`__. If provided, filters the results to the set of database versions which are supported for the DB system.

  • vm_cluster_id (str) –

    (optional) The `OCID`__ of the VM cluster.

  • backup_id (str) –

    (optional) The `OCID`__ of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

  • db_version (str) – (optional) A filter to return only DB Homes that match the specified dbVersion.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbHomeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_homes API.

list_db_nodes(compartment_id, **kwargs)

Lists the database nodes in the specified DB system and compartment. A database node is a server running database software.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • db_system_id (str) –

    (optional) The DB system `OCID`__. If provided, filters the results to the set of database versions which are supported for the DB system.

  • vm_cluster_id (str) –

    (optional) The `OCID`__ of the VM cluster.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) Sort by TIMECREATED. Default order for TIMECREATED is descending.

    Allowed values are: “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbNodeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_nodes API.

list_db_system_patch_history_entries(db_system_id, **kwargs)

Gets the history of the patch actions performed on the specified DB system.

Parameters:
  • db_system_id (str) –

    (required) The DB system `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchHistoryEntrySummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_system_patch_history_entries API.

list_db_system_patches(db_system_id, **kwargs)

Lists the patches applicable to the specified DB system.

Parameters:
  • db_system_id (str) –

    (required) The DB system `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchSummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_system_patches API.

list_db_system_shapes(compartment_id, **kwargs)

Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • availability_domain (str) – (optional) The name of the Availability Domain.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbSystemShapeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_system_shapes API.

list_db_systems(compartment_id, **kwargs)

Lists the DB systems in the specified compartment. You can specify a backupId to list only the DB systems that support creating a database using this backup in this 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.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • backup_id (str) –

    (optional) The `OCID`__ of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MIGRATED”, “MAINTENANCE_IN_PROGRESS”, “NEEDS_ATTENTION”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbSystemSummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_systems API.

list_db_versions(compartment_id, **kwargs)

Gets a list of supported Oracle Database versions.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • db_system_shape (str) – (optional) If provided, filters the results to the set of database versions which are supported for the given shape.
  • db_system_id (str) –

    (optional) The DB system `OCID`__. If provided, filters the results to the set of database versions which are supported for the DB system.

  • storage_management (str) –

    (optional) The DB system storage management option. Used to list database versions available for that storage manager. Valid values are: * ASM - Automatic storage management * LVM - Logical volume management

    Allowed values are: “ASM”, “LVM”

  • is_upgrade_supported (bool) – (optional) If provided, filters the results to the set of database versions which are supported for Upgrade.
  • is_database_software_image_supported (bool) – (optional) If true, filters the results to the set of Oracle Database versions that are supported for OCI database software images.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DbVersionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_db_versions API.

list_exadata_infrastructures(compartment_id, **kwargs)

Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the Exadata Cloud Service infrastructure resources in a compartment, use the list_cloud_exadata_infrastructures() operation.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • opc_request_id (str) – (optional) Unique identifier for the request.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “CREATING”, “REQUIRES_ACTIVATION”, “ACTIVATING”, “ACTIVE”, “ACTIVATION_FAILED”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, “DISCONNECTED”, “MAINTENANCE_IN_PROGRESS”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExadataInfrastructureSummary

Return type:

Response

Example:

Click here to see an example of how to use list_exadata_infrastructures API.

list_external_container_databases(compartment_id, **kwargs)

Gets a list of the external container databases in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “DISPLAYNAME”, “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state.

    Allowed values are: “PROVISIONING”, “NOT_CONNECTED”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExternalContainerDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_external_container_databases API.

list_external_database_connectors(compartment_id, external_database_id, **kwargs)

Gets a list of the external database connectors in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • external_database_id (str) –

    (required) The `OCID`__ of the external database whose connectors will be listed.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “DISPLAYNAME”, “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExternalDatabaseConnectorSummary

Return type:

Response

Example:

Click here to see an example of how to use list_external_database_connectors API.

list_external_non_container_databases(compartment_id, **kwargs)

Gets a list of the ExternalNonContainerDatabases in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “DISPLAYNAME”, “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state.

    Allowed values are: “PROVISIONING”, “NOT_CONNECTED”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExternalNonContainerDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_external_non_container_databases API.

list_external_pluggable_databases(compartment_id, **kwargs)

Gets a list of the create_external_pluggable_database_details() resources in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • opc_request_id (str) – (optional) Unique identifier for the request.
  • external_container_database_id (str) –

    (optional) The ExternalContainerDatabase `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “DISPLAYNAME”, “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state.

    Allowed values are: “PROVISIONING”, “NOT_CONNECTED”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExternalPluggableDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_external_pluggable_databases API.

list_flex_components(compartment_id, **kwargs)

Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • name (str) – (optional) A filter to return only resources that match the entire name given. The match is not case sensitive.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for NAME is ascending. The NAME sort order is case sensitive.

    Allowed values are: “NAME”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FlexComponentCollection

Return type:

Response

Example:

Click here to see an example of how to use list_flex_components API.

list_gi_versions(compartment_id, **kwargs)

Gets a list of supported GI versions for the Exadata Cloud@Customer VM cluster.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • shape (str) – (optional) If provided, filters the results for the given shape.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of GiVersionSummary

Return type:

Response

Example:

Click here to see an example of how to use list_gi_versions API.

list_key_stores(compartment_id, **kwargs)

Gets a list of key stores in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of KeyStoreSummary

Return type:

Response

Example:

Click here to see an example of how to use list_key_stores API.

list_maintenance_runs(compartment_id, **kwargs)

Gets a list of the maintenance runs in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • target_resource_id (str) – (optional) The target resource ID.
  • target_resource_type (str) –

    (optional) The type of the target resource.

    Allowed values are: “AUTONOMOUS_EXADATA_INFRASTRUCTURE”, “AUTONOMOUS_CONTAINER_DATABASE”, “EXADATA_DB_SYSTEM”, “CLOUD_EXADATA_INFRASTRUCTURE”, “EXACC_INFRASTRUCTURE”, “AUTONOMOUS_DATABASE”

  • maintenance_type (str) –

    (optional) The maintenance type.

    Allowed values are: “PLANNED”, “UNPLANNED”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIME_SCHEDULED”, “TIME_ENDED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “SCHEDULED”, “IN_PROGRESS”, “SUCCEEDED”, “SKIPPED”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, “CANCELED”

  • availability_domain (str) – (optional) A filter to return only resources that match the given availability domain exactly.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of MaintenanceRunSummary

Return type:

Response

Example:

Click here to see an example of how to use list_maintenance_runs API.

list_pluggable_databases(**kwargs)

Gets a list of the pluggable databases in a database or compartment. You must provide either a databaseId or compartmentId value.

Parameters:
  • compartment_id (str) –

    (optional) The compartment `OCID`__.

  • database_id (str) –

    (optional) The `OCID`__ of the database.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for PDBNAME is ascending. The PDBNAME sort order is case sensitive.

    Allowed values are: “PDBNAME”, “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, “FAILED”

  • pdb_name (str) – (optional) A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PluggableDatabaseSummary

Return type:

Response

Example:

Click here to see an example of how to use list_pluggable_databases API.

list_vm_cluster_networks(exadata_infrastructure_id, compartment_id, **kwargs)

Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.

Parameters:
  • exadata_infrastructure_id (str) –

    (required) The Exadata infrastructure `OCID`__.

  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “CREATING”, “REQUIRES_VALIDATION”, “VALIDATING”, “VALIDATED”, “VALIDATION_FAILED”, “UPDATING”, “ALLOCATED”, “TERMINATING”, “TERMINATED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VmClusterNetworkSummary

Return type:

Response

Example:

Click here to see an example of how to use list_vm_cluster_networks API.

list_vm_cluster_patch_history_entries(vm_cluster_id, **kwargs)

Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchHistoryEntrySummary

Return type:

Response

Example:

Click here to see an example of how to use list_vm_cluster_patch_history_entries API.

list_vm_cluster_patches(vm_cluster_id, **kwargs)

Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PatchSummary

Return type:

Response

Example:

Click here to see an example of how to use list_vm_cluster_patches API.

list_vm_cluster_update_history_entries(vm_cluster_id, **kwargs)

Gets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • update_type (str) –

    (optional) A filter to return only resources that match the given update type exactly.

    Allowed values are: “GI_UPGRADE”, “GI_PATCH”, “OS_UPDATE”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “IN_PROGRESS”, “SUCCEEDED”, “FAILED”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VmClusterUpdateHistoryEntrySummary

Return type:

Response

Example:

Click here to see an example of how to use list_vm_cluster_update_history_entries API.

list_vm_cluster_updates(vm_cluster_id, **kwargs)

Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Parameters:
  • vm_cluster_id (str) –

    (required) The VM cluster `OCID`__.

  • update_type (str) –

    (optional) A filter to return only resources that match the given update type exactly.

    Allowed values are: “GI_UPGRADE”, “GI_PATCH”, “OS_UPDATE”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “AVAILABLE”, “SUCCESS”, “IN_PROGRESS”, “FAILED”

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VmClusterUpdateSummary

Return type:

Response

Example:

Click here to see an example of how to use list_vm_cluster_updates API.

list_vm_clusters(compartment_id, **kwargs)

Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the list_cloud_vm_clusters() operation.

Parameters:
  • compartment_id (str) –

    (required) The compartment `OCID`__.

  • exadata_infrastructure_id (str) – (optional) If provided, filters the results for the given Exadata Infrastructure.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) – (optional) The pagination token to continue listing from.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state exactly.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VmClusterSummary

Return type:

Response

Example:

Click here to see an example of how to use list_vm_clusters API.

local_clone_pluggable_database(local_clone_pluggable_database_details, pluggable_database_id, **kwargs)

Clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the READ_WRITE openMode to perform the clone operation.

Parameters:
  • local_clone_pluggable_database_details (oci.database.models.LocalClonePluggableDatabaseDetails) – (required) Request to clone a pluggable database locally.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PluggableDatabase

Return type:

Response

Example:

Click here to see an example of how to use local_clone_pluggable_database API.

migrate_exadata_db_system_resource_model(db_system_id, **kwargs)

Migrates the Exadata DB system to the new `Exadata resource model`__. All related resources will be migrated.

Parameters:
  • db_system_id (str) –

    (required) The DB system `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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExadataDbSystemMigration

Return type:

Response

Example:

Click here to see an example of how to use migrate_exadata_db_system_resource_model API.

migrate_vault_key(database_id, migrate_vault_key_details, **kwargs)

Changes encryption key management from customer-managed, using the `Vault service`__, to Oracle-managed.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • migrate_vault_key_details (oci.database.models.MigrateVaultKeyDetails) – (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

Example:

Click here to see an example of how to use migrate_vault_key API.

modify_database_management(database_id, modify_database_management_details, **kwargs)

Updates one or more attributes of the Database Management service for the database.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • modify_database_management_details (oci.database.models.ModifyDatabaseManagementDetails) – (required) The data to update one or more attributes of the Database Management Service for the 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

Example:

Click here to see an example of how to use modify_database_management API.

register_autonomous_database_data_safe(autonomous_database_id, **kwargs)

Asynchronously registers 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.
  • register_autonomous_database_data_safe_details (oci.database.models.RegisterAutonomousDatabaseDataSafeDetails) – (optional) Request to register 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use register_autonomous_database_data_safe API.

reinstate_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, **kwargs)

Reinstates a disabled standby Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter, to an active standby 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`__.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabaseDataguardAssociation

Return type:

Response

Example:

Click here to see an example of how to use reinstate_autonomous_container_database_dataguard_association API.

reinstate_data_guard_association(database_id, data_guard_association_id, reinstate_data_guard_association_details, **kwargs)

Reinstates the database identified by the databaseId parameter into the standby role in a Data Guard association.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • data_guard_association_id (str) –

    (required) The Data Guard association’s `OCID`__.

  • reinstate_data_guard_association_details (oci.database.models.ReinstateDataGuardAssociationDetails) – (required) A request to reinstate a database in a standby role.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

Example:

Click here to see an example of how to use reinstate_data_guard_association API.

remote_clone_pluggable_database(remote_clone_pluggable_database_details, pluggable_database_id, **kwargs)

Clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the READ_WRITE openMode when performing the clone.

Parameters:
  • remote_clone_pluggable_database_details (oci.database.models.RemoteClonePluggableDatabaseDetails) – (required) Request to clone a pluggable database (PDB) to a different database (CDB) from the source PDB.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PluggableDatabase

Return type:

Response

Example:

Click here to see an example of how to use remote_clone_pluggable_database API.

restart_autonomous_container_database(autonomous_container_database_id, **kwargs)

Rolling restarts the specified Autonomous Container Database.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

Example:

Click here to see an example of how to use restart_autonomous_container_database API.

restart_autonomous_database(autonomous_database_id, **kwargs)

Restarts 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use restart_autonomous_database API.

restore_autonomous_database(autonomous_database_id, restore_autonomous_database_details, **kwargs)

Restores an Autonomous Database based on the provided request parameters.

Parameters:
  • autonomous_database_id (str) –

    (required) The database `OCID`__.

  • restore_autonomous_database_details (oci.database.models.RestoreAutonomousDatabaseDetails) – (required) Request to perform an Autonomous Database restore.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use restore_autonomous_database API.

restore_database(database_id, restore_database_details, **kwargs)

Restore a Database based on the request parameters you provide.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • restore_database_details (oci.database.models.RestoreDatabaseDetails) – (required) Request to perform database restore.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

Example:

Click here to see an example of how to use restore_database API.

rotate_autonomous_container_database_encryption_key(autonomous_container_database_id, **kwargs)

Creates a new version of an existing `Vault service`__ key.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous 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_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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabase

Return type:

Response

Example:

Click here to see an example of how to use rotate_autonomous_container_database_encryption_key API.

rotate_autonomous_database_encryption_key(autonomous_database_id, **kwargs)

Rotate existing AutonomousDatabase `Vault service`__ key.

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use rotate_autonomous_database_encryption_key API.

rotate_ords_certs(autonomous_exadata_infrastructure_id, **kwargs)

Rotates Oracle REST Data Services (ORDS) certs for an Autonomous Exadata Infrastructure resource.

Parameters:
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous 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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use rotate_ords_certs API.

rotate_ssl_certs(autonomous_exadata_infrastructure_id, **kwargs)

Rotates SSL certs for an Autonomous Exadata Infrastructure resource.

Parameters:
  • autonomous_exadata_infrastructure_id (str) –

    (required) The Autonomous 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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use rotate_ssl_certs API.

rotate_vault_key(database_id, **kwargs)

Creates a new version of an existing `Vault service`__ key.

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Database

Return type:

Response

Example:

Click here to see an example of how to use rotate_vault_key API.

scan_external_container_database_pluggable_databases(external_container_database_id, external_database_connector_id, **kwargs)

Scans for pluggable databases in the specified external container database. This operation will return un-registered pluggable databases in the GetWorkRequest operation.

Parameters:
  • external_container_database_id (str) –

    (required) The ExternalContainerDatabase `OCID`__.

  • external_database_connector_id (str) –

    (required) The `OCID`__ of the external database connector resource (ExternalDatabaseConnectorId).

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use scan_external_container_database_pluggable_databases API.

start_autonomous_database(autonomous_database_id, **kwargs)

Starts 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use start_autonomous_database API.

start_pluggable_database(pluggable_database_id, **kwargs)

Starts a stopped pluggable database. The openMode value of the pluggable database will be READ_WRITE upon completion.

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PluggableDatabase

Return type:

Response

Example:

Click here to see an example of how to use start_pluggable_database API.

stop_autonomous_database(autonomous_database_id, **kwargs)

Stops 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use stop_autonomous_database API.

stop_pluggable_database(pluggable_database_id, **kwargs)

Stops a pluggable database. The openMode value of the pluggable database will be MOUNTED upon completion.

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PluggableDatabase

Return type:

Response

Example:

Click here to see an example of how to use stop_pluggable_database API.

switchover_autonomous_container_database_dataguard_association(autonomous_container_database_id, autonomous_container_database_dataguard_association_id, **kwargs)

Switches over the primary Autonomous Container Database of an Autonomous Data Guard peer association to standby role. The standby Autonomous Container Database associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary Autonomous Container Database role.

A switchover incurs no data loss.

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousContainerDatabaseDataguardAssociation

Return type:

Response

Example:

Click here to see an example of how to use switchover_autonomous_container_database_dataguard_association API.

switchover_autonomous_database(autonomous_database_id, **kwargs)

Initiates a switchover of the specified Autonomous Database to the associated standby database. Applicable only to databases with Autonomous Data Guard enabled. To perform a switchover to a standby located in a remote region, specify the `OCID`__ of the remote standby using the peerDbId parameter.

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`__ of the Autonomous Data Guard standby database located in a different (remote) region from the source primary Autonomous 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutonomousDatabase

Return type:

Response

Example:

Click here to see an example of how to use switchover_autonomous_database API.

switchover_data_guard_association(database_id, data_guard_association_id, switchover_data_guard_association_details, **kwargs)

Performs a switchover to transition the primary database of a Data Guard association into a standby role. The standby database associated with the dataGuardAssociationId assumes the primary database role.

A switchover guarantees no data loss.

Parameters:
  • database_id (str) –

    (required) The database `OCID`__.

  • data_guard_association_id (str) –

    (required) The Data Guard association’s `OCID`__.

  • switchover_data_guard_association_details (oci.database.models.SwitchoverDataGuardAssociationDetails) – (required) Request to swtichover a primary to a standby.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataGuardAssociation

Return type:

Response

Example:

Click here to see an example of how to use switchover_data_guard_association API.

terminate_autonomous_container_database(autonomous_container_database_id, **kwargs)

Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it.

Parameters:
  • autonomous_container_database_id (str) –

    (required) The Autonomous 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 on