DbManagementClient

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

Use the Database Management API to perform tasks such as obtaining performance and resource usage metrics for a fleet of Managed Databases or a specific Managed Database, creating Managed Database Groups, and running a SQL job on a Managed Database or Managed Database Group.

Methods

__init__(config, **kwargs) Creates a new service client
add_managed_database_to_managed_database_group(…) Adds a Managed Database to a specific Managed Database Group.
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_job_compartment(job_id, …) Moves a job.
change_managed_database_group_compartment(…) Moves a Managed Database Group to a different compartment.
create_db_management_private_endpoint(…) Creates a new Database Management private endpoint.
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.
delete_db_management_private_endpoint(…) Deletes the specified Database Management private endpoint.
delete_job(job_id, **kwargs) Deletes the job specified by jobId.
delete_managed_database_group(…) Deletes the Managed Database Group specified by managedDatabaseGroupId.
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_db_management_private_endpoint(…) Gets the details of the specified Database Management private endpoint.
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_pdb_metrics(managed_database_id, …) Gets a summary of the resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for each Pdb under specified Container database in same compartment as container database.
get_work_request(work_request_id, **kwargs) Gets information of the work request with the given Work Request Id.
list_associated_databases(…) Gets the list of Databases using the specified 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_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_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_tablespaces(managed_database_id, **kwargs) Gets the list of tablespaces 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) Lists all the work requests in the specified compartment.
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.
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_job_executions_statuses(…) Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment.
update_db_management_private_endpoint(…) Updates one or more attributes of the specified Database Management private endpoint.
update_job(job_id, update_job_details, **kwargs) Updates the details for the recurring scheduled job specified by jobId.
update_managed_database_group(…) Updates the Managed Database Group specified by managedDatabaseGroupId.
__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.

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

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type 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 change the compartment of a Database Management private endpoint.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type DbManagementPrivateEndpoint

Return type:

Response

Example:

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

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

Returns:

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

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

Returns:

A Response object with data of type ManagedDatabaseGroup

Return type:

Response

Example:

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

delete_db_management_private_endpoint(db_management_private_endpoint_id, **kwargs)

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

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_managed_database_group 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

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

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

Returns:

A Response object with data of type 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”

  • 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.
  • 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

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

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

Returns:

A Response object with data of type DatabaseHomeMetrics

Return type:

Response

Example:

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

get_db_management_private_endpoint(db_management_private_endpoint_id, **kwargs)

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

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

Returns:

A Response object with data of type DbManagementPrivateEndpoint

Return type:

Response

Example:

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

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

Returns:

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

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

Returns:

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

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

Returns:

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

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

Returns:

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

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

Returns:

A Response object with data of type ManagedDatabaseGroup

Return type:

Response

Example:

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

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

Gets a summary of the resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for each Pdb under specified Container database in same compartment as container database. If comparmentId is provided then for each Pdb under specified compartmentId.

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”

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

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

Returns:

A Response object with data of type PdbMetrics

Return type:

Response

Example:

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

get_work_request(work_request_id, **kwargs)

Gets information of the work request with the given Work Request Id.

Parameters:
  • work_request_id (str) –

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

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

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

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

list_associated_databases(db_management_private_endpoint_id, compartment_id, **kwargs)

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

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

Returns:

A Response object with data of type 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 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type AwrDbCollection

Return type:

Response

Example:

Click here to see an example of how to use list_awr_dbs 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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.

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

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

Returns:

A Response object with data of type DbManagementPrivateEndpointCollection

Return type:

Response

Example:

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

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

Returns:

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

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

Returns:

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

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

Returns:

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

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

Returns:

A Response object with data of type 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”

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

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

Returns:

A Response object with data of type ManagedDatabaseCollection

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type TablespaceCollection

Return type:

Response

Example:

Click here to see an example of how to use list_tablespaces 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 async 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 paginated response.
  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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 async 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 paginated response.
  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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)

Lists all the work requests in the specified compartment.

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 ID of the asynchronous work request.
  • status (str) –

    (optional) A filter to return only resources their 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. 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 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequestCollection

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type UpdateDatabaseParametersResult

Return type:

Response

Example:

Click here to see an example of how to use reset_database_parameters 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type 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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type AwrDbWaitEventCollection

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type JobExecutionsStatusSummaryCollection

Return type:

Response

Example:

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

update_db_management_private_endpoint(db_management_private_endpoint_id, update_db_management_private_endpoint_details, **kwargs)

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

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

Returns:

A Response object with data of type DbManagementPrivateEndpoint

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type Job

Return type:

Response

Example:

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

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

Returns:

A Response object with data of type ManagedDatabaseGroup

Return type:

Response

Example:

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