DbManagementClient¶

class oci.database_management.DbManagementClient(config, **kwargs)¶

Use the Database Management API to monitor and manage resources such as Oracle Databases, MySQL Databases, and External Database Systems. For more information, see [Database Management](/iaas/database-management/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_data_files`(managed_database_id, …)	Adds data files or temp files to the tablespace.
`add_managed_database_to_managed_database_group`(…)	Adds a Managed Database to a specific Managed Database Group.
`addm_tasks`(managed_database_id, time_start, …)	Lists the metadata for each ADDM task who’s end snapshot time falls within the provided start and end time.
`change_database_parameters`(…)	Changes database parameter values.
`change_db_management_private_endpoint_compartment`(…)	Moves the Database Management private endpoint and its dependent resources to the specified compartment.
`change_external_db_system_compartment`(…)	Moves the external DB system and its related resources (excluding databases) to the specified compartment.
`change_external_exadata_infrastructure_compartment`(…)	Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.
`change_job_compartment`(job_id, …)	Moves a job.
`change_managed_database_group_compartment`(…)	Moves a Managed Database Group to a different compartment.
`change_named_credential_compartment`(…)	Moves a named credential to a different compartment.
`change_plan_retention`(managed_database_id, …)	Changes the retention period of unused plans.
`change_space_budget`(managed_database_id, …)	Changes the disk space limit for the SQL Management Base.
`change_sql_plan_baselines_attributes`(…)	Changes one or more attributes of a single plan or all plans associated with a SQL statement.
`check_external_db_system_connector_connection_status`(…)	Checks the status of the external DB system component connection specified in this connector.
`check_external_exadata_storage_connector`(…)	Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.
`configure_automatic_capture_filters`(…)	Configures automatic capture filters to capture only those statements that match the filter criteria.
`configure_automatic_spm_evolve_advisor_task`(…)	Configures the Automatic SPM Evolve Advisor task SYS_AUTO_SPM_EVOLVE_TASK by specifying task parameters.
`create_db_management_private_endpoint`(…)	Creates a new Database Management private endpoint.
`create_external_db_system`(…)	Creates an external DB system and its related resources.
`create_external_db_system_connector`(…)	Creates a new external connector.
`create_external_db_system_discovery`(…)	Creates an external DB system discovery resource and initiates the discovery process.
`create_external_exadata_infrastructure`(…)	Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure.
`create_external_exadata_storage_connector`(…)	Creates the Exadata storage server connector after validating the connection information.
`create_job`(create_job_details, **kwargs)	Creates a job to be executed on a Managed Database or Managed Database Group.
`create_managed_database_group`(…)	Creates a Managed Database Group.
`create_named_credential`(…)	Creates a named credential.
`create_tablespace`(managed_database_id, …)	Creates a tablespace within the Managed Database specified by managedDatabaseId.
`delete_db_management_private_endpoint`(…)	Deletes a specific Database Management private endpoint.
`delete_external_db_system`(…)	Deletes the external DB system specified by externalDbSystemId.
`delete_external_db_system_connector`(…)	Deletes the external connector specified by externalDbSystemConnectorId.
`delete_external_db_system_discovery`(…)	Deletes the external DB system discovery resource specified by externalDbSystemDiscoveryId.
`delete_external_exadata_infrastructure`(…)	Deletes the Exadata infrastructure specified by externalExadataInfrastructureId.
`delete_external_exadata_storage_connector`(…)	Deletes the Exadata storage server connector specified by exadataStorageConnectorId.
`delete_job`(job_id, **kwargs)	Deletes the job specified by jobId.
`delete_managed_database_group`(…)	Deletes the Managed Database Group specified by managedDatabaseGroupId.
`delete_named_credential`(named_credential_id, …)	Deletes the named credential specified by namedCredentialId.
`delete_preferred_credential`(…)	Deletes the preferred credential based on the credentialName.
`disable_automatic_initial_plan_capture`(…)	Disables automatic initial plan capture.
`disable_automatic_spm_evolve_advisor_task`(…)	Disables the Automatic SPM Evolve Advisor task.
`disable_autonomous_database_management_feature`(…)	Disables a Database Management feature for the specified Autonomous Database.
`disable_database_management_feature`(…)	Disables a Database Management feature for the specified Oracle cloud database.
`disable_external_container_database_management_feature`(…)	Disables a Database Management feature for the specified external container database.
`disable_external_db_system_database_management`(…)	Disables Database Management service for all the components of the specified external DB system (except databases).
`disable_external_db_system_stack_monitoring`(…)	Disables Stack Monitoring for all the components of the specified external DB system (except databases).
`disable_external_exadata_infrastructure_management`(…)	Disables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId.
`disable_external_non_container_database_management_feature`(…)	Disables a Database Management feature for the specified external non-container database.
`disable_external_pluggable_database_management_feature`(…)	Disables a Database Management feature for the specified external pluggable database.
`disable_high_frequency_automatic_spm_evolve_advisor_task`(…)	Disables the high-frequency Automatic SPM Evolve Advisor task.
`disable_pluggable_database_management_feature`(…)	Disables a Database Management feature for the specified Oracle cloud pluggable database.
`disable_sql_plan_baselines_usage`(…)	Disables the use of SQL plan baselines stored in SQL Management Base.
`discover_external_exadata_infrastructure`(…)	Completes the Exadata system prechecking on the following:
`drop_sql_plan_baselines`(managed_database_id, …)	Drops a single plan or all plans associated with a SQL statement.
`drop_tablespace`(managed_database_id, …)	Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
`enable_automatic_initial_plan_capture`(…)	Enables automatic initial plan capture.
`enable_automatic_spm_evolve_advisor_task`(…)	Enables the Automatic SPM Evolve Advisor task.
`enable_autonomous_database_management_feature`(…)	Enables a Database Management feature for the specified Autonomous Database.
`enable_database_management_feature`(…)	Enables a Database Management feature for the specified cloud database.
`enable_external_container_database_management_feature`(…)	Enables a Database Management feature for the specified external container database.
`enable_external_db_system_database_management`(…)	Enables Database Management service for all the components of the specified external DB system (except databases).
`enable_external_db_system_stack_monitoring`(…)	Enables Stack Monitoring for all the components of the specified external DB system (except databases).
`enable_external_exadata_infrastructure_management`(…)	Enables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId.
`enable_external_non_container_database_management_feature`(…)	Enables Database Management feature for the specified external non-container database.
`enable_external_pluggable_database_management_feature`(…)	Enables a Database Management feature for the specified external pluggable database.
`enable_high_frequency_automatic_spm_evolve_advisor_task`(…)	Enables the high-frequency Automatic SPM Evolve Advisor task.
`enable_pluggable_database_management_feature`(…)	Enables a Database Management feature for the specified Oracle cloud pluggable database.
`enable_sql_plan_baselines_usage`(…)	Enables the use of SQL plan baselines stored in SQL Management Base.
`generate_awr_snapshot`(managed_database_id, …)	Creates an AWR snapshot for the target database.
`get_awr_db_report`(managed_database_id, …)	Gets the AWR report for the specific database.
`get_awr_db_sql_report`(managed_database_id, …)	Gets the SQL health check report for one SQL of the specific database.
`get_cluster_cache_metric`(…)	Gets the metrics related to cluster cache for the Oracle Real Application Clusters (Oracle RAC) database specified by managedDatabaseId.
`get_database_fleet_health_metrics`(…)	Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group.
`get_database_home_metrics`(…)	Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.
`get_dataguard_performance_metrics`(…)	Gets a historical summary of the Database Guard performance metrics for Managed Databases.
`get_db_management_private_endpoint`(…)	Gets the details of a specific Database Management private endpoint.
`get_external_asm`(external_asm_id, **kwargs)	Gets the details for the external ASM specified by externalAsmId.
`get_external_asm_configuration`(…)	Gets configuration details including disk groups for the external ASM specified by externalAsmId.
`get_external_asm_instance`(…)	Gets the details for the external ASM instance specified by externalAsmInstanceId.
`get_external_cluster`(external_cluster_id, …)	Gets the details for the external cluster specified by externalClusterId.
`get_external_cluster_instance`(…)	Gets the details for the external cluster instance specified by externalClusterInstanceId.
`get_external_db_home`(external_db_home_id, …)	Gets the details for the external DB home specified by externalDbHomeId.
`get_external_db_node`(external_db_node_id, …)	Gets the details for the external DB node specified by externalDbNodeId.
`get_external_db_system`(…)	Gets the details for the external DB system specified by externalDbSystemId.
`get_external_db_system_connector`(…)	Gets the details for the external connector specified by externalDbSystemConnectorId.
`get_external_db_system_discovery`(…)	Gets the details for the external DB system discovery resource specified by externalDbSystemDiscoveryId.
`get_external_exadata_infrastructure`(…)	Gets the details for the Exadata infrastructure specified by externalExadataInfrastructureId.
`get_external_exadata_storage_connector`(…)	Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.
`get_external_exadata_storage_grid`(…)	Gets the details for the Exadata storage server grid specified by exadataStorageGridId.
`get_external_exadata_storage_server`(…)	Gets the summary for the Exadata storage server specified by exadataStorageServerId.
`get_external_listener`(external_listener_id, …)	Gets the details for the external listener specified by externalListenerId.
`get_iorm_plan`(…)	Get the IORM plan from the specific Exadata storage server.
`get_job`(job_id, **kwargs)	Gets the details for the job specified by jobId.
`get_job_execution`(job_execution_id, **kwargs)	Gets the details for the job execution specified by jobExecutionId.
`get_job_run`(job_run_id, **kwargs)	Gets the details for the job run specified by jobRunId.
`get_managed_database`(managed_database_id, …)	Gets the details for the Managed Database specified by managedDatabaseId.
`get_managed_database_group`(…)	Gets the details for the Managed Database Group specified by managedDatabaseGroupId.
`get_named_credential`(named_credential_id, …)	Gets the details for the named credential specified by namedCredentialId.
`get_open_alert_history`(…)	Gets the open alerts from the specified Exadata storage server.
`get_optimizer_statistics_advisor_execution`(…)	Gets a comprehensive report of the Optimizer Statistics Advisor execution, which includes details of the Managed Database, findings, recommendations, rationale, and examples.
`get_optimizer_statistics_advisor_execution_script`(…)	Gets the Oracle system-generated script for the specified Optimizer Statistics Advisor execution.
`get_optimizer_statistics_collection_operation`(…)	Gets a detailed report of the Optimizer Statistics Collection operation for the specified Managed Database.
`get_pdb_metrics`(managed_database_id, …)	Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each PDB within a specific CDB.
`get_peer_database_metrics`(…)	Gets a comparative summary of the baseline and target values of the Data Guard performance metrics for Managed Databases.
`get_preferred_credential`(…)	Gets the preferred credential details for a Managed Database based on credentialName.
`get_sql_plan_baseline`(managed_database_id, …)	Gets the SQL plan baseline details for the specified planName.
`get_sql_plan_baseline_configuration`(…)	Gets the configuration details of SQL plan baselines for the specified Managed Database.
`get_tablespace`(managed_database_id, …)	Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
`get_top_sql_cpu_activity`(…)	Gets the SQL IDs with the top CPU activity from the Exadata storage server.
`get_user`(managed_database_id, user_name, …)	Gets the details of the user specified by managedDatabaseId and userName.
`get_work_request`(work_request_id, **kwargs)	Gets the status of the work request with the given Work Request ID
`implement_optimizer_statistics_advisor_recommendations`(…)	Asynchronously implements the findings and recommendations of the Optimizer Statistics Advisor execution.
`list_asm_properties`(managed_database_id, …)	Gets the list of ASM properties for the specified managedDatabaseId.
`list_associated_databases`(…)	Gets the list of databases using a specific Database Management private endpoint.
`list_awr_db_snapshots`(managed_database_id, …)	Lists AWR snapshots for the specified database in the AWR.
`list_awr_dbs`(managed_database_id, **kwargs)	Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.
`list_consumer_group_privileges`(…)	Gets the list of consumer group privileges granted to a specific user.
`list_cursor_cache_statements`(…)	Lists the SQL statements from shared SQL area, also called the cursor cache.
`list_data_access_containers`(…)	Gets the list of containers for a specific user.
`list_database_parameters`(…)	Gets the list of database parameters for the specified Managed Database.
`list_db_management_private_endpoints`(…)	Gets a list of Database Management private endpoints.
`list_external_asm_disk_groups`(…)	Lists ASM disk groups for the external ASM specified by externalAsmId.
`list_external_asm_instances`(**kwargs)	Lists the ASM instances in the specified external ASM.
`list_external_asm_users`(external_asm_id, …)	Lists ASM users for the external ASM specified by externalAsmId.
`list_external_asms`(**kwargs)	Lists the ASMs in the specified external DB system.
`list_external_cluster_instances`(**kwargs)	Lists the cluster instances in the specified external cluster.
`list_external_clusters`(**kwargs)	Lists the clusters in the specified external DB system.
`list_external_databases`(**kwargs)	Lists the external databases in the specified compartment or in the specified DB system.
`list_external_db_homes`(**kwargs)	Lists the DB homes in the specified external DB system.
`list_external_db_nodes`(**kwargs)	Lists the external DB nodes in the specified external DB system.
`list_external_db_system_connectors`(**kwargs)	Lists the external connectors in the specified external DB system.
`list_external_db_system_discoveries`(…)	Lists the external DB system discovery resources in the specified compartment.
`list_external_db_systems`(compartment_id, …)	Lists the external DB systems in the specified compartment.
`list_external_exadata_infrastructures`(…)	Lists the Exadata infrastructure resources in the specified compartment.
`list_external_exadata_storage_connectors`(…)	Lists the Exadata storage server connectors for the specified Exadata infrastructure.
`list_external_exadata_storage_servers`(…)	Lists the Exadata storage servers for the specified Exadata infrastructure.
`list_external_listener_services`(…)	Lists the database services registered with the specified external listener for the specified Managed Database.
`list_external_listeners`(**kwargs)	Lists the listeners in the specified external DB system.
`list_job_executions`(compartment_id, **kwargs)	Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group in a specific compartment.
`list_job_runs`(compartment_id, **kwargs)	Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment.
`list_jobs`(compartment_id, **kwargs)	Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment.
`list_managed_database_groups`(compartment_id, …)	Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment.
`list_managed_databases`(compartment_id, **kwargs)	Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment.
`list_named_credentials`(compartment_id, **kwargs)	Gets a single named credential specified by the name or all the named credentials in a specific compartment.
`list_object_privileges`(managed_database_id, …)	Gets the list of object privileges granted to a specific user.
`list_optimizer_statistics_advisor_executions`(…)	Lists the details of the Optimizer Statistics Advisor task executions, such as their duration, and the number of findings, if any.
`list_optimizer_statistics_collection_aggregations`(…)	Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database.
`list_optimizer_statistics_collection_operations`(…)	Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database.
`list_preferred_credentials`(…)	Gets the list of preferred credentials for a given Managed Database.
`list_proxied_for_users`(managed_database_id, …)	Gets the list of users on whose behalf the current user acts as proxy.
`list_proxy_users`(managed_database_id, …)	Gets the list of proxy users for the current user.
`list_roles`(managed_database_id, user_name, …)	Gets the list of roles granted to a specific user.
`list_sql_plan_baseline_jobs`(…)	Lists the database jobs used for loading SQL plan baselines in the specified Managed Database.
`list_sql_plan_baselines`(managed_database_id, …)	Lists the SQL plan baselines for the specified Managed Database.
`list_system_privileges`(managed_database_id, …)	Gets the list of system privileges granted to a specific user.
`list_table_statistics`(managed_database_id, …)	Lists the database table statistics grouped by different statuses such as Not Stale Stats, Stale Stats, and No Stats.
`list_tablespaces`(managed_database_id, **kwargs)	Gets the list of tablespaces for the specified managedDatabaseId.
`list_users`(managed_database_id, **kwargs)	Gets the list of users for the specified managedDatabaseId.
`list_work_request_errors`(work_request_id, …)	Returns a paginated list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a paginated list of logs for a given work request.
`list_work_requests`(compartment_id, **kwargs)	The list of work requests in a specific compartment was retrieved successfully.
`load_sql_plan_baselines_from_awr`(…)	Loads plans from Automatic Workload Repository (AWR) snapshots.
`load_sql_plan_baselines_from_cursor_cache`(…)	Loads plans for statements directly from the shared SQL area, also called the cursor cache.
`modify_autonomous_database_management_feature`(…)	Modifies the Database Management feature for the specified Autonomous Database.
`modify_database_management_feature`(…)	Modifies a Database Management feature for the specified Oracle cloud database.
`modify_pluggable_database_management_feature`(…)	Modifies the Database Management feature for the specified Oracle cloud pluggable database.
`patch_external_db_system_discovery`(…)	Patches the external DB system discovery specified by externalDbSystemDiscoveryId.
`remove_data_file`(managed_database_id, …)	Removes a data file or temp file from the tablespace.
`remove_managed_database_from_managed_database_group`(…)	Removes a Managed Database from a Managed Database Group.
`reset_database_parameters`(…)	Resets database parameter values to their default or startup values.
`resize_data_file`(managed_database_id, …)	Resizes a data file or temp file within the tablespace.
`run_historic_addm`(managed_database_id, …)	Creates and executes a historic ADDM task using the specified AWR snapshot IDs.
`summarize_awr_db_cpu_usages`(…)	Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.
`summarize_awr_db_metrics`(…)	Summarizes the metric samples for the specified database in the AWR.
`summarize_awr_db_parameter_changes`(…)	Summarizes the database parameter change history for one database parameter of the specified database in AWR.
`summarize_awr_db_parameters`(…)	Summarizes the database parameter history for the specified database in AWR.
`summarize_awr_db_snapshot_ranges`(…)	Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.
`summarize_awr_db_sysstats`(…)	Summarizes the AWR SYSSTAT sample data for the specified database in AWR.
`summarize_awr_db_top_wait_events`(…)	Summarizes the AWR top wait events.
`summarize_awr_db_wait_event_buckets`(…)	Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.
`summarize_awr_db_wait_events`(…)	Summarizes the AWR wait event sample data for the specified database in the AWR.
`summarize_external_asm_metrics`(…)	Gets metrics for the external ASM specified by externalAsmId.
`summarize_external_cluster_metrics`(…)	Gets metrics for the external cluster specified by externalClusterId.
`summarize_external_db_node_metrics`(…)	Gets metrics for the external DB node specified by externalDbNodeId.
`summarize_external_db_system_availability_metrics`(…)	Gets availability metrics for the components present in the external DB system specified by externalDbSystemId.
`summarize_external_listener_metrics`(…)	Gets metrics for the external listener specified by externalListenerId.
`summarize_job_executions_statuses`(…)	Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment.
`summarize_managed_database_availability_metrics`(…)	Gets the availability metrics related to managed database for the Oracle database specified by managedDatabaseId.
`summarize_sql_plan_baselines`(…)	Gets the number of SQL plan baselines aggregated by their attributes.
`summarize_sql_plan_baselines_by_last_execution`(…)	Gets the number of SQL plan baselines aggregated by the age of their last execution in weeks.
`test_named_credential`(named_credential_id, …)	Tests the named credential.
`test_preferred_credential`(…)	Tests the preferred credential.
`update_db_management_private_endpoint`(…)	Updates one or more attributes of a specific Database Management private endpoint.
`update_external_asm`(external_asm_id, …)	Updates the external ASM specified by externalAsmId.
`update_external_asm_instance`(…)	Updates the external ASM instance specified by externalAsmInstanceId.
`update_external_cluster`(external_cluster_id, …)	Updates the external cluster specified by externalClusterId.
`update_external_cluster_instance`(…)	Updates the external cluster instance specified by externalClusterInstanceId.
`update_external_db_home`(external_db_home_id, …)	Updates the external DB home specified by externalDbHomeId.
`update_external_db_node`(external_db_node_id, …)	Updates the external DB node specified by externalDbNodeId.
`update_external_db_system`(…)	Updates the external DB system specified by externalDbSystemId.
`update_external_db_system_connector`(…)	Updates the external connector specified by externalDbSystemConnectorId.
`update_external_db_system_discovery`(…)	Updates the external DB system discovery specified by externalDbSystemDiscoveryId.
`update_external_exadata_infrastructure`(…)	Updates the details for the Exadata infrastructure specified by externalExadataInfrastructureId.
`update_external_exadata_storage_connector`(…)	Updates the Exadata storage server connector specified by exadataStorageConnectorId.
`update_external_exadata_storage_grid`(…)	Updates the Exadata storage server grid specified by exadataStorageGridId.
`update_external_exadata_storage_server`(…)	Updates the Exadata storage server specified by exadataStorageServerId.
`update_external_listener`(…)	Updates the external listener specified by externalListenerId.
`update_job`(job_id, update_job_details, **kwargs)	Updates the details for the recurring scheduled job specified by jobId.
`update_managed_database`(managed_database_id, …)	Updates the Managed Database specified by managedDatabaseId.
`update_managed_database_group`(…)	Updates the Managed Database Group specified by managedDatabaseGroupId.
`update_named_credential`(named_credential_id, …)	Updates the named credential specified by namedCredentialId.
`update_preferred_credential`(…)	Updates the preferred credential based on the credentialName.
`update_tablespace`(managed_database_id, …)	Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

__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.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

add_data_files(managed_database_id, tablespace_name, add_data_files_details, **kwargs)¶

Adds data files or temp files to the tablespace.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. tablespace_name (str) – (required) The name of the tablespace. add_data_files_details (oci.database_management.models.AddDataFilesDetails) – (required) The details required to add data files or temp files to the tablespace. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TablespaceAdminStatus`
Return type:	`Response`
Example:

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

add_managed_database_to_managed_database_group(managed_database_group_id, add_managed_database_to_managed_database_group_details, **kwargs)¶

Adds a Managed Database to a specific Managed Database Group. After the database is added, it will be included in the management activities performed on the Managed Database Group.

Parameters:	managed_database_group_id (str) – (required) The OCID of the Managed Database Group. add_managed_database_to_managed_database_group_details (oci.database_management.models.AddManagedDatabaseToManagedDatabaseGroupDetails) – (required) The Managed Database details required to add the Managed Database to a Managed Database Group. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

addm_tasks(managed_database_id, time_start, time_end, **kwargs)¶

Lists the metadata for each ADDM task who’s end snapshot time falls within the provided start and end time. Details include the name of the ADDM task, description, user, status and creation date time.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. time_start (datetime) – (required) The beginning of the time range to search for ADDM tasks as defined by date-time RFC3339 format. time_end (datetime) – (required) The end of the time range to search for ADDM tasks as defined by date-time RFC3339 format. opc_request_id (str) – (optional) Unique identifier for the request. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The option to sort the list of ADDM tasks. Allowed values are: “TASK_NAME”, “TASK_ID”, “DESCRIPTION”, “DB_USER”, “STATUS”, “TIME_CREATED”, “BEGIN_TIME”, “END_TIME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmTasksCollection`
Return type:	`Response`
Example:

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

change_database_parameters(managed_database_id, change_database_parameters_details, **kwargs)¶

Changes database parameter values. There are two kinds of database parameters:

Dynamic parameters: They can be changed for the current Oracle

Database instance. The changes take effect immediately. - Static parameters: They cannot be changed for the current instance. You must change these parameters and then restart the database before changes take effect.

Note: If the instance is started using a text initialization parameter file, the parameter changes are applicable only for the current instance. You must update them manually to be passed to a future instance.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. change_database_parameters_details (oci.database_management.models.ChangeDatabaseParametersDetails) – (required) The details required to change database parameter values. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UpdateDatabaseParametersResult`
Return type:	`Response`
Example:

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

change_db_management_private_endpoint_compartment(db_management_private_endpoint_id, change_db_management_private_endpoint_compartment_details, **kwargs)¶

Moves the Database Management private endpoint and its dependent resources to the specified compartment.

Parameters:	db_management_private_endpoint_id (str) – (required) The OCID of the Database Management private endpoint. change_db_management_private_endpoint_compartment_details (oci.database_management.models.ChangeDbManagementPrivateEndpointCompartmentDetails) – (required) The details used to move the Database Management private endpoint to another compartment. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_external_db_system_compartment(external_db_system_id, change_external_db_system_compartment_details, **kwargs)¶

Moves the external DB system and its related resources (excluding databases) to the specified compartment.

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. change_external_db_system_compartment_details (oci.database_management.models.ChangeExternalDbSystemCompartmentDetails) – (required) The OCID of the compartment to which the external DB system should be moved. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_external_exadata_infrastructure_compartment(external_exadata_infrastructure_id, change_external_exadata_infrastructure_compartment_details, **kwargs)¶

Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.

Parameters:	external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. change_external_exadata_infrastructure_compartment_details (oci.database_management.models.ChangeExternalExadataInfrastructureCompartmentDetails) – (required) The details required to move the Exadata infrastructure from one compartment to another. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_job_compartment(job_id, change_job_compartment_details, **kwargs)¶

Moves a job.

Parameters:	job_id (str) – (required) The identifier of the job. change_job_compartment_details (oci.database_management.models.ChangeJobCompartmentDetails) – (required) The OCID of the compartment to move the job to. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_managed_database_group_compartment(managed_database_group_id, change_managed_database_group_compartment_details, **kwargs)¶

Moves a Managed Database Group to a different compartment. The destination compartment must not have a Managed Database Group with the same name.

Parameters:	managed_database_group_id (str) – (required) The OCID of the Managed Database Group. change_managed_database_group_compartment_details (oci.database_management.models.ChangeManagedDatabaseGroupCompartmentDetails) – (required) The OCID of the compartment to move the Managed Database Group to. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_named_credential_compartment(named_credential_id, change_named_credential_compartment_details, **kwargs)¶

Moves a named credential to a different compartment. The destination compartment must not have a named credential with the same name.

Parameters:	named_credential_id (str) – (required) The OCID of the named credential. change_named_credential_compartment_details (oci.database_management.models.ChangeNamedCredentialCompartmentDetails) – (required) The OCID of the compartment to which the named credential should be moved. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_plan_retention(managed_database_id, change_plan_retention_details, **kwargs)¶

Changes the retention period of unused plans. The period can range between 5 and 523 weeks.

The database purges plans that have not been used for longer than the plan retention period.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. change_plan_retention_details (oci.database_management.models.ChangePlanRetentionDetails) – (required) The details required to change the plan retention period. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_space_budget(managed_database_id, change_space_budget_details, **kwargs)¶

Changes the disk space limit for the SQL Management Base. The allowable range for this limit is between 1% and 50%.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. change_space_budget_details (oci.database_management.models.ChangeSpaceBudgetDetails) – (required) The details required to change the disk space limit for the SQL Management Base. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_sql_plan_baselines_attributes(managed_database_id, change_sql_plan_baselines_attributes_details, **kwargs)¶

Changes one or more attributes of a single plan or all plans associated with a SQL statement.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. change_sql_plan_baselines_attributes_details (oci.database_management.models.ChangeSqlPlanBaselinesAttributesDetails) – (required) The details required to change SQL plan baseline attributes. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

check_external_db_system_connector_connection_status(external_db_system_connector_id, **kwargs)¶

Checks the status of the external DB system component connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.

Parameters:	external_db_system_connector_id (str) – (required) The OCID of the external connector. 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) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemConnector`
Return type:	`Response`
Example:

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

check_external_exadata_storage_connector(external_exadata_storage_connector_id, **kwargs)¶

Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.

Parameters:	external_exadata_storage_connector_id (str) – (required) The OCID of the connector to the Exadata storage server. 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) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageConnectorStatus`
Return type:	`Response`
Example:

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

configure_automatic_capture_filters(managed_database_id, configure_automatic_capture_filters_details, **kwargs)¶

Configures automatic capture filters to capture only those statements that match the filter criteria.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. configure_automatic_capture_filters_details (oci.database_management.models.ConfigureAutomaticCaptureFiltersDetails) – (required) The details required to configure automatic capture filters. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

configure_automatic_spm_evolve_advisor_task(managed_database_id, configure_automatic_spm_evolve_advisor_task_details, **kwargs)¶

Configures the Automatic SPM Evolve Advisor task SYS_AUTO_SPM_EVOLVE_TASK by specifying task parameters. As the task is owned by SYS, only SYS can set task parameters.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. configure_automatic_spm_evolve_advisor_task_details (oci.database_management.models.ConfigureAutomaticSpmEvolveAdvisorTaskDetails) – (required) The configuration details of the Automatic SPM Evolve Advisor task. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

create_db_management_private_endpoint(create_db_management_private_endpoint_details, **kwargs)¶

Creates a new Database Management private endpoint.

Parameters:	create_db_management_private_endpoint_details (oci.database_management.models.CreateDbManagementPrivateEndpointDetails) – (required) Details used to create a new Database Management private endpoint. 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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DbManagementPrivateEndpoint`
Return type:	`Response`
Example:

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

create_external_db_system(create_external_db_system_details, **kwargs)¶

Creates an external DB system and its related resources.

Parameters:	create_external_db_system_details (oci.database_management.models.CreateExternalDbSystemDetails) – (required) The details required to create an external DB system. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystem`
Return type:	`Response`
Example:

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

create_external_db_system_connector(create_external_db_system_connector_details, **kwargs)¶

Creates a new external connector.

Parameters:	create_external_db_system_connector_details (oci.database_management.models.CreateExternalDbSystemConnectorDetails) – (required) The details required to create an external connector. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemConnector`
Return type:	`Response`
Example:

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

create_external_db_system_discovery(create_external_db_system_discovery_details, **kwargs)¶

Creates an external DB system discovery resource and initiates the discovery process.

Parameters:	create_external_db_system_discovery_details (oci.database_management.models.CreateExternalDbSystemDiscoveryDetails) – (required) The details required to create an external DB system discovery. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemDiscovery`
Return type:	`Response`
Example:

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

create_external_exadata_infrastructure(create_external_exadata_infrastructure_details, **kwargs)¶

Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure. The following resource/subresources are created:

Infrastructure Storage server connectors Storage servers Storage grids

Parameters:	create_external_exadata_infrastructure_details (oci.database_management.models.CreateExternalExadataInfrastructureDetails) – (required) The details required to create the managed Exadata infrastructure resources. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataInfrastructure`
Return type:	`Response`
Example:

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

create_external_exadata_storage_connector(create_external_exadata_storage_connector_details, **kwargs)¶

Creates the Exadata storage server connector after validating the connection information.

Parameters:	create_external_exadata_storage_connector_details (oci.database_management.models.CreateExternalExadataStorageConnectorDetails) – (required) The details required to add connections to the Exadata storage servers. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageConnector`
Return type:	`Response`
Example:

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

create_job(create_job_details, **kwargs)¶

Creates a job to be executed on a Managed Database or Managed Database Group. Only one of the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as input in CreateJobDetails resource in request body.

Parameters:	create_job_details (oci.database_management.models.CreateJobDetails) – (required) The details required to create a job. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Job`
Return type:	`Response`
Example:

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

create_managed_database_group(create_managed_database_group_details, **kwargs)¶

Creates a Managed Database Group. The group does not contain any Managed Databases when it is created, and they must be added later.

Parameters:	create_managed_database_group_details (oci.database_management.models.CreateManagedDatabaseGroupDetails) – (required) The details required to create a Managed Database Group. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedDatabaseGroup`
Return type:	`Response`
Example:

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

create_named_credential(create_named_credential_details, **kwargs)¶

Creates a named credential.

Parameters:	create_named_credential_details (oci.database_management.models.CreateNamedCredentialDetails) – (required) The details required to create a named credential. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NamedCredential`
Return type:	`Response`
Example:

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

create_tablespace(managed_database_id, create_tablespace_details, **kwargs)¶

Creates a tablespace within the Managed Database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. create_tablespace_details (oci.database_management.models.CreateTablespaceDetails) – (required) The details required to create a tablespace. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Tablespace`
Return type:	`Response`
Example:

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

delete_db_management_private_endpoint(db_management_private_endpoint_id, **kwargs)¶

Deletes a specific Database Management private endpoint.

Parameters:	db_management_private_endpoint_id (str) – (required) The OCID of the Database Management private endpoint. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_external_db_system(external_db_system_id, **kwargs)¶

Deletes the external DB system specified by externalDbSystemId.

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_external_db_system_connector(external_db_system_connector_id, **kwargs)¶

Deletes the external connector specified by externalDbSystemConnectorId.

Parameters:	external_db_system_connector_id (str) – (required) The OCID of the external connector. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_external_db_system_discovery(external_db_system_discovery_id, **kwargs)¶

Deletes the external DB system discovery resource specified by externalDbSystemDiscoveryId.

Parameters:	external_db_system_discovery_id (str) – (required) The OCID of the external DB system discovery. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_external_exadata_infrastructure(external_exadata_infrastructure_id, **kwargs)¶

Deletes the Exadata infrastructure specified by externalExadataInfrastructureId.

Parameters:	external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_external_exadata_storage_connector(external_exadata_storage_connector_id, **kwargs)¶

Deletes the Exadata storage server connector specified by exadataStorageConnectorId.

Parameters:	external_exadata_storage_connector_id (str) – (required) The OCID of the connector to the Exadata storage server. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_job(job_id, **kwargs)¶

Deletes the job specified by jobId.

Parameters:	job_id (str) – (required) The identifier of the job. 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) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_managed_database_group(managed_database_group_id, **kwargs)¶

Deletes the Managed Database Group specified by managedDatabaseGroupId. If the group contains Managed Databases, then it cannot be deleted.

Parameters:	managed_database_group_id (str) – (required) The OCID of the Managed Database Group. 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) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_named_credential(named_credential_id, **kwargs)¶

Deletes the named credential specified by namedCredentialId.

Parameters:	named_credential_id (str) – (required) The OCID of the named credential. 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) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_preferred_credential(managed_database_id, credential_name, **kwargs)¶

Deletes the preferred credential based on the credentialName.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. credential_name (str) – (required) The name of the preferred credential. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_automatic_initial_plan_capture(managed_database_id, disable_automatic_initial_plan_capture_details, **kwargs)¶

Disables automatic initial plan capture.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. disable_automatic_initial_plan_capture_details (oci.database_management.models.DisableAutomaticInitialPlanCaptureDetails) – (required) The details required to disable automatic initial plan capture. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_automatic_spm_evolve_advisor_task(managed_database_id, disable_automatic_spm_evolve_advisor_task_details, **kwargs)¶

Disables the Automatic SPM Evolve Advisor task.

One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor. Thus, the same task enables or disables both.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. disable_automatic_spm_evolve_advisor_task_details (oci.database_management.models.DisableAutomaticSpmEvolveAdvisorTaskDetails) – (required) The details required to disable Automatic SPM Evolve Advisor task. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_autonomous_database_management_feature(autonomous_database_id, disable_autonomous_database_management_feature_details, **kwargs)¶

Disables a Database Management feature for the specified Autonomous Database.

Parameters:	autonomous_database_id (str) – (required) The OCID of the Autonomous Database. disable_autonomous_database_management_feature_details (oci.database_management.models.DisableAutonomousDatabaseManagementFeatureDetails) – (required) The details required to disable a Database Management feature for an Autonomous Database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_database_management_feature(database_id, disable_database_management_feature_details, **kwargs)¶

Disables a Database Management feature for the specified Oracle cloud database.

Parameters:	database_id (str) – (required) The OCID of the Database. disable_database_management_feature_details (oci.database_management.models.DisableDatabaseManagementFeatureDetails) – (required) The details required to disable a Database Management feature for an Oracle cloud database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_external_container_database_management_feature(external_container_database_id, disable_external_container_database_management_feature_details, **kwargs)¶

Disables a Database Management feature for the specified external container database.

Parameters:	external_container_database_id (str) – (required) The OCID of the external container database. disable_external_container_database_management_feature_details (oci.database_management.models.DisableExternalContainerDatabaseManagementFeatureDetails) – (required) The details required to disable a Database Management feature for an external container database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_external_db_system_database_management(external_db_system_id, **kwargs)¶

Disables Database Management service for all the components of the specified external DB system (except databases).

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_external_db_system_stack_monitoring(external_db_system_id, **kwargs)¶

Disables Stack Monitoring for all the components of the specified external DB system (except databases).

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_external_exadata_infrastructure_management(external_exadata_infrastructure_id, **kwargs)¶

Disables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components:

Exadata infrastructure
Exadata storage grid
Exadata storage server

Note that Database Management will not be disabled for the DB systems within the Exadata infrastructure and should be disabled explicitly, if required.

Parameters:	external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_external_non_container_database_management_feature(external_non_container_database_id, disable_external_non_container_database_management_feature_details, **kwargs)¶

Disables a Database Management feature for the specified external non-container database.

Parameters:	external_non_container_database_id (str) – (required) The OCID of the external non-container database. disable_external_non_container_database_management_feature_details (oci.database_management.models.DisableExternalNonContainerDatabaseManagementFeatureDetails) – (required) The details required to disable a Database Management feature for an external non-container database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_external_pluggable_database_management_feature(external_pluggable_database_id, disable_external_pluggable_database_management_feature_details, **kwargs)¶

Disables a Database Management feature for the specified external pluggable database.

Parameters:	external_pluggable_database_id (str) – (required) The OCID of the external pluggable database. disable_external_pluggable_database_management_feature_details (oci.database_management.models.DisableExternalPluggableDatabaseManagementFeatureDetails) – (required) The details required to disable a Database Management feature for an external pluggable database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_high_frequency_automatic_spm_evolve_advisor_task(managed_database_id, disable_high_frequency_automatic_spm_evolve_advisor_task_details, **kwargs)¶

Disables the high-frequency Automatic SPM Evolve Advisor task.

It is available only on Oracle Exadata Database Machine, Oracle Database Exadata Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. disable_high_frequency_automatic_spm_evolve_advisor_task_details (oci.database_management.models.DisableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails) – (required) The details required to disable high frequency Automatic SPM Evolve Advisor task. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_pluggable_database_management_feature(pluggable_database_id, disable_pluggable_database_management_feature_details, **kwargs)¶

Disables a Database Management feature for the specified Oracle cloud pluggable database.

Parameters:	pluggable_database_id (str) – (required) The OCID of the Oracle cloud pluggable database. disable_pluggable_database_management_feature_details (oci.database_management.models.DisablePluggableDatabaseManagementFeatureDetails) – (required) The details required to disable a Database Management feature for an Oracle cloud pluggable database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_sql_plan_baselines_usage(managed_database_id, disable_sql_plan_baselines_usage_details, **kwargs)¶

Disables the use of SQL plan baselines stored in SQL Management Base.

When disabled, the optimizer does not use any SQL plan baselines.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. disable_sql_plan_baselines_usage_details (oci.database_management.models.DisableSqlPlanBaselinesUsageDetails) – (required) The details required to disable SQL plan baseline usage. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

discover_external_exadata_infrastructure(discover_external_exadata_infrastructure_details, **kwargs)¶

Completes the Exadata system prechecking on the following:

Verifies if the DB systems are valid RAC DB systems or return 400 status code with NON_RAC_DATABASE_SYSTEM error code.
Verifies if the ASM connector defined for each DB system or return 400 status code with CONNECTOR_NOT_DEFINED error code.
Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with

INVALID_AGENT error code. - Verifies if it is an Exadata system or return 400 status code with INVALID_EXADATA_SYSTEM error code.

Starts the discovery process for the Exadata system infrastructure. The following resources/components are discovered

Exadata storage servers from each DB systems
Exadata storage grid for all Exadata storage servers
Exadata infrastructure

The same API covers both new discovery and rediscovery cases.: For the new discovery case, new managed resources/sub-resources are created or the existing ones are overridden. For rediscovery case, the existing managed resources/sub-resources are checked to find out which ones should be added or which ones
should be: removed based on the unique key defined for each resource/sub-resource.

Parameters:	discover_external_exadata_infrastructure_details (oci.database_management.models.DiscoverExternalExadataInfrastructureDetails) – (required) The details required to discover and monitor the Exadata infrastructure. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataInfrastructureDiscovery`
Return type:	`Response`
Example:

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

drop_sql_plan_baselines(managed_database_id, drop_sql_plan_baselines_details, **kwargs)¶

Drops a single plan or all plans associated with a SQL statement.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. drop_sql_plan_baselines_details (oci.database_management.models.DropSqlPlanBaselinesDetails) – (required) The details required to drop SQL plan baselines. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

drop_tablespace(managed_database_id, tablespace_name, drop_tablespace_details, **kwargs)¶

Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. tablespace_name (str) – (required) The name of the tablespace. drop_tablespace_details (oci.database_management.models.DropTablespaceDetails) – (required) The details required to drop a tablespace. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TablespaceAdminStatus`
Return type:	`Response`
Example:

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

enable_automatic_initial_plan_capture(managed_database_id, enable_automatic_initial_plan_capture_details, **kwargs)¶

Enables automatic initial plan capture. When enabled, the database checks whether executed SQL statements are eligible for automatic capture. It creates initial plan baselines for eligible statements.

By default, the database creates a SQL plan baseline for every eligible repeatable statement, including all recursive SQL and monitoring SQL. Thus, automatic capture may result in the creation of an extremely large number of plan baselines. To limit the statements that are eligible for plan baselines, configure filters.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. enable_automatic_initial_plan_capture_details (oci.database_management.models.EnableAutomaticInitialPlanCaptureDetails) – (required) The details required to enable automatic initial plan capture. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_automatic_spm_evolve_advisor_task(managed_database_id, enable_automatic_spm_evolve_advisor_task_details, **kwargs)¶

Enables the Automatic SPM Evolve Advisor task. By default, the automatic task SYS_AUTO_SPM_EVOLVE_TASK runs every day in the scheduled maintenance window.

The SPM Evolve Advisor performs the following tasks:

Checks AWR for top SQL
Looks for alternative plans in all available sources
Adds unaccepted plans to the plan history
Tests the execution of as many plans as possible during the maintenance window
Adds the alternative plan to the baseline if it performs better than the current plan

One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor. Thus, the same task enables or disables both.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. enable_automatic_spm_evolve_advisor_task_details (oci.database_management.models.EnableAutomaticSpmEvolveAdvisorTaskDetails) – (required) The details required to enable Automatic SPM Evolve Advisor task. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_autonomous_database_management_feature(autonomous_database_id, enable_autonomous_database_management_feature_details, **kwargs)¶

Enables a Database Management feature for the specified Autonomous Database.

Parameters:	autonomous_database_id (str) – (required) The OCID of the Autonomous Database. enable_autonomous_database_management_feature_details (oci.database_management.models.EnableAutonomousDatabaseManagementFeatureDetails) – (required) The details required to enable a Database Management feature for an Autonomous Database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_database_management_feature(database_id, enable_database_management_feature_details, **kwargs)¶

Enables a Database Management feature for the specified cloud database.

Parameters:	database_id (str) – (required) The OCID of the Database. enable_database_management_feature_details (oci.database_management.models.EnableDatabaseManagementFeatureDetails) – (required) The details required to enable a Database Management feature for an Oracle cloud database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_external_container_database_management_feature(external_container_database_id, enable_external_container_database_management_feature_details, **kwargs)¶

Enables a Database Management feature for the specified external container database.

Parameters:	external_container_database_id (str) – (required) The OCID of the external container database. enable_external_container_database_management_feature_details (oci.database_management.models.EnableExternalContainerDatabaseManagementFeatureDetails) – (required) The details required to enable a Database Management feature for an external container database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_external_db_system_database_management(external_db_system_id, enable_external_db_system_database_management_details, **kwargs)¶

Enables Database Management service for all the components of the specified external DB system (except databases).

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. enable_external_db_system_database_management_details (oci.database_management.models.EnableExternalDbSystemDatabaseManagementDetails) – (required) The details required to enable Database Management for an external DB system. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_external_db_system_stack_monitoring(external_db_system_id, enable_external_db_system_stack_monitoring_details, **kwargs)¶

Enables Stack Monitoring for all the components of the specified external DB system (except databases).

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. enable_external_db_system_stack_monitoring_details (oci.database_management.models.EnableExternalDbSystemStackMonitoringDetails) – (required) The details required to enable Stack Monitoring for an external DB system. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_external_exadata_infrastructure_management(external_exadata_infrastructure_id, enable_external_exadata_infrastructure_management_details, **kwargs)¶

Enables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components:

Exadata infrastructure
Exadata storage grid
Exadata storage server

Parameters:	external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. enable_external_exadata_infrastructure_management_details (oci.database_management.models.EnableExternalExadataInfrastructureManagementDetails) – (required) The details required to enable management for the Exadata infrastructure. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_external_non_container_database_management_feature(external_non_container_database_id, enable_external_non_container_database_management_feature_details, **kwargs)¶

Enables Database Management feature for the specified external non-container database.

Parameters:	external_non_container_database_id (str) – (required) The OCID of the external non-container database. enable_external_non_container_database_management_feature_details (oci.database_management.models.EnableExternalNonContainerDatabaseManagementFeatureDetails) – (required) The details required to enable a Database Management feature for an external non-container database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_external_pluggable_database_management_feature(external_pluggable_database_id, enable_external_pluggable_database_management_feature_details, **kwargs)¶

Enables a Database Management feature for the specified external pluggable database.

Parameters:	external_pluggable_database_id (str) – (required) The OCID of the external pluggable database. enable_external_pluggable_database_management_feature_details (oci.database_management.models.EnableExternalPluggableDatabaseManagementFeatureDetails) – (required) The details required to enable a Database Management feature for an external pluggable database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_high_frequency_automatic_spm_evolve_advisor_task(managed_database_id, enable_high_frequency_automatic_spm_evolve_advisor_task_details, **kwargs)¶

Enables the high-frequency Automatic SPM Evolve Advisor task. The high-frequency task runs every hour and runs for no longer than 30 minutes. These settings are not configurable.

The high-frequency task complements the standard Automatic SPM Evolve Advisor task. They are independent and are scheduled through two different frameworks.

It is available only on Oracle Exadata Database Machine, Oracle Database Exadata Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. enable_high_frequency_automatic_spm_evolve_advisor_task_details (oci.database_management.models.EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails) – (required) The details required to enable high frequency Automatic SPM Evolve Advisor task. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_pluggable_database_management_feature(pluggable_database_id, enable_pluggable_database_management_feature_details, **kwargs)¶

Enables a Database Management feature for the specified Oracle cloud pluggable database.

Parameters:	pluggable_database_id (str) – (required) The OCID of the Oracle cloud pluggable database. enable_pluggable_database_management_feature_details (oci.database_management.models.EnablePluggableDatabaseManagementFeatureDetails) – (required) The details required to enable a Database Management feature for an Oracle cloud pluggable database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_sql_plan_baselines_usage(managed_database_id, enable_sql_plan_baselines_usage_details, **kwargs)¶

Enables the use of SQL plan baselines stored in SQL Management Base.

When enabled, the optimizer uses SQL plan baselines to select plans to avoid potential performance regressions.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. enable_sql_plan_baselines_usage_details (oci.database_management.models.EnableSqlPlanBaselinesUsageDetails) – (required) The details required to enable SQL plan baseline usage. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

generate_awr_snapshot(managed_database_id, **kwargs)¶

Creates an AWR snapshot for the target database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed 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 might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SnapshotDetails`
Return type:	`Response`
Example:

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

get_awr_db_report(managed_database_id, awr_db_id, **kwargs)¶

Gets the AWR report for the specific database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs inst_nums (list[int]) – (optional) The optional multiple value query parameter to filter the database instance numbers. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. report_type (str) – (optional) The query parameter to filter the AWR report types. Allowed values are: “AWR”, “ASH” container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges report_format (str) – (optional) The format of the AWR report. Allowed values are: “HTML”, “TEXT” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbReport`
Return type:	`Response`
Example:

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

get_awr_db_sql_report(managed_database_id, awr_db_id, sql_id, **kwargs)¶

Gets the SQL health check report for one SQL of the specific database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs sql_id (str) – (required) The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport) or Performance Hub API (/internal/managedDatabases/{managedDatabaseId}/actions/retrievePerformanceData) inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. report_format (str) – (optional) The format of the AWR report. Allowed values are: “HTML”, “TEXT” container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbSqlReport`
Return type:	`Response`
Example:

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

get_cluster_cache_metric(managed_database_id, start_time, end_time, **kwargs)¶

Gets the metrics related to cluster cache for the Oracle Real Application Clusters (Oracle RAC) database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time (str) – (required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time (str) – (required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ClusterCacheMetric`
Return type:	`Response`
Example:

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

get_database_fleet_health_metrics(compare_baseline_time, compare_target_time, **kwargs)¶

Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.

Parameters:	compare_baseline_time (str) – (required) The baseline time for metrics comparison. compare_target_time (str) – (required) The target time for metrics comparison. opc_request_id (str) – (optional) The client request ID for tracing. managed_database_group_id (str) – (optional) The OCID of the Managed Database Group. compartment_id (str) – (optional) The OCID of the compartment. compare_type (str) – (optional) The time window used for metrics comparison. Allowed values are: “HOUR”, “DAY”, “WEEK” filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. filter_by_database_type (str) – (optional) The filter used to filter the databases in the fleet by a specific Oracle Database type. filter_by_database_sub_type (str) – (optional) The filter used to filter the databases in the fleet by a specific Oracle Database subtype. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” filter_by_database_deployment_type (str) – (optional) The filter used to filter the databases in the fleet by a specific Oracle Database deployment type. filter_by_database_version (str) – (optional) The filter used to filter the databases in the fleet by a specific Oracle Database version. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseFleetHealthMetrics`
Return type:	`Response`
Example:

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

get_database_home_metrics(managed_database_id, start_time, end_time, **kwargs)¶

Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time (str) – (required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time (str) – (required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseHomeMetrics`
Return type:	`Response`
Example:

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

get_dataguard_performance_metrics(managed_database_id, start_time, end_time, **kwargs)¶

Gets a historical summary of the Database Guard performance metrics for Managed Databases. If the peerDatabaseCompartmentId is specified, then the metrics are only retrieved from the specified compartment. If the peerDatabaseCompartmentId is not specified, then the metrics are retrieved from the compartment of the Managed Database specified by the ManagedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time (str) – (required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time (str) – (required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. peer_database_compartment_id (str) – (optional) The OCID of the compartment for which peer database metrics are required. This is not a mandatory parameter and in its absence, all the peer database metrics are returned. filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataguardPerformanceMetrics`
Return type:	`Response`
Example:

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

get_db_management_private_endpoint(db_management_private_endpoint_id, **kwargs)¶

Gets the details of a specific Database Management private endpoint.

Parameters:	db_management_private_endpoint_id (str) – (required) The OCID of the Database Management private endpoint. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DbManagementPrivateEndpoint`
Return type:	`Response`
Example:

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

get_external_asm(external_asm_id, **kwargs)¶

Gets the details for the external ASM specified by externalAsmId.

Parameters:	external_asm_id (str) – (required) The OCID of the external ASM. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsm`
Return type:	`Response`
Example:

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

get_external_asm_configuration(external_asm_id, **kwargs)¶

Gets configuration details including disk groups for the external ASM specified by externalAsmId.

Parameters:	external_asm_id (str) – (required) The OCID of the external ASM. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsmConfiguration`
Return type:	`Response`
Example:

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

get_external_asm_instance(external_asm_instance_id, **kwargs)¶

Gets the details for the external ASM instance specified by externalAsmInstanceId.

Parameters:	external_asm_instance_id (str) – (required) The OCID of the external ASM instance. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsmInstance`
Return type:	`Response`
Example:

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

get_external_cluster(external_cluster_id, **kwargs)¶

Gets the details for the external cluster specified by externalClusterId.

Parameters:	external_cluster_id (str) – (required) The OCID of the external cluster. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalCluster`
Return type:	`Response`
Example:

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

get_external_cluster_instance(external_cluster_instance_id, **kwargs)¶

Gets the details for the external cluster instance specified by externalClusterInstanceId.

Parameters:	external_cluster_instance_id (str) – (required) The OCID of the external cluster instance. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalClusterInstance`
Return type:	`Response`
Example:

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

get_external_db_home(external_db_home_id, **kwargs)¶

Gets the details for the external DB home specified by externalDbHomeId.

Parameters:	external_db_home_id (str) – (required) The OCID of the external database home. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbHome`
Return type:	`Response`
Example:

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

get_external_db_node(external_db_node_id, **kwargs)¶

Gets the details for the external DB node specified by externalDbNodeId.

Parameters:	external_db_node_id (str) – (required) The OCID of the external database node. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbNode`
Return type:	`Response`
Example:

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

get_external_db_system(external_db_system_id, **kwargs)¶

Gets the details for the external DB system specified by externalDbSystemId.

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystem`
Return type:	`Response`
Example:

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

get_external_db_system_connector(external_db_system_connector_id, **kwargs)¶

Gets the details for the external connector specified by externalDbSystemConnectorId.

Parameters:	external_db_system_connector_id (str) – (required) The OCID of the external connector. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemConnector`
Return type:	`Response`
Example:

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

get_external_db_system_discovery(external_db_system_discovery_id, **kwargs)¶

Gets the details for the external DB system discovery resource specified by externalDbSystemDiscoveryId.

Parameters:	external_db_system_discovery_id (str) – (required) The OCID of the external DB system discovery. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemDiscovery`
Return type:	`Response`
Example:

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

get_external_exadata_infrastructure(external_exadata_infrastructure_id, **kwargs)¶

Gets the details for the Exadata infrastructure specified by externalExadataInfrastructureId. It includes the DB systems and storage grid within the Exadata infrastructure.

Parameters:	external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataInfrastructure`
Return type:	`Response`
Example:

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

get_external_exadata_storage_connector(external_exadata_storage_connector_id, **kwargs)¶

Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.

Parameters:	external_exadata_storage_connector_id (str) – (required) The OCID of the connector to the Exadata storage server. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageConnector`
Return type:	`Response`
Example:

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

get_external_exadata_storage_grid(external_exadata_storage_grid_id, **kwargs)¶

Gets the details for the Exadata storage server grid specified by exadataStorageGridId.

Parameters:	external_exadata_storage_grid_id (str) – (required) The OCID of the Exadata storage grid. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageGrid`
Return type:	`Response`
Example:

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

get_external_exadata_storage_server(external_exadata_storage_server_id, **kwargs)¶

Gets the summary for the Exadata storage server specified by exadataStorageServerId.

Parameters:	external_exadata_storage_server_id (str) – (required) The OCID of the Exadata storage server. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageServer`
Return type:	`Response`
Example:

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

get_external_listener(external_listener_id, **kwargs)¶

Gets the details for the external listener specified by externalListenerId.

Parameters:	external_listener_id (str) – (required) The OCID of the external listener. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalListener`
Return type:	`Response`
Example:

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

get_iorm_plan(external_exadata_storage_server_id, **kwargs)¶

Get the IORM plan from the specific Exadata storage server.

Parameters:	external_exadata_storage_server_id (str) – (required) The OCID of the Exadata storage server. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IormPlan`
Return type:	`Response`
Example:

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

get_job(job_id, **kwargs)¶

Gets the details for the job specified by jobId.

Parameters:	job_id (str) – (required) The identifier of the job. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Job`
Return type:	`Response`
Example:

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

get_job_execution(job_execution_id, **kwargs)¶

Gets the details for the job execution specified by jobExecutionId.

Parameters:	job_execution_id (str) – (required) The identifier of the job execution. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobExecution`
Return type:	`Response`
Example:

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

get_job_run(job_run_id, **kwargs)¶

Gets the details for the job run specified by jobRunId.

Parameters:	job_run_id (str) – (required) The identifier of the job run. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobRun`
Return type:	`Response`
Example:

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

get_managed_database(managed_database_id, **kwargs)¶

Gets the details for the Managed Database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedDatabase`
Return type:	`Response`
Example:

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

get_managed_database_group(managed_database_group_id, **kwargs)¶

Gets the details for the Managed Database Group specified by managedDatabaseGroupId.

Parameters:	managed_database_group_id (str) – (required) The OCID of the Managed Database Group. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedDatabaseGroup`
Return type:	`Response`
Example:

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

get_named_credential(named_credential_id, **kwargs)¶

Gets the details for the named credential specified by namedCredentialId.

Parameters:	named_credential_id (str) – (required) The OCID of the named credential. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NamedCredential`
Return type:	`Response`
Example:

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

get_open_alert_history(external_exadata_storage_server_id, **kwargs)¶

Gets the open alerts from the specified Exadata storage server.

Parameters:	external_exadata_storage_server_id (str) – (required) The OCID of the Exadata storage server. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OpenAlertHistory`
Return type:	`Response`
Example:

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

get_optimizer_statistics_advisor_execution(managed_database_id, execution_name, task_name, **kwargs)¶

Gets a comprehensive report of the Optimizer Statistics Advisor execution, which includes details of the Managed Database, findings, recommendations, rationale, and examples.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. execution_name (str) – (required) The name of the Optimizer Statistics Advisor execution. task_name (str) – (required) The name of the optimizer statistics collection execution task. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OptimizerStatisticsAdvisorExecution`
Return type:	`Response`
Example:

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

get_optimizer_statistics_advisor_execution_script(managed_database_id, execution_name, task_name, **kwargs)¶

Gets the Oracle system-generated script for the specified Optimizer Statistics Advisor execution.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. execution_name (str) – (required) The name of the Optimizer Statistics Advisor execution. task_name (str) – (required) The name of the optimizer statistics collection execution task. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OptimizerStatisticsAdvisorExecutionScript`
Return type:	`Response`
Example:

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

get_optimizer_statistics_collection_operation(managed_database_id, optimizer_statistics_collection_operation_id, **kwargs)¶

Gets a detailed report of the Optimizer Statistics Collection operation for the specified Managed Database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. optimizer_statistics_collection_operation_id (float) – (required) The ID of the Optimizer Statistics Collection operation. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OptimizerStatisticsCollectionOperation`
Return type:	`Response`
Example:

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

get_pdb_metrics(managed_database_id, start_time, end_time, **kwargs)¶

Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each PDB within a specific CDB. If comparmentId is specified, then the metrics for each PDB (within the CDB) in the specified compartment are retrieved. If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time (str) – (required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time (str) – (required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. compartment_id (str) – (optional) The OCID of the compartment. compare_type (str) – (optional) The time window used for metrics comparison. Allowed values are: “HOUR”, “DAY”, “WEEK” filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PdbMetrics`
Return type:	`Response`
Example:

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

get_peer_database_metrics(managed_database_id, start_time, end_time, **kwargs)¶

Gets a comparative summary of the baseline and target values of the Data Guard performance metrics for Managed Databases. If the peerDatabaseCompartmentId is specified, then the metrics are only retrieved from the specified compartment. If the peerDatabaseCompartmentId is not specified, then the metrics are retrieved from the compartment of the Managed Database specified by the ManagedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time (str) – (required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time (str) – (required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. peer_database_compartment_id (str) – (optional) The OCID of the compartment for which peer database metrics are required. This is not a mandatory parameter and in its absence, all the peer database metrics are returned. compare_type (str) – (optional) The time window used for metrics comparison. Allowed values are: “HOUR”, “DAY”, “WEEK” filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PeerDatabaseMetrics`
Return type:	`Response`
Example:

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

get_preferred_credential(managed_database_id, credential_name, **kwargs)¶

Gets the preferred credential details for a Managed Database based on credentialName.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. credential_name (str) – (required) The name of the preferred credential. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PreferredCredential`
Return type:	`Response`
Example:

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

get_sql_plan_baseline(managed_database_id, plan_name, **kwargs)¶

Gets the SQL plan baseline details for the specified planName.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. plan_name (str) – (required) The plan name of the SQL plan baseline. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaseline`
Return type:	`Response`
Example:

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

get_sql_plan_baseline_configuration(managed_database_id, **kwargs)¶

Gets the configuration details of SQL plan baselines for the specified Managed Database. The details include the settings for the capture and use of SQL plan baselines, SPM Evolve Advisor task, and SQL Management Base.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaselineConfiguration`
Return type:	`Response`
Example:

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

get_tablespace(managed_database_id, tablespace_name, **kwargs)¶

Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. tablespace_name (str) – (required) The name of the tablespace. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Tablespace`
Return type:	`Response`
Example:

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

get_top_sql_cpu_activity(external_exadata_storage_server_id, **kwargs)¶

Gets the SQL IDs with the top CPU activity from the Exadata storage server.

Parameters:	external_exadata_storage_server_id (str) – (required) The OCID of the Exadata storage server. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TopSqlCpuActivity`
Return type:	`Response`
Example:

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

get_user(managed_database_id, user_name, **kwargs)¶

Gets the details of the user specified by managedDatabaseId and userName.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `User`
Return type:	`Response`
Example:

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

get_work_request(work_request_id, **kwargs)¶

Gets the status of the work request with the given Work Request ID

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

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

implement_optimizer_statistics_advisor_recommendations(managed_database_id, execution_name, implement_optimizer_statistics_advisor_recommendations_details, **kwargs)¶

Asynchronously implements the findings and recommendations of the Optimizer Statistics Advisor execution.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. execution_name (str) – (required) The name of the Optimizer Statistics Advisor execution. implement_optimizer_statistics_advisor_recommendations_details (oci.database_management.models.ImplementOptimizerStatisticsAdvisorRecommendationsDetails) – (required) The Optimizer Statistics Advisor recommendations implementation request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Job`
Return type:	`Response`
Example:

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

list_asm_properties(managed_database_id, **kwargs)¶

Gets the list of ASM properties for the specified managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AsmPropertyCollection`
Return type:	`Response`
Example:

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

list_associated_databases(db_management_private_endpoint_id, compartment_id, **kwargs)¶

Gets the list of databases using a specific Database Management private endpoint.

Parameters:	db_management_private_endpoint_id (str) – (required) The OCID of the Database Management private endpoint. compartment_id (str) – (required) The OCID of the compartment. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The option to sort databases using a specific Database Management private endpoint. Allowed values are: “timeRegistered” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AssociatedDatabaseCollection`
Return type:	`Response`
Example:

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

list_awr_db_snapshots(managed_database_id, awr_db_id, **kwargs)¶

Lists AWR snapshots for the specified database in the AWR.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The option to sort the AWR snapshot summary data. Allowed values are: “TIME_BEGIN”, “SNAPSHOT_ID” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbSnapshotCollection`
Return type:	`Response`
Example:

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

list_awr_dbs(managed_database_id, **kwargs)¶

Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. name (str) – (optional) The optional single value query parameter to filter the entity name. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The option to sort the AWR summary data. Allowed values are: “END_INTERVAL_TIME”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbCollection`
Return type:	`Response`
Example:

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

list_consumer_group_privileges(managed_database_id, user_name, **kwargs)¶

Gets the list of consumer group privileges granted to a specific user.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConsumerGroupPrivilegeCollection`
Return type:	`Response`
Example:

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

list_cursor_cache_statements(managed_database_id, **kwargs)¶

Lists the SQL statements from shared SQL area, also called the cursor cache.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. sql_text (str) – (optional) A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the ‘%’ symbol as a wildcard. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The option to sort the SQL statement summary data. Allowed values are: “sqlId”, “schema” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CursorCacheStatementCollection`
Return type:	`Response`
Example:

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

list_data_access_containers(managed_database_id, user_name, **kwargs)¶

Gets the list of containers for a specific user. This is only applicable if ALL_CONTAINERS !=’Y’.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAccessContainerCollection`
Return type:	`Response`
Example:

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

list_database_parameters(managed_database_id, **kwargs)¶

Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. source (str) – (optional) The source used to list database parameters. CURRENT is used to get the database parameters that are currently in effect for the database instance. SPFILE is used to list parameters from the server parameter file. Default is CURRENT. Allowed values are: “CURRENT”, “SPFILE” name (str) – (optional) A filter to return all parameters that have the text given in their names. is_allowed_values_included (bool) – (optional) When true, results include a list of valid values for parameters (if applicable). sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseParametersCollection`
Return type:	`Response`
Example:

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

list_db_management_private_endpoints(compartment_id, **kwargs)¶

Gets a list of Database Management private endpoints.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. name (str) – (optional) A filter to return only resources that match the entire name. vcn_id (str) – (optional) The OCID of the VCN. is_cluster (bool) – (optional) The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter. is_dns_resolution_enabled (bool) – (optional) The option to filter Database Management private endpoints which are endbled with DNS proxy server. This should be used along with the vcnId query parameter. Only one of this parameter and IsClusterDbManagementPrivateEndpointQueryParam should be set to true at one time. lifecycle_state (str) – (optional) The lifecycle state of a resource. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DbManagementPrivateEndpointCollection`
Return type:	`Response`
Example:

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

list_external_asm_disk_groups(external_asm_id, **kwargs)¶

Lists ASM disk groups for the external ASM specified by externalAsmId.

Parameters:	external_asm_id (str) – (required) The OCID of the external ASM. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsmDiskGroupCollection`
Return type:	`Response`
Example:

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

list_external_asm_instances(**kwargs)¶

Lists the ASM instances in the specified external ASM.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_asm_id (str) – (optional) The OCID of the external ASM. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsmInstanceCollection`
Return type:	`Response`
Example:

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

list_external_asm_users(external_asm_id, **kwargs)¶

Lists ASM users for the external ASM specified by externalAsmId.

Parameters:	external_asm_id (str) – (required) The OCID of the external ASM. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsmUserCollection`
Return type:	`Response`
Example:

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

list_external_asms(**kwargs)¶

Lists the ASMs in the specified external DB system.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_db_system_id (str) – (optional) The OCID of the external DB system. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsmCollection`
Return type:	`Response`
Example:

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

list_external_cluster_instances(**kwargs)¶

Lists the cluster instances in the specified external cluster.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_cluster_id (str) – (optional) The OCID of the external cluster. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalClusterInstanceCollection`
Return type:	`Response`
Example:

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

list_external_clusters(**kwargs)¶

Lists the clusters in the specified external DB system.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_db_system_id (str) – (optional) The OCID of the external DB system. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalClusterCollection`
Return type:	`Response`
Example:

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

list_external_databases(**kwargs)¶

Lists the external databases in the specified compartment or in the specified DB system.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_db_system_id (str) – (optional) The OCID of the external DB system. external_database_id (str) – (optional) The OCID of the external database. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDatabaseCollection`
Return type:	`Response`
Example:

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

list_external_db_homes(**kwargs)¶

Lists the DB homes in the specified external DB system.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_db_system_id (str) – (optional) The OCID of the external DB system. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbHomeCollection`
Return type:	`Response`
Example:

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

list_external_db_nodes(**kwargs)¶

Lists the external DB nodes in the specified external DB system.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_db_system_id (str) – (optional) The OCID of the external DB system. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbNodeCollection`
Return type:	`Response`
Example:

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

list_external_db_system_connectors(**kwargs)¶

Lists the external connectors in the specified external DB system.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_db_system_id (str) – (optional) The OCID of the external DB system. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemConnectorCollection`
Return type:	`Response`
Example:

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

list_external_db_system_discoveries(compartment_id, **kwargs)¶

Lists the external DB system discovery resources in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemDiscoveryCollection`
Return type:	`Response`
Example:

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

list_external_db_systems(compartment_id, **kwargs)¶

Lists the external DB systems in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemCollection`
Return type:	`Response`
Example:

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

list_external_exadata_infrastructures(compartment_id, **kwargs)¶

Lists the Exadata infrastructure resources in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. display_name (str) – (optional) The optional single value query filter parameter on the entity display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataInfrastructureCollection`
Return type:	`Response`
Example:

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

list_external_exadata_storage_connectors(compartment_id, external_exadata_infrastructure_id, **kwargs)¶

Lists the Exadata storage server connectors for the specified Exadata infrastructure.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. display_name (str) – (optional) The optional single value query filter parameter on the entity display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageConnectorCollection`
Return type:	`Response`
Example:

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

list_external_exadata_storage_servers(compartment_id, external_exadata_infrastructure_id, **kwargs)¶

Lists the Exadata storage servers for the specified Exadata infrastructure.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. display_name (str) – (optional) The optional single value query filter parameter on the entity display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageServerCollection`
Return type:	`Response`
Example:

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

list_external_listener_services(external_listener_id, managed_database_id, **kwargs)¶

Lists the database services registered with the specified external listener for the specified Managed Database.

Parameters:	external_listener_id (str) – (required) The OCID of the external listener. managed_database_id (str) – (required) The OCID of the Managed Database. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for NAME is ascending and it is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalListenerServiceCollection`
Return type:	`Response`
Example:

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

list_external_listeners(**kwargs)¶

Lists the listeners in the specified external DB system.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. external_db_system_id (str) – (optional) The OCID of the external DB system. display_name (str) – (optional) A filter to only return the resources that match the entire display name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalListenerCollection`
Return type:	`Response`
Example:

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

list_job_executions(compartment_id, **kwargs)¶

Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered based on the name and status parameters.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. opc_request_id (str) – (optional) The client request ID for tracing. id (str) – (optional) The identifier of the resource. job_id (str) – (optional) The identifier of the job. managed_database_id (str) – (optional) The OCID of the Managed Database. managed_database_group_id (str) – (optional) The OCID of the Managed Database Group. status (str) – (optional) The status of the job execution. name (str) – (optional) A filter to return only resources that match the entire name. limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” job_run_id (str) – (optional) The identifier of the job run. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobExecutionCollection`
Return type:	`Response`
Example:

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

list_job_runs(compartment_id, **kwargs)¶

Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. Job runs can also be filtered based on name and runStatus parameters.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. opc_request_id (str) – (optional) The client request ID for tracing. id (str) – (optional) The identifier of the resource. job_id (str) – (optional) The identifier of the job. managed_database_id (str) – (optional) The OCID of the Managed Database. managed_database_group_id (str) – (optional) The OCID of the Managed Database Group. run_status (str) – (optional) The status of the job run. name (str) – (optional) A filter to return only resources that match the entire name. limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobRunCollection`
Return type:	`Response`
Example:

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

list_jobs(compartment_id, **kwargs)¶

Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. Jobs can also be filtered based on the name and lifecycleState parameters.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. opc_request_id (str) – (optional) The client request ID for tracing. id (str) – (optional) The identifier of the resource. managed_database_group_id (str) – (optional) The OCID of the Managed Database Group. managed_database_id (str) – (optional) The OCID of the Managed Database. name (str) – (optional) A filter to return only resources that match the entire name. lifecycle_state (str) – (optional) The lifecycle state of the job. Allowed values are: “ACTIVE”, “INACTIVE” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobCollection`
Return type:	`Response`
Example:

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

list_managed_database_groups(compartment_id, **kwargs)¶

Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment. Managed Database Groups can also be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If none of these parameters is provided, all the Managed Database Groups in the compartment are listed.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. opc_request_id (str) – (optional) The client request ID for tracing. id (str) – (optional) The identifier of the resource. name (str) – (optional) A filter to return only resources that match the entire name. lifecycle_state (str) – (optional) The lifecycle state of a resource. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedDatabaseGroupCollection`
Return type:	`Response`
Example:

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

list_managed_databases(compartment_id, **kwargs)¶

Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment. Managed Databases can be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment are listed. Managed Databases can also be filtered based on the deployment type and management option. If the deployment type is not specified or if it is ONPREMISE, then the management option is not considered and Managed Databases with ADVANCED management option are listed.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. opc_request_id (str) – (optional) The client request ID for tracing. id (str) – (optional) The identifier of the resource. name (str) – (optional) A filter to return only resources that match the entire name. management_option (str) – (optional) A filter to return Managed Databases with the specified management option. Allowed values are: “BASIC”, “ADVANCED” deployment_type (str) – (optional) A filter to return Managed Databases of the specified deployment type. Allowed values are: “ONPREMISE”, “BM”, “VM”, “EXADATA”, “EXADATA_CC”, “AUTONOMOUS”, “EXADATA_XS” external_exadata_infrastructure_id (str) – (optional) The OCID of the Exadata infrastructure. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedDatabaseCollection`
Return type:	`Response`
Example:

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

list_named_credentials(compartment_id, **kwargs)¶

Gets a single named credential specified by the name or all the named credentials in a specific compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. opc_request_id (str) – (optional) The client request ID for tracing. associated_resource (str) – (optional) The resource associated to the named credential. type (str) – (optional) The type of database that is associated to the named credential. Allowed values are: “ORACLE_DB” scope (str) – (optional) The scope of named credential. Allowed values are: “RESOURCE”, “GLOBAL” name (str) – (optional) The name of the named credential. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NamedCredentialCollection`
Return type:	`Response`
Example:

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

list_object_privileges(managed_database_id, user_name, **kwargs)¶

Gets the list of object privileges granted to a specific user.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ObjectPrivilegeCollection`
Return type:	`Response`
Example:

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

list_optimizer_statistics_advisor_executions(managed_database_id, **kwargs)¶

Lists the details of the Optimizer Statistics Advisor task executions, such as their duration, and the number of findings, if any. Optionally, you can specify a date-time range (of seven days) to obtain the list of executions that fall within the specified time range. If the date-time range is not specified, then the executions in the last seven days are listed.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time_greater_than_or_equal_to (str) – (optional) The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time_less_than_or_equal_to (str) – (optional) The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OptimizerStatisticsAdvisorExecutionsCollection`
Return type:	`Response`
Example:

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

list_optimizer_statistics_collection_aggregations(managed_database_id, group_type, **kwargs)¶

Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database. You must specify a value for GroupByQueryParam to determine whether the data should be grouped by task status or task object status. Optionally, you can specify a date-time range (of seven days) to obtain collection aggregations within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. You can further filter the results by providing the optional type of TaskTypeQueryParam. If the task type not provided, then both Auto and Manual tasks are considered for aggregation.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. group_type (str) – (required) The optimizer statistics tasks grouped by type. Allowed values are: “TASK_STATUS”, “TASK_OBJECTS_STATUS” start_time_greater_than_or_equal_to (str) – (optional) The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time_less_than_or_equal_to (str) – (optional) The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. task_type (str) – (optional) The filter types of the optimizer statistics tasks. Allowed values are: “ALL”, “MANUAL”, “AUTO” opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OptimizerStatisticsCollectionAggregationsCollection`
Return type:	`Response`
Example:

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

list_optimizer_statistics_collection_operations(managed_database_id, **kwargs)¶

Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database. The summary includes the details of each operation and the number of tasks grouped by status: Completed, In Progress, Failed, and so on. Optionally, you can specify a date-time range (of seven days) to obtain the list of operations that fall within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. This API also enables the pagination of results and the opc-next-page response header indicates whether there is a next page. If you use the same header value in a consecutive request, the next page records are returned. To obtain the required results, you can apply the different types of filters supported by this API.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time_greater_than_or_equal_to (str) – (optional) The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time_less_than_or_equal_to (str) – (optional) The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. task_type (str) – (optional) The filter types of the optimizer statistics tasks. Allowed values are: “ALL”, “MANUAL”, “AUTO” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. filter_by (str) – (optional) The parameter used to filter the optimizer statistics operations. Any property of the OptimizerStatisticsCollectionOperationSummary can be used to define the filter condition. The allowed conditional operators are AND or OR, and the allowed binary operators are are >, < and =. Any other operator is regarded invalid. Example: jobName=<replace with job name> AND status=<replace with status> sort_by (str) – (optional) Sorts the list of optimizer statistics operations based on a specific attribute. Allowed values are: “START_TIME”, “END_TIME”, “STATUS” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OptimizerStatisticsCollectionOperationsCollection`
Return type:	`Response`
Example:

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

list_preferred_credentials(managed_database_id, **kwargs)¶

Gets the list of preferred credentials for a given Managed Database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PreferredCredentialCollection`
Return type:	`Response`
Example:

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

list_proxied_for_users(managed_database_id, user_name, **kwargs)¶

Gets the list of users on whose behalf the current user acts as proxy.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ProxiedForUserCollection`
Return type:	`Response`
Example:

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

list_proxy_users(managed_database_id, user_name, **kwargs)¶

Gets the list of proxy users for the current user.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ProxyUserCollection`
Return type:	`Response`
Example:

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

list_roles(managed_database_id, user_name, **kwargs)¶

Gets the list of roles granted to a specific user.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RoleCollection`
Return type:	`Response`
Example:

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

list_sql_plan_baseline_jobs(managed_database_id, **kwargs)¶

Lists the database jobs used for loading SQL plan baselines in the specified Managed Database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. name (str) – (optional) A filter to return the SQL plan baseline jobs that match the name. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaselineJobCollection`
Return type:	`Response`
Example:

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

list_sql_plan_baselines(managed_database_id, **kwargs)¶

Lists the SQL plan baselines for the specified Managed Database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. plan_name (str) – (optional) A filter to return only SQL plan baselines that match the plan name. sql_handle (str) – (optional) A filter to return all the SQL plan baselines for the specified SQL handle. sql_text (str) – (optional) A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the ‘%’ symbol as a wildcard. is_enabled (bool) – (optional) A filter to return only SQL plan baselines that are either enabled or not enabled. By default, all SQL plan baselines are returned. is_accepted (bool) – (optional) A filter to return only SQL plan baselines that are either accepted or not accepted. By default, all SQL plan baselines are returned. is_reproduced (bool) – (optional) A filter to return only SQL plan baselines that were either reproduced or not reproduced by the optimizer. By default, all SQL plan baselines are returned. is_fixed (bool) – (optional) A filter to return only SQL plan baselines that are either fixed or not fixed. By default, all SQL plan baselines are returned. is_adaptive (bool) – (optional) A filter to return only SQL plan baselines that are either adaptive or not adaptive. By default, all SQL plan baselines are returned. origin (str) – (optional) A filter to return all the SQL plan baselines that match the origin. Allowed values are: “ADDM_SQLTUNE”, “AUTO_CAPTURE”, “AUTO_SQLTUNE”, “EVOLVE_AUTO_INDEX_LOAD”, “EVOLVE_CREATE_FROM_ADAPTIVE”, “EVOLVE_LOAD_FROM_STS”, “EVOLVE_LOAD_FROM_AWR”, “EVOLVE_LOAD_FROM_CURSOR_CACHE”, “MANUAL_LOAD”, “MANUAL_LOAD_FROM_AWR”, “MANUAL_LOAD_FROM_CURSOR_CACHE”, “MANUAL_LOAD_FROM_STS”, “MANUAL_SQLTUNE”, “STORED_OUTLINE”, “UNKNOWN” page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The option to sort the SQL plan baseline summary data. Allowed values are: “timeCreated”, “timeLastModified”, “timeLastExecuted” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” is_auto_purged (bool) – (optional) A filter to return only SQL plan baselines that are either auto-purged or not auto-purged. By default, all SQL plan baselines are returned. time_last_executed_greater_than (datetime) – (optional) A filter to return only SQL plan baselines whose last execution time is after the specified value. By default, all SQL plan baselines are returned. time_last_executed_less_than (datetime) – (optional) A filter to return only SQL plan baselines whose last execution time is before the specified value. By default, all SQL plan baselines are returned. is_never_executed (bool) – (optional) A filter to return only SQL plan baselines that are not executed till now. By default, all SQL plan baselines are returned. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaselineCollection`
Return type:	`Response`
Example:

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

list_system_privileges(managed_database_id, user_name, **kwargs)¶

Gets the list of system privileges granted to a specific user.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. user_name (str) – (required) The name of the user whose details are to be viewed. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SystemPrivilegeCollection`
Return type:	`Response`
Example:

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

list_table_statistics(managed_database_id, **kwargs)¶

Lists the database table statistics grouped by different statuses such as Not Stale Stats, Stale Stats, and No Stats. This also includes the percentage of each status.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TableStatisticsCollection`
Return type:	`Response`
Example:

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

list_tablespaces(managed_database_id, **kwargs)¶

Gets the list of tablespaces for the specified managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TablespaceCollection`
Return type:	`Response`
Example:

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

list_users(managed_database_id, **kwargs)¶

Gets the list of users for the specified managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of records returned in the paginated response. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Returns a paginated list of errors for a given work request.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: “timeAccepted” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestErrorCollection`
Return type:	`Response`
Example:

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

list_work_request_logs(work_request_id, **kwargs)¶

Returns a paginated list of logs for a given work request.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: “timeAccepted” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

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

list_work_requests(compartment_id, **kwargs)¶

The list of work requests in a specific compartment was retrieved successfully.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_id (str) – (optional) The OCID of the resource affected by the work request. opc_request_id (str) – (optional) The client request ID for tracing. work_request_id (str) – (optional) The OCID of the asynchronous work request. status (str) – (optional) A filter that returns the resources whose status matches the given WorkRequestStatus. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: “timeAccepted” page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestCollection`
Return type:	`Response`
Example:

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

load_sql_plan_baselines_from_awr(managed_database_id, load_sql_plan_baselines_from_awr_details, **kwargs)¶

Loads plans from Automatic Workload Repository (AWR) snapshots. You must specify the beginning and ending of the snapshot range. Optionally, you can apply a filter to load only plans that meet specified criteria. By default, the optimizer uses the loaded plans the next time that the database executes the SQL statements.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. load_sql_plan_baselines_from_awr_details (oci.database_management.models.LoadSqlPlanBaselinesFromAwrDetails) – (required) The details required to load plans from Automatic Workload Repository (AWR). opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaselineJob`
Return type:	`Response`
Example:

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

load_sql_plan_baselines_from_cursor_cache(managed_database_id, load_sql_plan_baselines_from_cursor_cache_details, **kwargs)¶

Loads plans for statements directly from the shared SQL area, also called the cursor cache. By applying a filter on the module name, the schema, or the SQL ID you identify the SQL statement or set of SQL statements to load.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. load_sql_plan_baselines_from_cursor_cache_details (oci.database_management.models.LoadSqlPlanBaselinesFromCursorCacheDetails) – (required) The details of SQL statements and plans to be loaded from cursor cache. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaselineJob`
Return type:	`Response`
Example:

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

modify_autonomous_database_management_feature(autonomous_database_id, modify_autonomous_database_management_feature_details, **kwargs)¶

Modifies the Database Management feature for the specified Autonomous Database.

Parameters:	autonomous_database_id (str) – (required) The OCID of the Autonomous Database. modify_autonomous_database_management_feature_details (oci.database_management.models.ModifyAutonomousDatabaseManagementFeatureDetails) – (required) The details required to modify a Database Management feature for an Autonomous Database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

modify_database_management_feature(database_id, modify_database_management_feature_details, **kwargs)¶

Modifies a Database Management feature for the specified Oracle cloud database.

Parameters:	database_id (str) – (required) The OCID of the Database. modify_database_management_feature_details (oci.database_management.models.ModifyDatabaseManagementFeatureDetails) – (required) The details required to modify a Database Management feature for an Oracle cloud database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

modify_pluggable_database_management_feature(pluggable_database_id, modify_pluggable_database_management_feature_details, **kwargs)¶

Modifies the Database Management feature for the specified Oracle cloud pluggable database.

Parameters:	pluggable_database_id (str) – (required) The OCID of the Oracle cloud pluggable database. modify_pluggable_database_management_feature_details (oci.database_management.models.ModifyPluggableDatabaseManagementFeatureDetails) – (required) The details required to modify a Database Management feature for an Oracle cloud pluggable database. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

patch_external_db_system_discovery(external_db_system_discovery_id, patch_external_db_system_discovery_details, **kwargs)¶

Patches the external DB system discovery specified by externalDbSystemDiscoveryId.

Parameters:	external_db_system_discovery_id (str) – (required) The OCID of the external DB system discovery. patch_external_db_system_discovery_details (oci.database_management.models.PatchExternalDbSystemDiscoveryDetails) – (required) The details required to update an external DB system discovery. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemDiscovery`
Return type:	`Response`
Example:

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

remove_data_file(managed_database_id, tablespace_name, remove_data_file_details, **kwargs)¶

Removes a data file or temp file from the tablespace.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. tablespace_name (str) – (required) The name of the tablespace. remove_data_file_details (oci.database_management.models.RemoveDataFileDetails) – (required) The details required to remove a data file or temp file from the tablespace. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TablespaceAdminStatus`
Return type:	`Response`
Example:

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

remove_managed_database_from_managed_database_group(managed_database_group_id, remove_managed_database_from_managed_database_group_details, **kwargs)¶

Removes a Managed Database from a Managed Database Group. Any management activities that are currently running on this database will continue to run to completion. However, any activities scheduled to run in the future will not be performed on this database.

Parameters:	managed_database_group_id (str) – (required) The OCID of the Managed Database Group. remove_managed_database_from_managed_database_group_details (oci.database_management.models.RemoveManagedDatabaseFromManagedDatabaseGroupDetails) – (required) The Managed Database details required to remove the Managed Database from a Managed Database Group. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

reset_database_parameters(managed_database_id, reset_database_parameters_details, **kwargs)¶

Resets database parameter values to their default or startup values.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. reset_database_parameters_details (oci.database_management.models.ResetDatabaseParametersDetails) – (required) The details required to reset database parameters. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UpdateDatabaseParametersResult`
Return type:	`Response`
Example:

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

resize_data_file(managed_database_id, tablespace_name, resize_data_file_details, **kwargs)¶

Resizes a data file or temp file within the tablespace.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. tablespace_name (str) – (required) The name of the tablespace. resize_data_file_details (oci.database_management.models.ResizeDataFileDetails) – (required) The details required to resize a data file or temp file within the tablespace. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TablespaceAdminStatus`
Return type:	`Response`
Example:

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

run_historic_addm(managed_database_id, run_historic_addm_details, **kwargs)¶

Creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task uses the provided awr snapshot IDs, the existing task will be returned.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. run_historic_addm_details (oci.database_management.models.RunHistoricAddmDetails) – (required) The details of the ADDM task, which include the beginning and ending AWR snapshot IDs. 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 might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `HistoricAddmResult`
Return type:	`Response`
Example:

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

summarize_awr_db_cpu_usages(managed_database_id, awr_db_id, **kwargs)¶

Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. session_type (str) – (optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: “FOREGROUND”, “BACKGROUND”, “ALL” container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in large paginated response. sort_by (str) – (optional) The option to sort the AWR CPU usage summary data. Allowed values are: “TIME_SAMPLED”, “AVG_VALUE” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbCpuUsageCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_metrics(managed_database_id, awr_db_id, name, **kwargs)¶

Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs name (oci.database_management.models.list[str]) – (required) The required multiple value query parameter to filter the entity name. inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in large paginated response. sort_by (str) – (optional) The option to sort the AWR time series summary data. Allowed values are: “TIMESTAMP”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbMetricCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_parameter_changes(managed_database_id, awr_db_id, name, **kwargs)¶

Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs name (str) – (required) The required single value query parameter to filter the entity name. inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in large paginated response. sort_by (str) – (optional) The option to sort the AWR database parameter change history data. Allowed values are: “IS_CHANGED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbParameterChangeCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_parameters(managed_database_id, awr_db_id, **kwargs)¶

Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:

Each parameter whose value was changed during the time range: (valueChanged =”Y”)
Each parameter whose value was unchanged during the time range: (valueChanged =”N”)
Each parameter whose value was changed at the system level during the time range: (valueChanged =”Y” and valueModified = “SYSTEM_MOD”)
Each parameter whose value was unchanged during the time range, however, the value is not the default value: (valueChanged =”N” and valueDefault = “FALSE”)

Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges name (list[str]) – (optional) The optional multiple value query parameter to filter the entity name. name_contains (str) – (optional) The optional contains query parameter to filter the entity name by any part of the name. value_changed (str) – (optional) The optional query parameter to filter database parameters whose values were changed. Allowed values are: “Y”, “N” value_default (str) – (optional) The optional query parameter to filter the database parameters that had the default value in the last snapshot. Allowed values are: “TRUE”, “FALSE” value_modified (str) – (optional) The optional query parameter to filter the database parameters that had a modified value in the last snapshot. Allowed values are: “MODIFIED”, “SYSTEM_MOD”, “FALSE” page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in large paginated response. sort_by (str) – (optional) The option to sort the AWR database parameter change history data. Allowed values are: “IS_CHANGED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbParameterCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_snapshot_ranges(managed_database_id, **kwargs)¶

Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. name (str) – (optional) The optional single value query parameter to filter the entity name. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. sort_by (str) – (optional) The option to sort the AWR summary data. Allowed values are: “END_INTERVAL_TIME”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbSnapshotRangeCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_sysstats(managed_database_id, awr_db_id, name, **kwargs)¶

Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs name (oci.database_management.models.list[str]) – (required) The required multiple value query parameter to filter the entity name. inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in large paginated response. sort_by (str) – (optional) The option to sort the data within a time period. Allowed values are: “TIME_BEGIN”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbSysstatCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_top_wait_events(managed_database_id, awr_db_id, **kwargs)¶

Summarizes the AWR top wait events.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. session_type (str) – (optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: “FOREGROUND”, “BACKGROUND”, “ALL” container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges top_n (int) – (optional) The optional query parameter to filter the number of top categories to be returned. sort_by (str) – (optional) The option to sort the AWR top event summary data. Allowed values are: “WAITS_PERSEC”, “AVG_WAIT_TIME_PERSEC” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbTopWaitEventCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_wait_event_buckets(managed_database_id, awr_db_id, name, **kwargs)¶

Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs name (str) – (required) The required single value query parameter to filter the entity name. inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. num_bucket (int) – (optional) The number of buckets within the histogram. min_value (float) – (optional) The minimum value of the histogram. max_value (float) – (optional) The maximum value of the histogram. container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in large paginated response. sort_by (str) – (optional) The option to sort distribution data. Allowed values are: “CATEGORY”, “PERCENTAGE” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbWaitEventBucketCollection`
Return type:	`Response`
Example:

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

summarize_awr_db_wait_events(managed_database_id, awr_db_id, **kwargs)¶

Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. awr_db_id (str) – (required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs inst_num (str) – (optional) The optional single value query parameter to filter the database instance number. begin_sn_id_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_sn_id_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot ID. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. name (list[str]) – (optional) The optional multiple value query parameter to filter the entity name. session_type (str) – (optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: “FOREGROUND”, “BACKGROUND”, “ALL” container_id (int) – (optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in large paginated response. sort_by (str) – (optional) The option to sort the data within a time period. Allowed values are: “TIME_BEGIN”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDbWaitEventCollection`
Return type:	`Response`
Example:

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

summarize_external_asm_metrics(external_asm_id, start_time, end_time, **kwargs)¶

Gets metrics for the external ASM specified by externalAsmId.

Parameters:	external_asm_id (str) – (required) The OCID of the external ASM. start_time (str) – (required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. end_time (str) – (required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MetricsAggregationRangeCollection`
Return type:	`Response`
Example:

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

summarize_external_cluster_metrics(external_cluster_id, start_time, end_time, **kwargs)¶

Gets metrics for the external cluster specified by externalClusterId.

Parameters:	external_cluster_id (str) – (required) The OCID of the external cluster. start_time (str) – (required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. end_time (str) – (required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MetricsAggregationRangeCollection`
Return type:	`Response`
Example:

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

summarize_external_db_node_metrics(external_db_node_id, start_time, end_time, **kwargs)¶

Gets metrics for the external DB node specified by externalDbNodeId.

Parameters:	external_db_node_id (str) – (required) The OCID of the external database node. start_time (str) – (required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. end_time (str) – (required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MetricsAggregationRangeCollection`
Return type:	`Response`
Example:

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

summarize_external_db_system_availability_metrics(external_db_system_id, start_time, end_time, **kwargs)¶

Gets availability metrics for the components present in the external DB system specified by externalDbSystemId.

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. start_time (str) – (required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. end_time (str) – (required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. filter_by_component_types (str) – (optional) The filter used to retrieve metrics for a specific set of component types by passing the desired component types separated by a comma. Note that, by default, the service returns metrics for all DB system component types. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MetricsAggregationRangeCollection`
Return type:	`Response`
Example:

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

summarize_external_listener_metrics(external_listener_id, start_time, end_time, **kwargs)¶

Gets metrics for the external listener specified by externalListenerId.

Parameters:	external_listener_id (str) – (required) The OCID of the external listener. start_time (str) – (required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. end_time (str) – (required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. filter_by_metric_names (str) – (optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MetricsAggregationRangeCollection`
Return type:	`Response`
Example:

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

summarize_job_executions_statuses(compartment_id, start_time, end_time, **kwargs)¶

Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment. Only one of the parameters, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. start_time (str) – (required) The start time of the time range to retrieve the status summary of job executions in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time (str) – (required) The end time of the time range to retrieve the status summary of job executions in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. id (str) – (optional) The identifier of the resource. managed_database_group_id (str) – (optional) The OCID of the Managed Database Group. managed_database_id (str) – (optional) The OCID of the Managed Database. name (str) – (optional) A filter to return only resources that match the entire name. sort_by (str) – (optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: “TIMECREATED”, “NAME” sort_order (str) – (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobExecutionsStatusSummaryCollection`
Return type:	`Response`
Example:

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

summarize_managed_database_availability_metrics(managed_database_id, start_time, end_time, **kwargs)¶

Gets the availability metrics related to managed database for the Oracle database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. start_time (str) – (required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. end_time (str) – (required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is “yyyy-MM-dd’T’hh:mm:ss.sss’Z’”. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of records returned in the paginated response. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MetricsAggregationRangeCollection`
Return type:	`Response`
Example:

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

summarize_sql_plan_baselines(managed_database_id, **kwargs)¶

Gets the number of SQL plan baselines aggregated by their attributes.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaselineAggregationCollection`
Return type:	`Response`
Example:

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

summarize_sql_plan_baselines_by_last_execution(managed_database_id, **kwargs)¶

Gets the number of SQL plan baselines aggregated by the age of their last execution in weeks.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. opc_named_credential_id (str) – (optional) The OCID of the Named Credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanBaselineAggregationCollection`
Return type:	`Response`
Example:

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

test_named_credential(named_credential_id, test_named_credential_details, **kwargs)¶

Tests the named credential.

Parameters:	named_credential_id (str) – (required) The OCID of the named credential. test_named_credential_details (oci.database_management.models.TestNamedCredentialDetails) – (required) The OCID of the database against which the credential is to be tested. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TestNamedCredentialStatus`
Return type:	`Response`
Example:

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

test_preferred_credential(managed_database_id, credential_name, **kwargs)¶

Tests the preferred credential.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. credential_name (str) – (required) The name of the preferred credential. opc_request_id (str) – (optional) The client request ID for tracing. test_preferred_credential_details (oci.database_management.models.TestPreferredCredentialDetails) – (optional) The details required to test preferred credential. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TestPreferredCredentialStatus`
Return type:	`Response`
Example:

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

update_db_management_private_endpoint(db_management_private_endpoint_id, update_db_management_private_endpoint_details, **kwargs)¶

Updates one or more attributes of a specific Database Management private endpoint.

Parameters:	db_management_private_endpoint_id (str) – (required) The OCID of the Database Management private endpoint. update_db_management_private_endpoint_details (oci.database_management.models.UpdateDbManagementPrivateEndpointDetails) – (required) The details used to update a Database Management private endpoint. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DbManagementPrivateEndpoint`
Return type:	`Response`
Example:

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

update_external_asm(external_asm_id, update_external_asm_details, **kwargs)¶

Updates the external ASM specified by externalAsmId.

Parameters:	external_asm_id (str) – (required) The OCID of the external ASM. update_external_asm_details (oci.database_management.models.UpdateExternalAsmDetails) – (required) The details required to update an external ASM. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_external_asm_instance(external_asm_instance_id, update_external_asm_instance_details, **kwargs)¶

Updates the external ASM instance specified by externalAsmInstanceId.

Parameters:	external_asm_instance_id (str) – (required) The OCID of the external ASM instance. update_external_asm_instance_details (oci.database_management.models.UpdateExternalAsmInstanceDetails) – (required) The details required to update an external ASM instance. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalAsmInstance`
Return type:	`Response`
Example:

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

update_external_cluster(external_cluster_id, update_external_cluster_details, **kwargs)¶

Updates the external cluster specified by externalClusterId.

Parameters:	external_cluster_id (str) – (required) The OCID of the external cluster. update_external_cluster_details (oci.database_management.models.UpdateExternalClusterDetails) – (required) The details required to update an external cluster. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_external_cluster_instance(external_cluster_instance_id, update_external_cluster_instance_details, **kwargs)¶

Updates the external cluster instance specified by externalClusterInstanceId.

Parameters:	external_cluster_instance_id (str) – (required) The OCID of the external cluster instance. update_external_cluster_instance_details (oci.database_management.models.UpdateExternalClusterInstanceDetails) – (required) The details required to update an external cluster instance. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_external_db_home(external_db_home_id, update_external_db_home_details, **kwargs)¶

Updates the external DB home specified by externalDbHomeId.

Parameters:	external_db_home_id (str) – (required) The OCID of the external database home. update_external_db_home_details (oci.database_management.models.UpdateExternalDbHomeDetails) – (required) The details required to update an external DB home. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbHome`
Return type:	`Response`
Example:

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

update_external_db_node(external_db_node_id, update_external_db_node_details, **kwargs)¶

Updates the external DB node specified by externalDbNodeId.

Parameters:	external_db_node_id (str) – (required) The OCID of the external database node. update_external_db_node_details (oci.database_management.models.UpdateExternalDbNodeDetails) – (required) The details required to update an external DB node. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_external_db_system(external_db_system_id, update_external_db_system_details, **kwargs)¶

Updates the external DB system specified by externalDbSystemId.

Parameters:	external_db_system_id (str) – (required) The OCID of the external DB system. update_external_db_system_details (oci.database_management.models.UpdateExternalDbSystemDetails) – (required) The details required to update an external DB system. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystem`
Return type:	`Response`
Example:

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

update_external_db_system_connector(external_db_system_connector_id, update_external_db_system_connector_details, **kwargs)¶

Updates the external connector specified by externalDbSystemConnectorId.

Parameters:	external_db_system_connector_id (str) – (required) The OCID of the external connector. update_external_db_system_connector_details (oci.database_management.models.UpdateExternalDbSystemConnectorDetails) – (required) The details required to update an external connector. 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) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_external_db_system_discovery(external_db_system_discovery_id, update_external_db_system_discovery_details, **kwargs)¶

Updates the external DB system discovery specified by externalDbSystemDiscoveryId.

Parameters:	external_db_system_discovery_id (str) – (required) The OCID of the external DB system discovery. update_external_db_system_discovery_details (oci.database_management.models.UpdateExternalDbSystemDiscoveryDetails) – (required) The details required to update an external DB system discovery. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalDbSystemDiscovery`
Return type:	`Response`
Example:

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

update_external_exadata_infrastructure(external_exadata_infrastructure_id, update_external_exadata_infrastructure_details, **kwargs)¶

Updates the details for the Exadata infrastructure specified by externalExadataInfrastructureId.

Parameters:	external_exadata_infrastructure_id (str) – (required) The OCID of the Exadata infrastructure. update_external_exadata_infrastructure_details (oci.database_management.models.UpdateExternalExadataInfrastructureDetails) – (required) The details required to update the managed Exadata infrastructure resources. opc_request_id (str) – (optional) The client request ID for tracing. 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 might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataInfrastructure`
Return type:	`Response`
Example:

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

update_external_exadata_storage_connector(external_exadata_storage_connector_id, update_external_exadata_storage_connector_details, **kwargs)¶

Updates the Exadata storage server connector specified by exadataStorageConnectorId.

Parameters:	external_exadata_storage_connector_id (str) – (required) The OCID of the connector to the Exadata storage server. update_external_exadata_storage_connector_details (oci.database_management.models.UpdateExternalExadataStorageConnectorDetails) – (required) The details required to update connections to the Exadata storage servers. 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) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageConnector`
Return type:	`Response`
Example:

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

update_external_exadata_storage_grid(external_exadata_storage_grid_id, update_external_exadata_storage_grid_details, **kwargs)¶

Updates the Exadata storage server grid specified by exadataStorageGridId.

Parameters:	external_exadata_storage_grid_id (str) – (required) The OCID of the Exadata storage grid. update_external_exadata_storage_grid_details (oci.database_management.models.UpdateExternalExadataStorageGridDetails) – (required) The details required to update an external Exadata storage grid. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageGrid`
Return type:	`Response`
Example:

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

update_external_exadata_storage_server(external_exadata_storage_server_id, update_external_exadata_storage_server_details, **kwargs)¶

Updates the Exadata storage server specified by exadataStorageServerId.

Parameters:	external_exadata_storage_server_id (str) – (required) The OCID of the Exadata storage server. update_external_exadata_storage_server_details (oci.database_management.models.UpdateExternalExadataStorageServerDetails) – (required) The details required to update an external Exadata storage server. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalExadataStorageServer`
Return type:	`Response`
Example:

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

update_external_listener(external_listener_id, update_external_listener_details, **kwargs)¶

Updates the external listener specified by externalListenerId.

Parameters:	external_listener_id (str) – (required) The OCID of the external listener. update_external_listener_details (oci.database_management.models.UpdateExternalListenerDetails) – (required) The details required to update an external listener. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_job(job_id, update_job_details, **kwargs)¶

Updates the details for the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.

Parameters:	job_id (str) – (required) The identifier of the job. update_job_details (oci.database_management.models.UpdateJobDetails) – (required) The details required to update a job. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Job`
Return type:	`Response`
Example:

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

update_managed_database(managed_database_id, update_managed_database_details, **kwargs)¶

Updates the Managed Database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. update_managed_database_details (oci.database_management.models.UpdateManagedDatabaseDetails) – (required) The details required to update a Managed Database. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedDatabase`
Return type:	`Response`
Example:

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

update_managed_database_group(managed_database_group_id, update_managed_database_group_details, **kwargs)¶

Updates the Managed Database Group specified by managedDatabaseGroupId.

Parameters:	managed_database_group_id (str) – (required) The OCID of the Managed Database Group. update_managed_database_group_details (oci.database_management.models.UpdateManagedDatabaseGroupDetails) – (required) The details required to update a Managed Database Group. 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) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedDatabaseGroup`
Return type:	`Response`
Example:

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

update_named_credential(named_credential_id, update_named_credential_details, **kwargs)¶

Updates the named credential specified by namedCredentialId.

Parameters:	named_credential_id (str) – (required) The OCID of the named credential. update_named_credential_details (oci.database_management.models.UpdateNamedCredentialDetails) – (required) The details required to update a named credential. 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) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NamedCredential`
Return type:	`Response`
Example:

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

update_preferred_credential(managed_database_id, credential_name, update_preferred_credential_details, **kwargs)¶

Updates the preferred credential based on the credentialName.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. credential_name (str) – (required) The name of the preferred credential. update_preferred_credential_details (oci.database_management.models.UpdatePreferredCredentialDetails) – (required) The details required to update preferred credential. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PreferredCredential`
Return type:	`Response`
Example:

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

update_tablespace(managed_database_id, tablespace_name, update_tablespace_details, **kwargs)¶

Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Parameters:	managed_database_id (str) – (required) The OCID of the Managed Database. tablespace_name (str) – (required) The name of the tablespace. update_tablespace_details (oci.database_management.models.UpdateTablespaceDetails) – (required) The details required to update a tablespace. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Tablespace`
Return type:	`Response`
Example:

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