OperationsInsightsClient¶

class oci.opsi.OperationsInsightsClient(config, **kwargs)¶

Use the Ops Insights API to perform data extraction operations to obtain database resource utilization, performance statistics, and reference information. For more information, see [About Oracle Cloud Infrastructure Ops Insights](https://docs.cloud.oracle.com/en-us/iaas/operations-insights/doc/operations-insights.html).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_exadata_insight_members`(…)	Add new members (e.g.
`change_autonomous_database_insight_advanced_features`(…)	Update connection detail for advanced features of Autonomous Database in Operations Insights.
`change_awr_hub_source_compartment`(…)	Moves an AwrHubSource resource from one compartment to another.
`change_database_insight_compartment`(…)	Moves a DatabaseInsight resource from one compartment identifier to another.
`change_enterprise_manager_bridge_compartment`(…)	Moves a EnterpriseManagerBridge resource from one compartment to another.
`change_exadata_insight_compartment`(…)	Moves an Exadata insight resource from one compartment identifier to another.
`change_host_insight_compartment`(…)	Moves a HostInsight resource from one compartment identifier to another.
`change_macs_managed_cloud_database_insight_connection`(…)	Change the connection details of a Cloud MACS-managed database insight.
`change_news_report_compartment`(…)	Moves a news report resource from one compartment identifier to another.
`change_operations_insights_private_endpoint_compartment`(…)	Moves a private endpoint from one compartment to another.
`change_operations_insights_warehouse_compartment`(…)	Moves a Operations Insights Warehouse resource from one compartment to another.
`change_opsi_configuration_compartment`(…)	Moves an OpsiConfiguration resource from one compartment to another.
`change_pe_comanaged_database_insight`(…)	Change the connection details of a co-managed database insight.
`create_awr_hub`(create_awr_hub_details, **kwargs)	Create a AWR hub resource for the tenant in Operations Insights.
`create_awr_hub_source`(…)	Register Awr Hub source
`create_database_insight`(…)	Create a Database Insight resource for a database in Operations Insights.
`create_enterprise_manager_bridge`(…)	Create a Enterprise Manager bridge in Operations Insights.
`create_exadata_insight`(…)	Create an Exadata insight resource for an Exadata system in Operations Insights.
`create_host_insight`(…)	Create a Host Insight resource for a host in Ops Insights.
`create_news_report`(…)	Create a news report in Ops Insights.
`create_operations_insights_private_endpoint`(…)	Create a private endpoint resource for the tenant in Ops Insights.
`create_operations_insights_warehouse`(…)	Create a Ops Insights Warehouse resource for the tenant in Ops Insights.
`create_operations_insights_warehouse_user`(…)	Create a Operations Insights Warehouse user resource for the tenant in Operations Insights.
`create_opsi_configuration`(…)	Create an OPSI configuration resource.
`delete_awr_hub`(awr_hub_id, **kwargs)	Deletes an AWR hub.
`delete_awr_hub_object`(awr_hub_source_id, …)	Deletes an Awr Hub object.
`delete_awr_hub_source`(awr_hub_source_id, …)	Deletes an Awr Hub source object.
`delete_database_insight`(database_insight_id, …)	Deletes a database insight.
`delete_enterprise_manager_bridge`(…)	Deletes an Operations Insights Enterprise Manager bridge.
`delete_exadata_insight`(exadata_insight_id, …)	Deletes an Exadata insight.
`delete_host_insight`(host_insight_id, **kwargs)	Deletes a host insight.
`delete_news_report`(news_report_id, **kwargs)	Deletes a news report.
`delete_operations_insights_private_endpoint`(…)	Deletes a private endpoint.
`delete_operations_insights_warehouse`(…)	Deletes an Operations Insights Warehouse.
`delete_operations_insights_warehouse_user`(…)	Deletes an Operations Insights Warehouse User.
`delete_opsi_configuration`(…)	Deletes an OPSI configuration resource.
`disable_autonomous_database_insight_advanced_features`(…)	Disable advanced features for an Autonomous Database in Operations Insights.
`disable_awr_hub_source`(awr_hub_source_id, …)	Disables a Awr Hub source database in Operations Insights.
`disable_database_insight`(…)	Disables a database in Operations Insights.
`disable_exadata_insight`(exadata_insight_id, …)	Disables an Exadata system in Operations Insights.
`disable_host_insight`(host_insight_id, **kwargs)	Disables a host in Ops Insights.
`download_operations_insights_warehouse_wallet`(…)	Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.
`enable_autonomous_database_insight_advanced_features`(…)	Enables advanced features for an Autonomous Database in Operations Insights.
`enable_awr_hub_source`(awr_hub_source_id, …)	Enables a Awr Hub source database in Operations Insights.
`enable_database_insight`(…)	Enables a database in Operations Insights.
`enable_exadata_insight`(…)	Enables an Exadata system in Operations Insights.
`enable_host_insight`(…)	Enables a host in Ops Insights.
`get_awr_database_report`(awr_hub_id, …)	Gets the AWR report for the specified database.
`get_awr_database_sql_report`(awr_hub_id, …)	Gets the SQL health check report for one SQL of the specified database.
`get_awr_hub`(awr_hub_id, **kwargs)	Gets details of an AWR hub.
`get_awr_hub_object`(awr_hub_source_id, …)	Gets the Awr Hub object metadata and body.
`get_awr_hub_source`(awr_hub_source_id, **kwargs)	Gets the Awr Hub source object.
`get_awr_report`(awr_hub_id, …)	Gets the AWR report for the specified source database in the AWR hub.
`get_database_insight`(database_insight_id, …)	Gets details of a database insight.
`get_enterprise_manager_bridge`(…)	Gets details of an Operations Insights Enterprise Manager bridge.
`get_exadata_insight`(exadata_insight_id, **kwargs)	Gets details of an Exadata insight.
`get_host_insight`(host_insight_id, **kwargs)	Gets details of a host insight.
`get_news_report`(news_report_id, **kwargs)	Gets details of a news report.
`get_operations_insights_private_endpoint`(…)	Gets the details of the specified private endpoint.
`get_operations_insights_warehouse`(…)	Gets details of an Ops Insights Warehouse.
`get_operations_insights_warehouse_user`(…)	Gets details of an Operations Insights Warehouse User.
`get_opsi_configuration`(…)	Gets details of an OPSI configuration resource.
`get_opsi_data_object`(compartment_id, …)	Gets details of an OPSI data object.
`get_work_request`(work_request_id, **kwargs)	Gets the status of the work request with the given ID.
`head_awr_hub_object`(awr_hub_source_id, …)	Gets the Awr Hub object’s user-defined metadata and entity tag (ETag).
`ingest_addm_reports`(…)	This endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.
`ingest_database_configuration`(…)	This is a generic ingest endpoint for all database configuration metrics.
`ingest_host_configuration`(id, …)	This is a generic ingest endpoint for all the host configuration metrics
`ingest_host_metrics`(id, …)	This is a generic ingest endpoint for all the host performance metrics
`ingest_my_sql_sql_stats`(…)	The MySql SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline.
`ingest_my_sql_sql_text`(…)	The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.
`ingest_sql_bucket`(ingest_sql_bucket_details, …)	The sqlbucket endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline.
`ingest_sql_plan_lines`(…)	The SqlPlanLines endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.
`ingest_sql_stats`(ingest_sql_stats_details, …)	The SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline.
`ingest_sql_text`(ingest_sql_text_details, …)	The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline.
`list_addm_db_finding_categories`(…)	Gets list of ADDM finding categories.
`list_addm_db_findings_time_series`(…)	Get the ADDM findings time series for the specified databases for a given time period.
`list_addm_db_parameter_categories`(…)	Gets list of ADDM database parameter categories for the specified databases.
`list_addm_db_recommendation_categories`(…)	Gets list of ADDM recommendation categories for the specified databases.
`list_addm_db_recommendations_time_series`(…)	Gets time series data for ADDM recommendations for the specified databases.
`list_addm_dbs`(compartment_id, **kwargs)	Gets a list of ADDM database information
`list_awr_database_snapshots`(awr_hub_id, …)	Lists AWR snapshots for the specified database in the AWR.
`list_awr_databases`(awr_hub_id, **kwargs)	Gets the list of databases and their snapshot summary details available in the AWRHub.
`list_awr_hub_objects`(awr_hub_source_id, **kwargs)	Gets a list of Awr Hub objects.
`list_awr_hub_sources`(awr_hub_id, **kwargs)	Gets a list of Awr Hub source objects.
`list_awr_hubs`(…)	Gets a list of AWR hubs.
`list_awr_snapshots`(awr_hub_id, …)	Lists AWR snapshots for the specified source database in the AWR hub.
`list_database_configurations`(**kwargs)	Gets a list of database insight configurations based on the query parameters specified.
`list_database_insights`(**kwargs)	Gets a list of database insights based on the query parameters specified.
`list_enterprise_manager_bridges`(**kwargs)	Gets a list of Ops Insights Enterprise Manager bridges.
`list_exadata_configurations`(**kwargs)	Gets a list of exadata insight configurations.
`list_exadata_insights`(**kwargs)	Gets a list of Exadata insights based on the query parameters specified.
`list_host_configurations`(**kwargs)	Gets a list of host insight configurations based on the query parameters specified.
`list_host_insights`(**kwargs)	Gets a list of host insights based on the query parameters specified.
`list_hosted_entities`(compartment_id, id, …)	Get a list of hosted entities details.
`list_importable_agent_entities`(…)	Gets a list of agent entities available to add a new hostInsight.
`list_importable_compute_entities`(…)	Gets a list of available compute intances running cloud agent to add a new hostInsight.
`list_importable_enterprise_manager_entities`(…)	Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before.
`list_news_reports`(**kwargs)	Gets a list of news reports based on the query parameters specified.
`list_operations_insights_private_endpoints`(…)	Gets a list of Operation Insights private endpoints.
`list_operations_insights_warehouse_users`(…)	Gets a list of Operations Insights Warehouse users.
`list_operations_insights_warehouses`(**kwargs)	Gets a list of Ops Insights warehouses.
`list_opsi_configurations`(compartment_id, …)	Gets a list of OPSI configuration resources based on the query parameters specified.
`list_opsi_data_objects`(compartment_id, **kwargs)	Gets a list of OPSI data objects based on the query parameters specified.
`list_sql_plans`(compartment_id, …)	Query SQL Warehouse to list the plan xml for a given SQL execution plan.
`list_sql_searches`(compartment_id, …)	Search SQL by SQL Identifier across databases in a compartment and in all sub-compartments if specified.
`list_sql_texts`(compartment_id, …)	Query SQL Warehouse to get the full SQL Text for a SQL in a compartment and in all sub-compartments if specified.
`list_warehouse_data_objects`(warehouse_type, …)	Gets a list of Warehouse data objects (e.g: views, tables), based on the query parameters specified.
`list_work_request_errors`(work_request_id, …)	Return a (paginated) list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Return a (paginated) list of logs for a given work request.
`list_work_requests`(**kwargs)	Lists the work requests in a compartment.
`put_awr_hub_object`(put_awr_hub_object_body, …)	Creates a new object or overwrites an existing object with the same name to the Awr Hub.
`query_opsi_data_object_data`(compartment_id, …)	Queries an OPSI data object with the inputs provided and sends the result set back.
`query_warehouse_data_object_data`(…)	Queries Warehouse data objects (e.g: views, tables) with the inputs provided and sends the result set back.
`rotate_operations_insights_warehouse_wallet`(…)	Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.
`summarize_addm_db_findings`(compartment_id, …)	Summarizes ADDM findings for the specified databases.
`summarize_addm_db_parameter_changes`(…)	Summarizes the AWR database parameter change history for the specified parameter.
`summarize_addm_db_parameters`(compartment_id, …)	Summarizes database parameter history information for the specified databases.
`summarize_addm_db_recommendations`(…)	Summarizes ADDM recommendations for the specified databases.
`summarize_addm_db_schema_objects`(…)	Summarizes Schema objects for the specified databases for the specified objectIdentifiers
`summarize_addm_db_sql_statements`(…)	Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers
`summarize_awr_database_cpu_usages`(…)	Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.
`summarize_awr_database_metrics`(awr_hub_id, …)	Summarizes the metric samples for the specified database in the AWR.
`summarize_awr_database_parameter_changes`(…)	Summarizes the database parameter change history for one database parameter of the specified database in AWR.
`summarize_awr_database_parameters`(…)	Summarizes the database parameter history for the specified database in AWR.
`summarize_awr_database_snapshot_ranges`(…)	Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified AWRHub.
`summarize_awr_database_sysstats`(awr_hub_id, …)	Summarizes the AWR SYSSTAT sample data for the specified database in AWR.
`summarize_awr_database_top_wait_events`(…)	Summarizes the AWR top wait events.
`summarize_awr_database_wait_event_buckets`(…)	Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.
`summarize_awr_database_wait_events`(…)	Summarizes the AWR wait event sample data for the specified database in the AWR.
`summarize_awr_sources_summaries`(awr_hub_id, …)	Gets a list of summary of AWR Sources.
`summarize_configuration_items`(**kwargs)	Gets the applicable configuration items based on the query parameters specified.
`summarize_database_insight_resource_capacity_trend`(…)	Returns response with time series data (endTimestamp, capacity, baseCapacity) for the time period specified.
`summarize_database_insight_resource_forecast_trend`(…)	Get Forecast predictions for CPU and Storage resources since a time in the past.
`summarize_database_insight_resource_statistics`(…)	Lists the Resource statistics (usage,capacity, usage change percent, utilization percent, base capacity, isAutoScalingEnabled) for each database filtered by utilization level in a compartment and in all sub-compartments if specified.
`summarize_database_insight_resource_usage`(…)	A cumulative distribution function is used to rank the usage data points per database within the specified time period.
`summarize_database_insight_resource_usage_trend`(…)	Returns response with time series data (endTimestamp, usage, capacity) for the time period specified.
`summarize_database_insight_resource_utilization_insight`(…)	Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period.
`summarize_database_insight_tablespace_usage_trend`(…)	Returns response with usage time series data (endTimestamp, usage, capacity) with breakdown by tablespaceName for the time period specified.
`summarize_exadata_insight_resource_capacity_trend`(…)	Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system for a resource metric.
`summarize_exadata_insight_resource_capacity_trend_aggregated`(…)	Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system or fleet aggregation for a resource metric.
`summarize_exadata_insight_resource_forecast_trend`(…)	Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts or storage servers.
`summarize_exadata_insight_resource_forecast_trend_aggregated`(…)	Get aggregated historical usage and forecast predictions for resources.
`summarize_exadata_insight_resource_statistics`(…)	Lists the Resource statistics (usage, capacity, usage change percent, utilization percent) for each resource based on resourceMetric filtered by utilization level.
`summarize_exadata_insight_resource_usage`(…)	A cumulative distribution function is used to rank the usage data points per resource within the specified time period.
`summarize_exadata_insight_resource_usage_aggregated`(…)	A cumulative distribution function is used to rank the usage data points per database within the specified time period.
`summarize_exadata_insight_resource_utilization_insight`(…)	Gets current utilization, projected utilization and days to reach projectedUtilization for an exadata system over specified time period.
`summarize_exadata_members`(…)	Lists the software and hardware inventory of the Exadata System.
`summarize_host_insight_disk_statistics`(…)	Returns response with disk(s) statistics for a host.
`summarize_host_insight_host_recommendation`(…)	Returns response with some recommendations if apply for a host.
`summarize_host_insight_io_usage_trend`(…)	Returns response with usage time series data with breakdown by IO interface for the time period specified.
`summarize_host_insight_network_usage_trend`(…)	Returns response with usage time series data with breakdown by network interface for the time period specified.
`summarize_host_insight_resource_capacity_trend`(…)	Returns response with time series data (endTimestamp, capacity) for the time period specified.
`summarize_host_insight_resource_forecast_trend`(…)	Get Forecast predictions for CPU or memory resources since a time in the past.
`summarize_host_insight_resource_statistics`(…)	Lists the resource statistics (usage, capacity, usage change percent, utilization percent, load) for each host filtered by utilization level in a compartment and in all sub-compartments if specified.
`summarize_host_insight_resource_usage`(…)	A cumulative distribution function is used to rank the usage data points per host within the specified time period.
`summarize_host_insight_resource_usage_trend`(…)	Returns response with time series data (endTimestamp, usage, capacity) for the time period specified.
`summarize_host_insight_resource_utilization_insight`(…)	Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period.
`summarize_host_insight_storage_usage_trend`(…)	Returns response with usage time series data with breakdown by filesystem for the time period specified.
`summarize_host_insight_top_processes_usage`(…)	Returns response with aggregated data (timestamp, usageData) for top processes on a specific date.
`summarize_host_insight_top_processes_usage_trend`(…)	Returns response with aggregated time series data (timeIntervalstart, timeIntervalEnd, commandArgs, usageData) for top processes.
`summarize_operations_insights_warehouse_resource_usage`(…)	Gets the details of resources used by an Operations Insights Warehouse.
`summarize_sql_insights`(compartment_id, **kwargs)	Query SQL Warehouse to get the performance insights for SQLs taking greater than X% database time for a given time period across the given databases or database types in a compartment and in all sub-compartments if specified.
`summarize_sql_plan_insights`(compartment_id, …)	Query SQL Warehouse to get the performance insights on the execution plans for a given SQL for a given time period.
`summarize_sql_response_time_distributions`(…)	Query SQL Warehouse to summarize the response time distribution of query executions for a given SQL for a given time period.
`summarize_sql_statistics`(compartment_id, …)	Query SQL Warehouse to get the performance statistics for SQLs taking greater than X% database time for a given time period across the given databases or database types in a compartment and in all sub-compartments if specified.
`summarize_sql_statistics_time_series`(…)	Query SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a given time period in a compartment and in all sub-compartments if specified.
`summarize_sql_statistics_time_series_by_plan`(…)	Query SQL Warehouse to get the performance statistics time series for a given SQL by execution plans for a given time period.
`test_macs_managed_cloud_database_insight_connection`(…)	Test the connection details of a Cloud MACS-managed database.
`update_awr_hub`(awr_hub_id, …)	Updates the configuration of a hub .
`update_awr_hub_source`(…)	Update Awr Hub Source object.
`update_database_insight`(database_insight_id, …)	Updates configuration of a database insight.
`update_enterprise_manager_bridge`(…)	Updates configuration of an Operations Insights Enterprise Manager bridge.
`update_exadata_insight`(exadata_insight_id, …)	Updates configuration of an Exadata insight.
`update_host_insight`(host_insight_id, …)	Updates configuration of a host insight.
`update_news_report`(news_report_id, …)	Updates the configuration of a news report.
`update_operations_insights_private_endpoint`(…)	Updates one or more attributes of the specified private endpoint.
`update_operations_insights_warehouse`(…)	Updates the configuration of an Ops Insights Warehouse.
`update_operations_insights_warehouse_user`(…)	Updates the configuration of an Operations Insights Warehouse User.
`update_opsi_configuration`(…)	Updates an OPSI configuration resource with the given ID.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

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

add_exadata_insight_members(add_exadata_insight_members_details, exadata_insight_id, **kwargs)¶

Add new members (e.g. databases and hosts) to an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started.

Parameters:	add_exadata_insight_members_details (oci.opsi.models.AddExadataInsightMembersDetails) – (required) Details for the members (e.g. databases and hosts) of an Exadata system to be added in Operations Insights. exadata_insight_id (str) – (required) Unique Exadata insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_autonomous_database_insight_advanced_features(change_autonomous_database_insight_advanced_features_details, database_insight_id, **kwargs)¶

Update connection detail for advanced features of Autonomous Database in Operations Insights.

Parameters:	change_autonomous_database_insight_advanced_features_details (oci.opsi.models.ChangeAutonomousDatabaseInsightAdvancedFeaturesDetails) – (required) Details for the advanced features of Autonomous Database in Operations Insights. database_insight_id (str) – (required) Unique database insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_awr_hub_source_compartment(awr_hub_source_id, change_awr_hub_source_compartment_details, **kwargs)¶

Moves an AwrHubSource resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier change_awr_hub_source_compartment_details (oci.opsi.models.ChangeAwrHubSourceCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_database_insight_compartment(database_insight_id, change_database_insight_compartment_details, **kwargs)¶

Moves a DatabaseInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	database_insight_id (str) – (required) Unique database insight identifier change_database_insight_compartment_details (oci.opsi.models.ChangeDatabaseInsightCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_enterprise_manager_bridge_compartment(enterprise_manager_bridge_id, change_enterprise_manager_bridge_compartment_details, **kwargs)¶

Moves a EnterpriseManagerBridge resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	enterprise_manager_bridge_id (str) – (required) Unique Enterprise Manager bridge identifier change_enterprise_manager_bridge_compartment_details (oci.opsi.models.ChangeEnterpriseManagerBridgeCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_exadata_insight_compartment(exadata_insight_id, change_exadata_insight_compartment_details, **kwargs)¶

Moves an Exadata insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	exadata_insight_id (str) – (required) Unique Exadata insight identifier change_exadata_insight_compartment_details (oci.opsi.models.ChangeExadataInsightCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_host_insight_compartment(host_insight_id, change_host_insight_compartment_details, **kwargs)¶

Moves a HostInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	host_insight_id (str) – (required) Unique host insight identifier change_host_insight_compartment_details (oci.opsi.models.ChangeHostInsightCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_macs_managed_cloud_database_insight_connection(database_insight_id, change_macs_managed_cloud_database_insight_connection_details, **kwargs)¶

Change the connection details of a Cloud MACS-managed database insight. When provided, If-Match is checked against ETag values of the resource.

Parameters:	database_insight_id (str) – (required) Unique database insight identifier change_macs_managed_cloud_database_insight_connection_details (oci.opsi.models.ChangeMacsManagedCloudDatabaseInsightConnectionDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_news_report_compartment(news_report_id, change_news_report_compartment_details, **kwargs)¶

Moves a news report resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	news_report_id (str) – (required) Unique news report identifier. change_news_report_compartment_details (oci.opsi.models.ChangeNewsReportCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_operations_insights_private_endpoint_compartment(operations_insights_private_endpoint_id, change_operations_insights_private_endpoint_compartment_details, **kwargs)¶

Moves a private endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	operations_insights_private_endpoint_id (str) – (required) The OCID of the Operation Insights private endpoint. change_operations_insights_private_endpoint_compartment_details (oci.opsi.models.ChangeOperationsInsightsPrivateEndpointCompartmentDetails) – (required) The details used to change the compartment of a private endpoint if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_operations_insights_warehouse_compartment(operations_insights_warehouse_id, change_operations_insights_warehouse_compartment_details, **kwargs)¶

Moves a Operations Insights Warehouse resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Ops Insights Warehouse identifier change_operations_insights_warehouse_compartment_details (oci.opsi.models.ChangeOperationsInsightsWarehouseCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_opsi_configuration_compartment(opsi_configuration_id, change_opsi_configuration_compartment_details, **kwargs)¶

Moves an OpsiConfiguration resource from one compartment to another.

Parameters:	opsi_configuration_id (str) – (required) OCID of OPSI configuration resource. change_opsi_configuration_compartment_details (oci.opsi.models.ChangeOpsiConfigurationCompartmentDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_pe_comanaged_database_insight(database_insight_id, change_pe_comanaged_database_insight_details, **kwargs)¶

Change the connection details of a co-managed database insight. When provided, If-Match is checked against ETag values of the resource.

Parameters:	database_insight_id (str) – (required) Unique database insight identifier change_pe_comanaged_database_insight_details (oci.opsi.models.ChangePeComanagedDatabaseInsightDetails) – (required) The information to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

create_awr_hub(create_awr_hub_details, **kwargs)¶

Create a AWR hub resource for the tenant in Operations Insights. This resource will be created in root compartment.

Parameters:	create_awr_hub_details (oci.opsi.models.CreateAwrHubDetails) – (required) Details using which an AWR hub resource will be created in Operations Insights. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrHub`
Return type:	`Response`
Example:

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

create_awr_hub_source(create_awr_hub_source_details, **kwargs)¶

Register Awr Hub source

Parameters:	create_awr_hub_source_details (oci.opsi.models.CreateAwrHubSourceDetails) – (required) Payload containing details to register the source database opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrHubSource`
Return type:	`Response`
Example:

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

create_database_insight(create_database_insight_details, **kwargs)¶

Create a Database Insight resource for a database in Operations Insights. The database will be enabled in Operations Insights. Database metric collection and analysis will be started.

Parameters:	create_database_insight_details (oci.opsi.models.CreateDatabaseInsightDetails) – (required) Details for the database for which a Database Insight resource will be created in Operations Insights. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseInsight`
Return type:	`Response`
Example:

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

create_enterprise_manager_bridge(create_enterprise_manager_bridge_details, **kwargs)¶

Create a Enterprise Manager bridge in Operations Insights.

Parameters:	create_enterprise_manager_bridge_details (oci.opsi.models.CreateEnterpriseManagerBridgeDetails) – (required) Details for the Enterprise Manager bridge to be created in Operations Insights. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EnterpriseManagerBridge`
Return type:	`Response`
Example:

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

create_exadata_insight(create_exadata_insight_details, **kwargs)¶

Create an Exadata insight resource for an Exadata system in Operations Insights. The Exadata system will be enabled in Operations Insights. Exadata-related metric collection and analysis will be started.

Parameters:	create_exadata_insight_details (oci.opsi.models.CreateExadataInsightDetails) – (required) Details for the Exadata system for which an Exadata insight resource will be created in Operations Insights. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExadataInsight`
Return type:	`Response`
Example:

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

create_host_insight(create_host_insight_details, **kwargs)¶

Create a Host Insight resource for a host in Ops Insights. The host will be enabled in Ops Insights. Host metric collection and analysis will be started.

Parameters:	create_host_insight_details (oci.opsi.models.CreateHostInsightDetails) – (required) Details for the host for which a Host Insight resource will be created in Ops Insights. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `HostInsight`
Return type:	`Response`
Example:

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

create_news_report(create_news_report_details, **kwargs)¶

Create a news report in Ops Insights. The report will be enabled in Ops Insights. Insights will be emailed as per selected frequency.

Parameters:	create_news_report_details (oci.opsi.models.CreateNewsReportDetails) – (required) Details for the news report that will be created in Ops Insights. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NewsReport`
Return type:	`Response`
Example:

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

create_operations_insights_private_endpoint(create_operations_insights_private_endpoint_details, **kwargs)¶

Create a private endpoint resource for the tenant in Ops Insights. This resource will be created in customer compartment.

Parameters:	create_operations_insights_private_endpoint_details (oci.opsi.models.CreateOperationsInsightsPrivateEndpointDetails) – (required) Details to create a new private endpoint. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsPrivateEndpoint`
Return type:	`Response`
Example:

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

create_operations_insights_warehouse(create_operations_insights_warehouse_details, **kwargs)¶

Create a Ops Insights Warehouse resource for the tenant in Ops Insights. New ADW will be provisioned for this tenant. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. If the ‘opsi-warehouse-type’ header is passed to the API, a warehouse resource without ADW or Schema provisioning is created.

Parameters:	create_operations_insights_warehouse_details (oci.opsi.models.CreateOperationsInsightsWarehouseDetails) – (required) Details using which an Ops Insights Warehouse resource will be created in Ops Insights. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsWarehouse`
Return type:	`Response`
Example:

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

create_operations_insights_warehouse_user(create_operations_insights_warehouse_user_details, **kwargs)¶

Create a Operations Insights Warehouse user resource for the tenant in Operations Insights. This resource will be created in root compartment.

Parameters:	create_operations_insights_warehouse_user_details (oci.opsi.models.CreateOperationsInsightsWarehouseUserDetails) – (required) Parameter using which an Operations Insights Warehouse user resource will be created. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsWarehouseUser`
Return type:	`Response`
Example:

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

create_opsi_configuration(create_opsi_configuration_details, **kwargs)¶

Create an OPSI configuration resource.

Parameters:	create_opsi_configuration_details (oci.opsi.models.CreateOpsiConfigurationDetails) – (required) Information about OPSI configuration resource to be created. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opsi_config_field (list[str]) – (optional) Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default. Allowed values are: “configItems” config_item_custom_status (list[str]) – (optional) Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned. Allowed values are: “customized”, “nonCustomized” config_items_applicable_context (list[str]) – (optional) Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. config_item_field (list[str]) – (optional) Specifies the fields to return in a config item summary. Allowed values are: “name”, “value”, “defaultValue”, “metadata”, “applicableContexts” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OpsiConfiguration`
Return type:	`Response`
Example:

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

delete_awr_hub(awr_hub_id, **kwargs)¶

Deletes an AWR hub.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_awr_hub_object(awr_hub_source_id, object_name, **kwargs)¶

Deletes an Awr Hub object.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier object_name (str) – (required) Unique Awr Hub Object identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_awr_hub_source(awr_hub_source_id, **kwargs)¶

Deletes an Awr Hub source object.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_database_insight(database_insight_id, **kwargs)¶

Deletes a database insight. The database insight will be deleted and cannot be enabled again.

Parameters:	database_insight_id (str) – (required) Unique database insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_enterprise_manager_bridge(enterprise_manager_bridge_id, **kwargs)¶

Deletes an Operations Insights Enterprise Manager bridge. If any database insight is still referencing this bridge, the operation will fail.

Parameters:	enterprise_manager_bridge_id (str) – (required) Unique Enterprise Manager bridge identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_exadata_insight(exadata_insight_id, **kwargs)¶

Deletes an Exadata insight. The Exadata insight will be deleted and cannot be enabled again.

Parameters:	exadata_insight_id (str) – (required) Unique Exadata insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_host_insight(host_insight_id, **kwargs)¶

Deletes a host insight. The host insight will be deleted and cannot be enabled again.

Parameters:	host_insight_id (str) – (required) Unique host insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_news_report(news_report_id, **kwargs)¶

Deletes a news report. The news report will be deleted and cannot be enabled again.

Parameters:	news_report_id (str) – (required) Unique news report identifier. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_operations_insights_private_endpoint(operations_insights_private_endpoint_id, **kwargs)¶

Deletes a private endpoint.

Parameters:	operations_insights_private_endpoint_id (str) – (required) The OCID of the Operation Insights private endpoint. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_operations_insights_warehouse(operations_insights_warehouse_id, **kwargs)¶

Deletes an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. User must delete AWR Hub resource for this warehouse before calling this operation. User must delete the warehouse users before calling this operation.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Ops Insights Warehouse identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_operations_insights_warehouse_user(operations_insights_warehouse_user_id, **kwargs)¶

Deletes an Operations Insights Warehouse User.

Parameters:	operations_insights_warehouse_user_id (str) – (required) Unique Operations Insights Warehouse User identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_opsi_configuration(opsi_configuration_id, **kwargs)¶

Deletes an OPSI configuration resource.

Parameters:	opsi_configuration_id (str) – (required) OCID of OPSI configuration resource. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_autonomous_database_insight_advanced_features(database_insight_id, **kwargs)¶

Disable advanced features for an Autonomous Database in Operations Insights. The connection detail and advanced features will be removed.

Parameters:	database_insight_id (str) – (required) Unique database insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_awr_hub_source(awr_hub_source_id, **kwargs)¶

Disables a Awr Hub source database in Operations Insights. This will stop the Awr data flow for the given Awr Hub source.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_database_insight(database_insight_id, **kwargs)¶

Disables a database in Operations Insights. Database metric collection and analysis will be stopped.

Parameters:	database_insight_id (str) – (required) Unique database insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_exadata_insight(exadata_insight_id, **kwargs)¶

Disables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be stopped.

Parameters:	exadata_insight_id (str) – (required) Unique Exadata insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

disable_host_insight(host_insight_id, **kwargs)¶

Disables a host in Ops Insights. Host metric collection and analysis will be stopped.

Parameters:	host_insight_id (str) – (required) Unique host insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

download_operations_insights_warehouse_wallet(operations_insights_warehouse_id, download_operations_insights_warehouse_wallet_details, **kwargs)¶

Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Ops Insights Warehouse identifier download_operations_insights_warehouse_wallet_details (oci.opsi.models.DownloadOperationsInsightsWarehouseWalletDetails) – (required) The information to be updated. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

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

enable_autonomous_database_insight_advanced_features(enable_autonomous_database_insight_advanced_features_details, database_insight_id, **kwargs)¶

Enables advanced features for an Autonomous Database in Operations Insights. A direct connection will be available for further collection.

Parameters:	enable_autonomous_database_insight_advanced_features_details (oci.opsi.models.EnableAutonomousDatabaseInsightAdvancedFeaturesDetails) – (required) Connection Details for the Autonomous Database in Operations Insights. database_insight_id (str) – (required) Unique database insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_awr_hub_source(awr_hub_source_id, **kwargs)¶

Enables a Awr Hub source database in Operations Insights. This will resume the Awr data flow for the given Awr Hub source if it was stopped earlier.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_database_insight(enable_database_insight_details, database_insight_id, **kwargs)¶

Enables a database in Operations Insights. Database metric collection and analysis will be started.

Parameters:	enable_database_insight_details (oci.opsi.models.EnableDatabaseInsightDetails) – (required) Details for the database to be enabled in Operations Insights. database_insight_id (str) – (required) Unique database insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_exadata_insight(enable_exadata_insight_details, exadata_insight_id, **kwargs)¶

Enables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started.

Parameters:	enable_exadata_insight_details (oci.opsi.models.EnableExadataInsightDetails) – (required) Details for the Exadata system to be enabled in Operations Insights. exadata_insight_id (str) – (required) Unique Exadata insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

enable_host_insight(enable_host_insight_details, host_insight_id, **kwargs)¶

Enables a host in Ops Insights. Host metric collection and analysis will be started.

Parameters:	enable_host_insight_details (oci.opsi.models.EnableHostInsightDetails) – (required) Details for the host to be enabled in Ops Insights. host_insight_id (str) – (required) Unique host insight identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

get_awr_database_report(awr_hub_id, awr_source_database_identifier, **kwargs)¶

Gets the AWR report for the specified database.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z report_type (str) – (optional) The query parameter to filter the AWR report types. Allowed values are: “AWR”, “ASH” report_format (str) – (optional) The format of the AWR report. Allowed values are: “HTML”, “TEXT” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseReport`
Return type:	`Response`
Example:

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

get_awr_database_sql_report(awr_hub_id, awr_source_database_identifier, sql_id, **kwargs)¶

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

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases 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 (/awrHubs/{awrHubId}/awrDbReport). instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z report_format (str) – (optional) The format of the AWR report. Allowed values are: “HTML”, “TEXT” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseSqlReport`
Return type:	`Response`
Example:

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

get_awr_hub(awr_hub_id, **kwargs)¶

Gets details of an AWR hub.

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

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

get_awr_hub_object(awr_hub_source_id, object_name, **kwargs)¶

Gets the Awr Hub object metadata and body.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier object_name (str) – (required) Unique Awr Hub Object identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

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

get_awr_hub_source(awr_hub_source_id, **kwargs)¶

Gets the Awr Hub source object.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrHubSource`
Return type:	`Response`
Example:

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

get_awr_report(awr_hub_id, awr_source_database_identifier, **kwargs)¶

Gets the AWR report for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not be greater than 7 days. Either beginSnapshotIdentifierGreaterThanOrEqualTo & endSnapshotIdentifierLessThanOrEqualTo params Or timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are required.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) AWR source database identifier. report_format (str) – (optional) The format of the AWR report. Default report format is HTML. Allowed values are: “HTML”, “TEXT” instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrReport`
Return type:	`Response`
Example:

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

get_database_insight(database_insight_id, **kwargs)¶

Gets details of a database insight.

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

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

get_enterprise_manager_bridge(enterprise_manager_bridge_id, **kwargs)¶

Gets details of an Operations Insights Enterprise Manager bridge.

Parameters:	enterprise_manager_bridge_id (str) – (required) Unique Enterprise Manager bridge identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EnterpriseManagerBridge`
Return type:	`Response`
Example:

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

get_exadata_insight(exadata_insight_id, **kwargs)¶

Gets details of an Exadata insight.

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

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

get_host_insight(host_insight_id, **kwargs)¶

Gets details of a host insight.

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

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

get_news_report(news_report_id, **kwargs)¶

Gets details of a news report.

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

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

get_operations_insights_private_endpoint(operations_insights_private_endpoint_id, **kwargs)¶

Gets the details of the specified private endpoint.

Parameters:	operations_insights_private_endpoint_id (str) – (required) The OCID of the Operation Insights private endpoint. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsPrivateEndpoint`
Return type:	`Response`
Example:

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

get_operations_insights_warehouse(operations_insights_warehouse_id, **kwargs)¶

Gets details of an Ops Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Ops Insights Warehouse identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsWarehouse`
Return type:	`Response`
Example:

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

get_operations_insights_warehouse_user(operations_insights_warehouse_user_id, **kwargs)¶

Gets details of an Operations Insights Warehouse User.

Parameters:	operations_insights_warehouse_user_id (str) – (required) Unique Operations Insights Warehouse User identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsWarehouseUser`
Return type:	`Response`
Example:

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

get_opsi_configuration(opsi_configuration_id, **kwargs)¶

Gets details of an OPSI configuration resource. Values specified in configItemField and configItemCustomStatus query params will be considered, only if configItems field is requested as part of opsiConfigField query param. Values specified in configItemCustomStatus will determine whether only customized configuration items or only non-customized configuration items or both have to be returned.

Parameters:	opsi_configuration_id (str) – (required) OCID of OPSI configuration resource. opsi_config_field (list[str]) – (optional) Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default. Allowed values are: “configItems” config_item_custom_status (list[str]) – (optional) Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned. Allowed values are: “customized”, “nonCustomized” config_items_applicable_context (list[str]) – (optional) Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. config_item_field (list[str]) – (optional) Specifies the fields to return in a config item summary. Allowed values are: “name”, “value”, “defaultValue”, “metadata”, “applicableContexts” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OpsiConfiguration`
Return type:	`Response`
Example:

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

get_opsi_data_object(compartment_id, opsi_data_object_identifier, **kwargs)¶

Gets details of an OPSI data object.

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

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

get_work_request(work_request_id, **kwargs)¶

Gets the status of the work request with the given ID.

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

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

head_awr_hub_object(awr_hub_source_id, object_name, **kwargs)¶

Gets the Awr Hub object’s user-defined metadata and entity tag (ETag).

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier object_name (str) – (required) Unique Awr Hub Object identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

ingest_addm_reports(ingest_addm_reports_details, **kwargs)¶

This endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:	ingest_addm_reports_details (oci.opsi.models.IngestAddmReportsDetails) – (required) Collection of addm reports for a particular database. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestAddmReportsResponseDetails`
Return type:	`Response`
Example:

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

ingest_database_configuration(ingest_database_configuration_details, **kwargs)¶

This is a generic ingest endpoint for all database configuration metrics.

Parameters:	ingest_database_configuration_details (oci.opsi.models.IngestDatabaseConfigurationDetails) – (required) Payload for one or more database configuration metrics for a particular database. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestDatabaseConfigurationResponseDetails`
Return type:	`Response`
Example:

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

ingest_host_configuration(id, ingest_host_configuration_details, **kwargs)¶

This is a generic ingest endpoint for all the host configuration metrics

Parameters:	id (str) – (required) Required OCID of the host insight resource. ingest_host_configuration_details (oci.opsi.models.IngestHostConfigurationDetails) – (required) Payload for one or more host configuration metrics for a particular host. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestHostConfigurationResponseDetails`
Return type:	`Response`
Example:

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

ingest_host_metrics(id, ingest_host_metrics_details, **kwargs)¶

This is a generic ingest endpoint for all the host performance metrics

Parameters:	id (str) – (required) Required OCID of the host insight resource. ingest_host_metrics_details (oci.opsi.models.IngestHostMetricsDetails) – (required) Payload for one or more host performance metrics for a particular host. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestHostMetricsResponseDetails`
Return type:	`Response`
Example:

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

ingest_my_sql_sql_stats(ingest_my_sql_sql_stats_details, **kwargs)¶

The MySql SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:	ingest_my_sql_sql_stats_details (oci.opsi.models.IngestMySqlSqlStatsDetails) – (required) Collection of MySql SQL stats objects for a particular database. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestMySqlSqlStatsResponseDetails`
Return type:	`Response`
Example:

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

ingest_my_sql_sql_text(ingest_my_sql_sql_text_details, **kwargs)¶

The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified. Disclaimer: SQL text being uploaded explicitly via APIs is already masked. All sensitive literals contained in the sqlFullText column are masked prior to ingestion.

Parameters:	ingest_my_sql_sql_text_details (oci.opsi.models.IngestMySqlSqlTextDetails) – (required) Collection of SQL text objects for a particular database. compartment_id (str) – (optional) The OCID of the compartment. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestMySqlSqlTextResponseDetails`
Return type:	`Response`
Example:

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

ingest_sql_bucket(ingest_sql_bucket_details, **kwargs)¶

The sqlbucket endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:	ingest_sql_bucket_details (oci.opsi.models.IngestSqlBucketDetails) – (required) Collection of SQL bucket objects for a particular database. compartment_id (str) – (optional) The OCID of the compartment. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestSqlBucketResponseDetails`
Return type:	`Response`
Example:

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

ingest_sql_plan_lines(ingest_sql_plan_lines_details, **kwargs)¶

The SqlPlanLines endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:	ingest_sql_plan_lines_details (oci.opsi.models.IngestSqlPlanLinesDetails) – (required) Collection of SQL plan line objects for a particular database. compartment_id (str) – (optional) The OCID of the compartment. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestSqlPlanLinesResponseDetails`
Return type:	`Response`
Example:

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

ingest_sql_stats(ingest_sql_stats_details, **kwargs)¶

The SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified.

Parameters:	ingest_sql_stats_details (oci.opsi.models.IngestSqlStatsDetails) – (required) Collection of SQL stats objects for a particular database. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestSqlStatsResponseDetails`
Return type:	`Response`
Example:

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

ingest_sql_text(ingest_sql_text_details, **kwargs)¶

The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified. Disclaimer: SQL text being uploaded explicitly via APIs is not masked. Any sensitive literals contained in the sqlFullText column should be masked prior to ingestion.

Parameters:	ingest_sql_text_details (oci.opsi.models.IngestSqlTextDetails) – (required) Collection of SQL text objects for a particular database. compartment_id (str) – (optional) The OCID of the compartment. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `IngestSqlTextResponseDetails`
Return type:	`Response`
Example:

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

list_addm_db_finding_categories(compartment_id, **kwargs)¶

Gets list of ADDM finding categories.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the finding categories Allowed values are: “name” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbFindingCategoryCollection`
Return type:	`Response`
Example:

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

list_addm_db_findings_time_series(compartment_id, **kwargs)¶

Get the ADDM findings time series for the specified databases for a given time period.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. category_name (str) – (optional) Optional value filter to match the finding category exactly. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the ADDM finding time series summary data Allowed values are: “timestamp” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbFindingsTimeSeriesCollection`
Return type:	`Response`
Example:

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

list_addm_db_parameter_categories(compartment_id, **kwargs)¶

Gets list of ADDM database parameter categories for the specified databases.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the database parameter categories Allowed values are: “name” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbParameterCategoryCollection`
Return type:	`Response`
Example:

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

list_addm_db_recommendation_categories(compartment_id, **kwargs)¶

Gets list of ADDM recommendation categories for the specified databases.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the recommendation categories Allowed values are: “name” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbRecommendationCategoryCollection`
Return type:	`Response`
Example:

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

list_addm_db_recommendations_time_series(compartment_id, **kwargs)¶

Gets time series data for ADDM recommendations for the specified databases.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. category_name (str) – (optional) Optional value filter to match the finding category exactly. sql_identifier (str) – (optional) Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING. owner_or_name_contains (str) – (optional) Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT. name_contains (str) – (optional) Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION. name (str) – (optional) Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the ADDM recommendation time series summary data Allowed values are: “timestamp” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbRecommendationsTimeSeriesCollection`
Return type:	`Response`
Example:

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

list_addm_dbs(compartment_id, **kwargs)¶

Gets a list of ADDM database information

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting ADDM database data Allowed values are: “databaseName”, “numberOfFindings” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbCollection`
Return type:	`Response`
Example:

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

list_awr_database_snapshots(awr_hub_id, awr_source_database_identifier, **kwargs)¶

Lists AWR snapshots for the specified database in the AWR.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseSnapshotCollection`
Return type:	`Response`
Example:

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

list_awr_databases(awr_hub_id, **kwargs)¶

Gets the list of databases and their snapshot summary details available in the AWRHub.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier 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. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 sort_by (str) – (optional) The option to sort the AWR summary data. Allowed values are: “END_INTERVAL_TIME”, “NAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseCollection`
Return type:	`Response`
Example:

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

list_awr_hub_objects(awr_hub_source_id, **kwargs)¶

Gets a list of Awr Hub objects. Awr Hub id needs to specified.

Parameters:	awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier prefix (str) – (optional) The string to use for matching against the start of object names in a Awr Hub list objects query. start (str) – (optional) Object names returned by Awr Hub list objects query must be greater or equal to this parameter. end (str) – (optional) Object names returned by Awr Hub list objects query must be strictly less than this parameter. delimiter (str) – (optional) When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the Awr Hub list objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only ‘/’ is a supported delimiter character at this time. start_after (str) – (optional) Awr Hub Object name after which remaining objects are listed page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 fields (str) – (optional) By default all the fields are returned. Use this parameter to fetch specific fields ‘size’, ‘etag’, ‘md5’, ‘timeCreated’, ‘timeModified’, ‘storageTier’ and ‘archivalState’ fields. List the names of those fields in a comma-separated, case-insensitive list as the value of this parameter. For example: ‘name,etag,timeCreated,md5,timeModified,storageTier,archivalState’. Allowed values are: “name”, “size”, “etag”, “timeCreated”, “md5”, “archivalState”, “timeModified”, “storageTier” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ListObjects`
Return type:	`Response`
Example:

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

list_awr_hub_sources(awr_hub_id, **kwargs)¶

Gets a list of Awr Hub source objects.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier compartment_id (str) – (optional) The OCID of the compartment. awr_hub_source_id (str) – (optional) Awr Hub source identifier source_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW_S”, “ATP_S”, “ADW_D”, “ATP_D”, “EXTERNAL_PDB”, “EXTERNAL_NONCDB”, “COMANAGED_VM_CDB”, “COMANAGED_VM_PDB”, “COMANAGED_VM_NONCDB”, “COMANAGED_BM_CDB”, “COMANAGED_BM_PDB”, “COMANAGED_BM_NONCDB”, “COMANAGED_EXACS_CDB”, “COMANAGED_EXACS_PDB”, “COMANAGED_EXACS_NONCDB”, “UNDEFINED” name (str) – (optional) Awr Hub source database name status (list[str]) – (optional) Resource Status Allowed values are: “ACCEPTING”, “NOT_ACCEPTING”, “NOT_REGISTERED”, “TERMINATED” lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrHubSourceSummaryCollection`
Return type:	`Response`
Example:

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

list_awr_hubs(operations_insights_warehouse_id, **kwargs)¶

Gets a list of AWR hubs. Either compartmentId or id must be specified. All these resources are expected to be in root compartment.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Operations Insights Warehouse identifier compartment_id (str) – (optional) The OCID of the compartment. display_name (str) – (optional) A filter to return only resources that match the entire display name. id (str) – (optional) Unique Awr Hub identifier lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrHubSummaryCollection`
Return type:	`Response`
Example:

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

list_awr_snapshots(awr_hub_id, awr_source_database_identifier, **kwargs)¶

Lists AWR snapshots for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not exceed an elapsed range of 1 day. The timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are optional. If these params are not provided, by default last 1 day snapshots will be returned.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) AWR source database identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The option to sort the AWR snapshot summary data. Default sort is by timeBegin. Allowed values are: “timeBegin”, “snapshotId” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrSnapshotCollection`
Return type:	`Response`
Example:

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

list_database_configurations(**kwargs)¶

Gets a list of database insight configurations based on the query parameters specified. Either compartmentId or databaseInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insight configurations in that compartment and in all sub-compartments will be returned.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. enterprise_manager_bridge_id (str) – (optional) Unique Enterprise Manager bridge identifier id (list[str]) – (optional) Optional list of database insight resource OCIDs. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. cdb_name (list[str]) – (optional) Filter by one or more cdb name. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Database configuration list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. Allowed values are: “databaseName”, “databaseDisplayName”, “databaseType” host_name (list[str]) – (optional) Filter by one or more hostname. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseConfigurationCollection`
Return type:	`Response`
Example:

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

list_database_insights(**kwargs)¶

Gets a list of database insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insights in that compartment and in all sub-compartments will be returned.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. enterprise_manager_bridge_id (str) – (optional) Unique Enterprise Manager bridge identifier id (list[str]) – (optional) Optional list of database insight resource OCIDs. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION” database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. fields (list[str]) – (optional) Specifies the fields to return in a database summary response. By default all fields are returned if omitted. Allowed values are: “compartmentId”, “databaseName”, “databaseDisplayName”, “databaseType”, “databaseVersion”, “databaseHostNames”, “freeformTags”, “definedTags” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Database insight list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. Allowed values are: “databaseName”, “databaseDisplayName”, “databaseType” exadata_insight_id (str) – (optional) OCID of exadata insight resource. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opsi_private_endpoint_id (str) – (optional) Unique Operations Insights PrivateEndpoint identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseInsightsCollection`
Return type:	`Response`
Example:

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

list_enterprise_manager_bridges(**kwargs)¶

Gets a list of Ops Insights Enterprise Manager bridges. Either compartmentId or id must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of bridges in that compartment and in all sub-compartments will be returned.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. display_name (str) – (optional) A filter to return only resources that match the entire display name. id (str) – (optional) Unique Enterprise Manager bridge identifier lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EnterpriseManagerBridgeCollection`
Return type:	`Response`
Example:

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

list_exadata_configurations(**kwargs)¶

Gets a list of exadata insight configurations. Either compartmentId or exadataInsightsId query parameter must be specified.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Exadata configuration list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. Allowed values are: “exadataName”, “exadataDisplayName”, “exadataType” defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExadataConfigurationCollection`
Return type:	`Response`
Example:

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

list_exadata_insights(**kwargs)¶

Gets a list of Exadata insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of Exadata insights in that compartment and in all sub-compartments will be returned.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. enterprise_manager_bridge_id (str) – (optional) Unique Enterprise Manager bridge identifier id (list[str]) – (optional) Optional list of Exadata insight resource OCIDs. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION” exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Exadata insight list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. Default order for timeCreated is descending. Default order for exadataName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “exadataName” compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExadataInsightSummaryCollection`
Return type:	`Response`
Example:

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

list_host_configurations(**kwargs)¶

Gets a list of host insight configurations based on the query parameters specified. Either compartmentId or hostInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of host insight configurations in that compartment and in all sub-compartments will be returned.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. enterprise_manager_bridge_id (str) – (optional) Unique Enterprise Manager bridge identifier id (list[str]) – (optional) Optional list of host insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Host configuration list sort options. Allowed values are: “hostName”, “platformType” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `HostConfigurationCollection`
Return type:	`Response`
Example:

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

list_host_insights(**kwargs)¶

Gets a list of host insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of host insights in that compartment and in all sub-compartments will be returned.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. id (list[str]) – (optional) Optional list of host insight resource OCIDs. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION” host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Host insight list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. Allowed values are: “hostName”, “hostType” enterprise_manager_bridge_id (str) – (optional) Unique Enterprise Manager bridge identifier exadata_insight_id (str) – (optional) OCID of exadata insight resource. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `HostInsightSummaryCollection`
Return type:	`Response`
Example:

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

list_hosted_entities(compartment_id, id, **kwargs)¶

Get a list of hosted entities details.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” exadata_insight_id (str) – (optional) OCID of exadata insight resource. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Hosted entity list sort options. Allowed values are: “entityName”, “entityType” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `HostedEntityCollection`
Return type:	`Response`
Example:

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

list_importable_agent_entities(compartment_id, **kwargs)¶

Gets a list of agent entities available to add a new hostInsight. An agent entity is “available” and will be shown if all the following conditions are true:

The agent OCID is not already being used for an existing hostInsight.

The agent availabilityStatus = ‘ACTIVE’

The agent lifecycleState = ‘ACTIVE’

Parameters:	compartment_id (str) – (required) The OCID of the compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Hosted entity list sort options. Allowed values are: “entityName”, “entityType” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportableAgentEntitySummaryCollection`
Return type:	`Response`
Example:

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

list_importable_compute_entities(compartment_id, **kwargs)¶

Gets a list of available compute intances running cloud agent to add a new hostInsight. An Compute entity is “available” and will be shown if all the following conditions are true:

Compute is running OCA

OCI Management Agent is not enabled or If OCI Management Agent is enabled 2.1 The agent OCID is not already being used for an existing hostInsight. 2.2 The agent availabilityStatus = ‘ACTIVE’ 2.3 The agent lifecycleState = ‘ACTIVE’

Parameters:	compartment_id (str) – (required) The OCID of the compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Compute entity list sort options. Allowed values are: “computeId”, “computeDisplayName”, “platformType”, “hostName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportableComputeEntitySummaryCollection`
Return type:	`Response`
Example:

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

list_importable_enterprise_manager_entities(enterprise_manager_bridge_id, **kwargs)¶

Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before.

Parameters:	enterprise_manager_bridge_id (str) – (required) Unique Enterprise Manager bridge identifier limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. enterprise_manager_entity_type (list[str]) – (optional) Filter by one or more Enterprise Manager entity types. Currently, the supported types are “oracle_pdb”, “oracle_database”, “host”, “oracle_dbmachine”, “oracle_exa_cloud_service”, and “oracle_oci_exadata_cloud_service”. If this parameter is not specified, targets of all supported entity types are returned by default. enterprise_manager_identifier (str) – (optional) Used in combination with enterpriseManagerParentEntityIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity. enterprise_manager_parent_entity_identifier (str) – (optional) Used in combination with enterpriseManagerIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportableEnterpriseManagerEntityCollection`
Return type:	`Response`
Example:

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

list_news_reports(**kwargs)¶

Gets a list of news reports based on the query parameters specified. Either compartmentId or id query parameter must be specified.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. news_report_id (str) – (optional) Unique Ops Insights news report identifier status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) News report list sort options. If fields parameter is selected, the sortBy parameter must be one of the fields specified. Allowed values are: “name”, “newsFrequency” compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NewsReportCollection`
Return type:	`Response`
Example:

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

list_operations_insights_private_endpoints(**kwargs)¶

Gets a list of Operation Insights private endpoints.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. display_name (str) – (optional) A filter to return only resources that match the entire display name. opsi_private_endpoint_id (str) – (optional) Unique Operations Insights PrivateEndpoint identifier is_used_for_rac_dbs (bool) – (optional) The option to filter OPSI private endpoints that can used for RAC. Should be used along with vcnId query parameter. vcn_id (str) – (optional) The OCID of the VCN. lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort private endpoints. Allowed values are: “timeCreated”, “id”, “displayName” compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsPrivateEndpointCollection`
Return type:	`Response`
Example:

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

list_operations_insights_warehouse_users(operations_insights_warehouse_id, **kwargs)¶

Gets a list of Operations Insights Warehouse users. Either compartmentId or id must be specified. All these resources are expected to be in root compartment.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Operations Insights Warehouse identifier compartment_id (str) – (optional) The OCID of the compartment. display_name (str) – (optional) A filter to return only resources that match the entire display name. id (str) – (optional) Unique Operations Insights Warehouse User identifier lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsWarehouseUserSummaryCollection`
Return type:	`Response`
Example:

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

list_operations_insights_warehouses(**kwargs)¶

Gets a list of Ops Insights warehouses. Either compartmentId or id must be specified. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. display_name (str) – (optional) A filter to return only resources that match the entire display name. id (str) – (optional) Unique Ops Insights Warehouse identifier lifecycle_state (list[str]) – (optional) Lifecycle states Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OperationsInsightsWarehouseSummaryCollection`
Return type:	`Response`
Example:

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

list_opsi_configurations(compartment_id, **kwargs)¶

Gets a list of OPSI configuration resources based on the query parameters specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. display_name (str) – (optional) Filter to return based on resources that match the entire display name. lifecycle_state (list[str]) – (optional) Filter to return based on Lifecycle state of OPSI configuration. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” opsi_config_type (list[str]) – (optional) Filter to return based on configuration type of OPSI configuration. Allowed values are: “UX_CONFIGURATION” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) OPSI configurations list sort options. Allowed values are: “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OpsiConfigurationsCollection`
Return type:	`Response`
Example:

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

list_opsi_data_objects(compartment_id, **kwargs)¶

Gets a list of OPSI data objects based on the query parameters specified. CompartmentId id query parameter must be specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. data_object_type (list[str]) – (optional) OPSI data object types. Allowed values are: “DATABASE_INSIGHTS_DATA_OBJECT”, “HOST_INSIGHTS_DATA_OBJECT”, “EXADATA_INSIGHTS_DATA_OBJECT” display_name (str) – (optional) A filter to return only resources that match the entire display name. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) OPSI data object list sort options. Allowed values are: “displayName”, “dataObjectType”, “name” group_name (str) – (optional) A filter to return only data objects that belongs to the group of the given group name. By default, no filtering will be applied on group name. name (str) – (optional) A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OpsiDataObjectsCollection`
Return type:	`Response`
Example:

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

list_sql_plans(compartment_id, sql_identifier, plan_hash, **kwargs)¶

Query SQL Warehouse to list the plan xml for a given SQL execution plan. This returns a SqlPlanCollection object, but is currently limited to a single plan. Either databaseId or id must be specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (str) – (required) Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7 plan_hash (oci.opsi.models.list[int]) – (required) Unique plan hash for a SQL Plan of a particular SQL Statement. Example: 9820154385 database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanCollection`
Return type:	`Response`
Example:

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

list_sql_searches(compartment_id, sql_identifier, **kwargs)¶

Search SQL by SQL Identifier across databases in a compartment and in all sub-compartments if specified. And get the SQL Text and the details of the databases executing the SQL for a given time period.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (str) – (required) Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7 analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlSearchCollection`
Return type:	`Response`
Example:

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

list_sql_texts(compartment_id, sql_identifier, **kwargs)¶

Query SQL Warehouse to get the full SQL Text for a SQL in a compartment and in all sub-compartments if specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (oci.opsi.models.list[str]) – (required) One or more unique SQL_IDs for a SQL Statement. Example: 6rgjh9bjmy2s7 database_id (list[str]) – (optional) Optional list of database OCIDs of the assosicated DBaaS entity. id (list[str]) – (optional) Optional list of database OCIDs of the database insight resource. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlTextCollection`
Return type:	`Response`
Example:

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

list_warehouse_data_objects(warehouse_type, warehouse_id, **kwargs)¶

Gets a list of Warehouse data objects (e.g: views, tables), based on the query parameters specified.

Parameters:	warehouse_type (str) – (required) Type of the Warehouse. Allowed values are: “awrHubs” warehouse_id (str) – (required) The OCID of a Warehouse. data_object_type (list[str]) – (optional) A filter to return only data objects that match the data object type. By default, no filtering will be applied on data object type. Allowed values are: “VIEW”, “TABLE” name (str) – (optional) A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name. owner (str) – (optional) A filter to return only data objects that match the entire data object owner name. By default, no filtering will be applied on data object owner name. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Sort options for Warehouse data objects list. Allowed values are: “dataObjectType”, “name”, “owner” summary_field (list[str]) – (optional) Specifies the optional fields to return in a WarehouseDataObjectSummary. Unless requested, these fields are not returned by default. Allowed values are: “details” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WarehouseDataObjectCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Return a (paginated) list of errors for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `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)¶

Return a (paginated) list of logs for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

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

list_work_requests(**kwargs)¶

Lists the work requests in a compartment. Either compartmentId or id must be specified. Only one of id, resourceId or relatedResourceId can be specified optionally.

Parameters:	opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 compartment_id (str) – (optional) The OCID of the compartment. id (str) – (optional) The ID of the asynchronous work request. status (str) – (optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” resource_id (str) – (optional) The ID of the resource affected by the work request. related_resource_id (str) – (optional) The ID of the related resource for the resource affected by the work request, e.g. the related Exadata Insight OCID of the Database Insight work request sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: “timeAccepted” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestCollection`
Return type:	`Response`
Example:

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

put_awr_hub_object(put_awr_hub_object_body, awr_hub_source_id, object_name, **kwargs)¶

Creates a new object or overwrites an existing object with the same name to the Awr Hub.

Parameters:	put_awr_hub_object_body (stream) – (required) The object to be uploaded to the Awr Hub. awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier object_name (str) – (required) Unique Awr Hub Object identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings buffer_limit (int) – (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown. The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

query_opsi_data_object_data(compartment_id, query_opsi_data_object_data_details, **kwargs)¶

Queries an OPSI data object with the inputs provided and sends the result set back. Either analysisTimeInterval or timeIntervalStart and timeIntervalEnd parameters need to be passed as well.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. query_opsi_data_object_data_details (oci.opsi.models.QueryOpsiDataObjectDataDetails) – (required) The information to be used for querying an OPSI data object. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `QueryDataObjectResultSetRowsCollection`
Return type:	`Response`
Example:

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

query_warehouse_data_object_data(warehouse_type, warehouse_id, query_warehouse_data_object_data_details, **kwargs)¶

Queries Warehouse data objects (e.g: views, tables) with the inputs provided and sends the result set back. Any data to which an OperationsInsightsWarehouseUser with a permission to the corresponding Warehouse can be queried.

Parameters:	warehouse_type (str) – (required) Type of the Warehouse. Allowed values are: “awrHubs” warehouse_id (str) – (required) The OCID of a Warehouse. query_warehouse_data_object_data_details (oci.opsi.models.QueryWarehouseDataObjectDataDetails) – (required) The information to be used for querying a Warehouse. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `QueryDataObjectResultSetRowsCollection`
Return type:	`Response`
Example:

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

rotate_operations_insights_warehouse_wallet(operations_insights_warehouse_id, **kwargs)¶

Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Ops Insights Warehouse identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

summarize_addm_db_findings(compartment_id, **kwargs)¶

Summarizes ADDM findings for the specified databases.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. category_name (str) – (optional) Optional value filter to match the finding category exactly. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the ADDM finding summary data Allowed values are: “impactOverallPercent”, “impactMaxPercent”, “impactAvgActiveSessions”, “frequencyCount” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbFindingAggregationCollection`
Return type:	`Response`
Example:

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

summarize_addm_db_parameter_changes(compartment_id, name, **kwargs)¶

Summarizes the AWR database parameter change history for the specified parameter. There will be one element for each time that parameter changed during the specified time period. This API is limited to only one parameter per request.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. name (str) – (required) Required filter to return only changes for the specified parameter. The match is case sensitive. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. value_contains (str) – (optional) Optional filter to return only resources whose value contains the substring given. The match is not case sensitive. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the database parameter change data Allowed values are: “isChanged”, “beginSnapId” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbParameterChangeAggregationCollection`
Return type:	`Response`
Example:

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

summarize_addm_db_parameters(compartment_id, **kwargs)¶

Summarizes database parameter history information for the specified databases. Return a list of parameters with information on whether the parameter values were changed or not within the specified time period. The response does not include the individual parameter changes within the time period.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. category_name (str) – (optional) Optional value filter to match the parameter category exactly. Note the list of possible category names can be retrieved from the following endpoint: /databases/{databaseId}/addmDbParameterCategories. name_or_value_contains (str) – (optional) Optional filter to return only resources whose name or value contains the substring given. The match is not case sensitive. is_changed (str) – (optional) Optional filter to return only parameters whose value changed in the specified time period. Valid values include: TRUE, FALSE Allowed values are: “TRUE”, “FALSE” is_default (str) – (optional) Optional filter to return only parameters whose end value was set to the default value (TRUE) or was specified in the parameter file (FALSE). Valid values include: TRUE, FALSE Allowed values are: “TRUE”, “FALSE” has_recommendations (str) – (optional) Optional filter to return only parameters which have recommendations in the specified time period. Valid values include: TRUE, FALSE Allowed values are: “TRUE”, “FALSE” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the database parameter data Allowed values are: “isChanged”, “name” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbParameterAggregationCollection`
Return type:	`Response`
Example:

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

summarize_addm_db_recommendations(compartment_id, **kwargs)¶

Summarizes ADDM recommendations for the specified databases.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. category_name (str) – (optional) Optional value filter to match the finding category exactly. finding_identifier (str) – (optional) Unique finding ID sql_identifier (str) – (optional) Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING. owner_or_name_contains (str) – (optional) Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT. name_contains (str) – (optional) Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION. name (str) – (optional) Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Field name for sorting the recommendation data Allowed values are: “maxBenefitPercent”, “maxBenefitAvgActiveSessions”, “frequencyCount” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbRecommendationAggregationCollection`
Return type:	`Response`
Example:

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

summarize_addm_db_schema_objects(compartment_id, object_identifier, **kwargs)¶

Summarizes Schema objects for the specified databases for the specified objectIdentifiers

Parameters:	compartment_id (str) – (required) The OCID of the compartment. object_identifier (oci.opsi.models.list[int]) – (required) One or more unique Object id (from RDBMS) database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbSchemaObjectCollection`
Return type:	`Response`
Example:

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

summarize_addm_db_sql_statements(compartment_id, sql_identifier, **kwargs)¶

Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (oci.opsi.models.list[str]) – (required) One or more unique SQL_IDs for a SQL Statement. Example: 6rgjh9bjmy2s7 database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AddmDbSqlStatementCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_cpu_usages(awr_hub_id, awr_source_database_identifier, **kwargs)¶

Summarizes the AWR CPU resource limits and metrics for the specified database in AWR. Based on the time range provided as part of query param, the metrics points will be returned in the response as below. - if time range is <=7 days then the metrics points will be for every MINUTES - if time range is <=2 hours then the metrics points will be for every 10 SECONDS - if time range is >7 days then the metrics points will be for every HOUR.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z session_type (str) – (optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: “FOREGROUND”, “BACKGROUND”, “ALL” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseCpuUsageCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_metrics(awr_hub_id, awr_source_database_identifier, 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:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases name (oci.opsi.models.list[str]) – (required) The required multiple value query parameter to filter the entity name. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 sort_by (str) – (optional) The option to sort the AWR time series summary data. Allowed values are: “TIMESTAMP”, “NAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseMetricCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_parameter_changes(awr_hub_id, awr_source_database_identifier, 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: /awrHubs/{awrHubId}/awrDbParameters?awrSourceDatabaseIdentifier={awrSourceDbId}

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases name (str) – (required) The required single value query parameter to filter the entity name. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseParameterChangeCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_parameters(awr_hub_id, awr_source_database_identifier, **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:

Queryparam (valueChanged =”Y”) - Each parameter whose value was changed during the time range, “isChanged : true” in response for the DB params. Queryparam (valueChanged =”N”) - Each parameter whose value was unchanged during the time range, “isChanged : false” in response for the DB params. Queryparam (valueChanged =”Y” and valueModified = “SYSTEM_MOD”) - Each parameter whose value was changed at the system level during the time range, “isChanged : true” & “valueModified : SYSTEM_MOD” in response for the DB params. Queryparam (valueChanged =”N” and valueDefault = “FALSE”) - Each parameter whose value was unchanged during the time range, however, the value is not the default value, “isChanged : true” & “isDefault : false” in response for the DB params.

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: /awrHubs/{awrHubId}/awrDbParameterChanges?awrSourceDatabaseIdentifier={awrSourceDbId}

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z 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) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseParameterCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_snapshot_ranges(awr_hub_id, **kwargs)¶

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

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier 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. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 sort_by (str) – (optional) The option to sort the AWR summary data. Allowed values are: “END_INTERVAL_TIME”, “NAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseSnapshotRangeCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_sysstats(awr_hub_id, awr_source_database_identifier, 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:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases name (oci.opsi.models.list[str]) – (required) The required multiple value query parameter to filter the entity name. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseSysstatCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_top_wait_events(awr_hub_id, awr_source_database_identifier, **kwargs)¶

Summarizes the AWR top wait events.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z session_type (str) – (optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: “FOREGROUND”, “BACKGROUND”, “ALL” 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseTopWaitEventCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_wait_event_buckets(awr_hub_id, awr_source_database_identifier, name, **kwargs)¶

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

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases name (str) – (required) The required single value query parameter to filter the entity name. instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z 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. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 sort_by (str) – (optional) The option to sort distribution data. Allowed values are: “CATEGORY”, “PERCENTAGE” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseWaitEventBucketCollection`
Return type:	`Response`
Example:

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

summarize_awr_database_wait_events(awr_hub_id, awr_source_database_identifier, **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:	awr_hub_id (str) – (required) Unique Awr Hub identifier awr_source_database_identifier (str) – (required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases instance_number (str) – (optional) The optional single value query parameter to filter by database instance number. begin_snapshot_identifier_greater_than_or_equal_to (int) – (optional) The optional greater than or equal to filter on the snapshot ID. end_snapshot_identifier_less_than_or_equal_to (int) – (optional) The optional less than or equal to query parameter to filter the snapshot Identifier. time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z 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” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 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 sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AwrDatabaseWaitEventCollection`
Return type:	`Response`
Example:

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

summarize_awr_sources_summaries(awr_hub_id, **kwargs)¶

Gets a list of summary of AWR Sources.

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier compartment_id (str) – (optional) The OCID of the compartment. name (str) – (optional) Name for an Awr source database limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_by (str) – (optional) The order in which Awr sources summary records are listed Allowed values are: “snapshotsUploaded”, “name” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeAwrSourcesSummariesCollection`
Return type:	`Response`
Example:

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

summarize_configuration_items(**kwargs)¶

Gets the applicable configuration items based on the query parameters specified. Configuration items for an opsiConfigType with respect to a compartmentId can be fetched. Values specified in configItemField param will determine what fields for each configuration items have to be returned.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. opsi_config_type (str) – (optional) Filter to return configuration items based on configuration type of OPSI configuration. Allowed values are: “UX_CONFIGURATION” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. config_items_applicable_context (list[str]) – (optional) Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. config_item_field (list[str]) – (optional) Specifies the fields to return in a config item summary. Allowed values are: “name”, “value”, “defaultValue”, “valueSourceConfig”, “metadata”, “applicableContexts” name (str) – (optional) A filter to return only configuration items that match the entire name. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConfigurationItemsCollection`
Return type:	`Response`
Example:

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

summarize_database_insight_resource_capacity_trend(compartment_id, resource_metric, **kwargs)¶

Returns response with time series data (endTimestamp, capacity, baseCapacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. cdb_name (list[str]) – (optional) Filter by one or more cdb name. utilization_level (str) – (optional) Filter by utilization level by the following buckets: HIGH_UTILIZATION: DBs with utilization greater or equal than 75. LOW_UTILIZATION: DBs with utilization lower than 25. MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50. Allowed values are: “HIGH_UTILIZATION”, “LOW_UTILIZATION”, “MEDIUM_HIGH_UTILIZATION”, “MEDIUM_LOW_UTILIZATION” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Sorts using end timestamp , capacity or baseCapacity Allowed values are: “endTimestamp”, “capacity”, “baseCapacity” tablespace_name (str) – (optional) Tablespace name for a database host_name (list[str]) – (optional) Filter by one or more hostname. is_database_instance_level_metrics (bool) – (optional) Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeDatabaseInsightResourceCapacityTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_database_insight_resource_forecast_trend(compartment_id, resource_metric, **kwargs)¶

Get Forecast predictions for CPU and Storage resources since a time in the past. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. cdb_name (list[str]) – (optional) Filter by one or more cdb name. statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” forecast_days (int) – (optional) Number of days used for utilization forecast analysis. forecast_model (str) – (optional) Choose algorithm model for the forecasting. Possible values: LINEAR: Uses linear regression algorithm for forecasting. ML_AUTO: Automatically detects best algorithm to use for forecasting. ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. Allowed values are: “LINEAR”, “ML_AUTO”, “ML_NO_AUTO” utilization_level (str) – (optional) Filter by utilization level by the following buckets: HIGH_UTILIZATION: DBs with utilization greater or equal than 75. LOW_UTILIZATION: DBs with utilization lower than 25. MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50. Allowed values are: “HIGH_UTILIZATION”, “LOW_UTILIZATION”, “MEDIUM_HIGH_UTILIZATION”, “MEDIUM_LOW_UTILIZATION” confidence (int) – (optional) This parameter is used to change data’s confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. host_name (list[str]) – (optional) Filter by one or more hostname. tablespace_name (str) – (optional) Tablespace name for a database is_database_instance_level_metrics (bool) – (optional) Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeDatabaseInsightResourceForecastTrendAggregation`
Return type:	`Response`
Example:

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

summarize_database_insight_resource_statistics(compartment_id, resource_metric, **kwargs)¶

Lists the Resource statistics (usage,capacity, usage change percent, utilization percent, base capacity, isAutoScalingEnabled) for each database filtered by utilization level in a compartment and in all sub-compartments if specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. cdb_name (list[str]) – (optional) Filter by one or more cdb name. percentile (int) – (optional) Percentile values of daily usage to be used for computing the aggregate resource usage. insight_by (str) – (optional) Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast forecast_days (int) – (optional) Number of days used for utilization forecast analysis. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The order in which resource statistics records are listed Allowed values are: “utilizationPercent”, “usage”, “usageChangePercent”, “databaseName”, “databaseType” host_name (list[str]) – (optional) Filter by one or more hostname. is_database_instance_level_metrics (bool) – (optional) Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeDatabaseInsightResourceStatisticsAggregationCollection`
Return type:	`Response`
Example:

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

summarize_database_insight_resource_usage(compartment_id, resource_metric, **kwargs)¶

A cumulative distribution function is used to rank the usage data points per database within the specified time period. For each database, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. host_name (list[str]) – (optional) Filter by one or more hostname. is_database_instance_level_metrics (bool) – (optional) Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. percentile (int) – (optional) Percentile values of daily usage to be used for computing the aggregate resource usage. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. cdb_name (list[str]) – (optional) Filter by one or more cdb name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeDatabaseInsightResourceUsageAggregation`
Return type:	`Response`
Example:

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

summarize_database_insight_resource_usage_trend(compartment_id, resource_metric, **kwargs)¶

Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Sorts using end timestamp, usage or capacity Allowed values are: “endTimestamp”, “usage”, “capacity” host_name (list[str]) – (optional) Filter by one or more hostname. is_database_instance_level_metrics (bool) – (optional) Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. cdb_name (list[str]) – (optional) Filter by one or more cdb name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeDatabaseInsightResourceUsageTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_database_insight_resource_utilization_insight(compartment_id, resource_metric, **kwargs)¶

Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. forecast_days (int) – (optional) Number of days used for utilization forecast analysis. host_name (list[str]) – (optional) Filter by one or more hostname. is_database_instance_level_metrics (bool) – (optional) Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. cdb_name (list[str]) – (optional) Filter by one or more cdb name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeDatabaseInsightResourceUtilizationInsightAggregation`
Return type:	`Response`
Example:

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

summarize_database_insight_tablespace_usage_trend(compartment_id, **kwargs)¶

Returns response with usage time series data (endTimestamp, usage, capacity) with breakdown by tablespaceName for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. Either databaseId or id must be specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeDatabaseInsightTablespaceUsageTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_capacity_trend(resource_type, resource_metric, exadata_insight_id, **kwargs)¶

Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system for a resource metric. Additionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters. Top five resources are returned if total exceeds the limit specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId, cdbName and hostName query parameter applies to ResourceType DATABASE. Valid values for ResourceType HOST are CPU and MEMORY. HostName is returned in name field. HostInsightId and hostName query parameter applies to ResourceType HOST. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. Storage server name is returned in name field for resourceMetric IOPS and THROUGHPUT and asmName is returned in name field for resourceMetric STORAGE. StorageServerName query parameter applies to ResourceType STORAGE_SERVER. Valid values for ResourceType DISKGROUP is STORAGE. Comma delimited (asmName,diskgroupName) is returned in name field.

Parameters:	resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT exadata_insight_id (str) – (required) OCID of exadata insight resource. compartment_id (str) – (optional) The OCID of the compartment. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_insight_id (list[str]) – (optional) Optional list of database insight resource OCIDs. host_insight_id (list[str]) – (optional) Optional list of host insight resource OCIDs. storage_server_name (list[str]) – (optional) Optional storage server name on an exadata system. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The order in which resource capacity trend records are listed Allowed values are: “id”, “name” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceCapacityTrendCollection`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_capacity_trend_aggregated(resource_type, resource_metric, **kwargs)¶

Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system or fleet aggregation for a resource metric. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:	resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT compartment_id (str) – (optional) The OCID of the compartment. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Sorts using end timestamp or capacity. Allowed values are: “endTimestamp”, “capacity” defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceCapacityTrendAggregation`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_forecast_trend(resource_type, resource_metric, exadata_insight_id, **kwargs)¶

Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts or storage servers. Additionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters. Top five resources are returned if total exceeds the limit specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId , cdbName and hostName query parameter applies to ResourceType DATABASE. Valid values for ResourceType HOST are CPU and MEMORY. HostName s returned in name field. HostInsightId and hostName query parameter applies to ResourceType HOST. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. Storage server name is returned in name field for resourceMetric IOPS and THROUGHPUT and asmName is returned in name field for resourceMetric STORAGE. StorageServerName query parameter applies to ResourceType STORAGE_SERVER. Valid value for ResourceType DISKGROUP is STORAGE. Comma delimited (asmName,diskgroupName) is returned in name field.

Parameters:	resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT exadata_insight_id (str) – (required) OCID of exadata insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. database_insight_id (list[str]) – (optional) Optional list of database insight resource OCIDs. host_insight_id (list[str]) – (optional) Optional list of host insight resource OCIDs. storage_server_name (list[str]) – (optional) Optional storage server name on an exadata system. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” forecast_start_day (int) – (optional) Number of days used for utilization forecast analysis. forecast_days (int) – (optional) Number of days used for utilization forecast analysis. forecast_model (str) – (optional) Choose algorithm model for the forecasting. Possible values: LINEAR: Uses linear regression algorithm for forecasting. ML_AUTO: Automatically detects best algorithm to use for forecasting. ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. Allowed values are: “LINEAR”, “ML_AUTO”, “ML_NO_AUTO” cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 confidence (int) – (optional) This parameter is used to change data’s confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The order in which resource Forecast trend records are listed Allowed values are: “id”, “name”, “daysToReachCapacity” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceForecastTrendCollection`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_forecast_trend_aggregated(resource_type, resource_metric, **kwargs)¶

Get aggregated historical usage and forecast predictions for resources. Either compartmentId or exadataInsightsId query parameter must be specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:	resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT compartment_id (str) – (optional) The OCID of the compartment. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” forecast_start_day (int) – (optional) Number of days used for utilization forecast analysis. forecast_days (int) – (optional) Number of days used for utilization forecast analysis. forecast_model (str) – (optional) Choose algorithm model for the forecasting. Possible values: LINEAR: Uses linear regression algorithm for forecasting. ML_AUTO: Automatically detects best algorithm to use for forecasting. ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. Allowed values are: “LINEAR”, “ML_AUTO”, “ML_NO_AUTO” cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. confidence (int) – (optional) This parameter is used to change data’s confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceForecastTrendAggregation`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_statistics(exadata_insight_id, resource_type, resource_metric, **kwargs)¶

Lists the Resource statistics (usage, capacity, usage change percent, utilization percent) for each resource based on resourceMetric filtered by utilization level. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS, THROUGHPUT. Valid value for ResourceType DISKGROUP is STORAGE.

Parameters:	exadata_insight_id (str) – (required) OCID of exadata insight resource. resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. percentile (int) – (optional) Percentile values of daily usage to be used for computing the aggregate resource usage. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The order in which resource statistics records are listed Allowed values are: “utilizationPercent”, “usage”, “usageChangePercent” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceStatisticsAggregationCollection`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_usage(compartment_id, resource_type, resource_metric, **kwargs)¶

A cumulative distribution function is used to rank the usage data points per resource within the specified time period. For each resource, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The order in which resource usage summary records are listed Allowed values are: “utilizationPercent”, “usage”, “capacity”, “usageChangePercent” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 percentile (int) – (optional) Percentile values of daily usage to be used for computing the aggregate resource usage. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceUsageCollection`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_usage_aggregated(compartment_id, resource_type, resource_metric, **kwargs)¶

A cumulative distribution function is used to rank the usage data points per database within the specified time period. For each database, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. percentile (int) – (optional) Percentile values of daily usage to be used for computing the aggregate resource usage. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceUsageAggregation`
Return type:	`Response`
Example:

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

summarize_exadata_insight_resource_utilization_insight(compartment_id, resource_type, resource_metric, **kwargs)¶

Gets current utilization, projected utilization and days to reach projectedUtilization for an exadata system over specified time period. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_type (str) – (required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE resource_metric (str) – (required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. forecast_start_day (int) – (optional) Number of days used for utilization forecast analysis. forecast_days (int) – (optional) Number of days used for utilization forecast analysis. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by hostname. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeExadataInsightResourceUtilizationInsightAggregation`
Return type:	`Response`
Example:

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

summarize_exadata_members(exadata_insight_id, **kwargs)¶

Lists the software and hardware inventory of the Exadata System.

Parameters:	exadata_insight_id (str) – (required) OCID of exadata insight resource. exadata_type (list[str]) – (optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The order in which exadata member records are listed Allowed values are: “name”, “displayName”, “entityType” limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExadataMemberCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_disk_statistics(compartment_id, id, **kwargs)¶

Returns response with disk(s) statistics for a host.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. host_id (str) – (optional) Optional OCID of the host (Compute Id) statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightsDiskStatisticsCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_host_recommendation(compartment_id, id, resource_metric, **kwargs)¶

Returns response with some recommendations if apply for a host.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. resource_metric (str) – (required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. host_id (str) – (optional) Optional OCID of the host (Compute Id) limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightHostRecommendationAggregation`
Return type:	`Response`
Example:

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

summarize_host_insight_io_usage_trend(compartment_id, id, **kwargs)¶

Returns response with usage time series data with breakdown by IO interface for the time period specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. host_id (str) – (optional) Optional OCID of the host (Compute Id) page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightIoUsageTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_network_usage_trend(compartment_id, id, **kwargs)¶

Returns response with usage time series data with breakdown by network interface for the time period specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. host_id (str) – (optional) Optional OCID of the host (Compute Id) page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightNetworkUsageTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_resource_capacity_trend(compartment_id, resource_metric, **kwargs)¶

Returns response with time series data (endTimestamp, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” id (list[str]) – (optional) Optional list of host insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. utilization_level (str) – (optional) Filter by utilization level by the following buckets: HIGH_UTILIZATION: DBs with utilization greater or equal than 75. LOW_UTILIZATION: DBs with utilization lower than 25. MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50. Allowed values are: “HIGH_UTILIZATION”, “LOW_UTILIZATION”, “MEDIUM_HIGH_UTILIZATION”, “MEDIUM_LOW_UTILIZATION” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Sorts using end timestamp or capacity Allowed values are: “endTimestamp”, “capacity” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightResourceCapacityTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_resource_forecast_trend(compartment_id, resource_metric, **kwargs)¶

Get Forecast predictions for CPU or memory resources since a time in the past. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” id (list[str]) – (optional) Optional list of host insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” forecast_days (int) – (optional) Number of days used for utilization forecast analysis. forecast_model (str) – (optional) Choose algorithm model for the forecasting. Possible values: LINEAR: Uses linear regression algorithm for forecasting. ML_AUTO: Automatically detects best algorithm to use for forecasting. ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm. Allowed values are: “LINEAR”, “ML_AUTO”, “ML_NO_AUTO” utilization_level (str) – (optional) Filter by utilization level by the following buckets: HIGH_UTILIZATION: DBs with utilization greater or equal than 75. LOW_UTILIZATION: DBs with utilization lower than 25. MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50. Allowed values are: “HIGH_UTILIZATION”, “LOW_UTILIZATION”, “MEDIUM_HIGH_UTILIZATION”, “MEDIUM_LOW_UTILIZATION” confidence (int) – (optional) This parameter is used to change data’s confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. mount_point (str) – (optional) Mount points are specialized NTFS filesystem objects. interface_name (str) – (optional) Name of the network interface. gpu_id (int) – (optional) GPU identifier. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightResourceForecastTrendAggregation`
Return type:	`Response`
Example:

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

summarize_host_insight_resource_statistics(compartment_id, resource_metric, **kwargs)¶

Lists the resource statistics (usage, capacity, usage change percent, utilization percent, load) for each host filtered by utilization level in a compartment and in all sub-compartments if specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” id (list[str]) – (optional) Optional list of host insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. percentile (int) – (optional) Percentile values of daily usage to be used for computing the aggregate resource usage. insight_by (str) – (optional) Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast forecast_days (int) – (optional) Number of days used for utilization forecast analysis. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The order in which resource statistics records are listed. Allowed values are: “utilizationPercent”, “usage”, “usageChangePercent”, “hostName”, “platformType” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightResourceStatisticsAggregationCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_resource_usage(compartment_id, resource_metric, **kwargs)¶

A cumulative distribution function is used to rank the usage data points per host within the specified time period. For each host, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” id (list[str]) – (optional) Optional list of host insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. percentile (int) – (optional) Percentile values of daily usage to be used for computing the aggregate resource usage. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightResourceUsageAggregation`
Return type:	`Response`
Example:

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

summarize_host_insight_resource_usage_trend(compartment_id, resource_metric, **kwargs)¶

Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” id (list[str]) – (optional) Optional list of host insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Sorts using end timestamp, usage or capacity Allowed values are: “endTimestamp”, “usage”, “capacity” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightResourceUsageTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_resource_utilization_insight(compartment_id, resource_metric, **kwargs)¶

Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. resource_metric (str) – (required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. platform_type (list[str]) – (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”, “ZLINUX”, “WINDOWS”, “AIX”, “HP_UX” id (list[str]) – (optional) Optional list of host insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. forecast_days (int) – (optional) Number of days used for utilization forecast analysis. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. high_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered highly utilized. low_utilization_threshold (int) – (optional) Percent value in which a resource metric is considered low utilized. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightResourceUtilizationInsightAggregation`
Return type:	`Response`
Example:

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

summarize_host_insight_storage_usage_trend(compartment_id, id, **kwargs)¶

Returns response with usage time series data with breakdown by filesystem for the time period specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. host_id (str) – (optional) Optional OCID of the host (Compute Id) page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightStorageUsageTrendAggregationCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_top_processes_usage(compartment_id, id, resource_metric, timestamp, **kwargs)¶

Returns response with aggregated data (timestamp, usageData) for top processes on a specific date. Data is aggregated for the time specified and processes are sorted descendent by the process metric specified (CPU, MEMORY, VIRTUAL_MEMORY). hostInsightId, processMetric must be specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. resource_metric (str) – (required) Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY. timestamp (datetime) – (required) Timestamp at which to gather the top processes. This will be top processes over the hour or over the day pending the time range passed into the query. time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightsTopProcessesUsageCollection`
Return type:	`Response`
Example:

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

summarize_host_insight_top_processes_usage_trend(compartment_id, id, resource_metric, **kwargs)¶

Returns response with aggregated time series data (timeIntervalstart, timeIntervalEnd, commandArgs, usageData) for top processes. Data is aggregated for the time period specified and proceses are sorted descendent by the proces metric specified (CPU, MEMORY, VIRTUAL_MEMORY). HostInsight Id and Process metric must be specified

Parameters:	compartment_id (str) – (required) The OCID of the compartment. id (str) – (required) Required OCID of the host insight resource. resource_metric (str) – (required) Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. host_type (list[str]) – (optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST host_id (str) – (optional) Optional OCID of the host (Compute Id) process_hash (str) – (optional) Unique identifier for a process. statistic (str) – (optional) Choose the type of statistic metric data to be used for forecasting. Allowed values are: “AVG”, “MAX” status (list[str]) – (optional) Resource Status Allowed values are: “DISABLED”, “ENABLED”, “TERMINATED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeHostInsightsTopProcessesUsageTrendCollection`
Return type:	`Response`
Example:

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

summarize_operations_insights_warehouse_resource_usage(operations_insights_warehouse_id, **kwargs)¶

Gets the details of resources used by an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Ops Insights Warehouse identifier opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SummarizeOperationsInsightsWarehouseResourceUsageAggregation`
Return type:	`Response`
Example:

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

summarize_sql_insights(compartment_id, **kwargs)¶

Query SQL Warehouse to get the performance insights for SQLs taking greater than X% database time for a given time period across the given databases or database types in a compartment and in all sub-compartments if specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by one or more hostname. database_time_pct_greater_than (float) – (optional) Filter sqls by percentage of db time. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlInsightAggregationCollection`
Return type:	`Response`
Example:

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

summarize_sql_plan_insights(compartment_id, sql_identifier, **kwargs)¶

Query SQL Warehouse to get the performance insights on the execution plans for a given SQL for a given time period. Either databaseId or id must be specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (str) – (required) Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7 database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlPlanInsightAggregationCollection`
Return type:	`Response`
Example:

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

summarize_sql_response_time_distributions(compartment_id, sql_identifier, **kwargs)¶

Query SQL Warehouse to summarize the response time distribution of query executions for a given SQL for a given time period. Either databaseId or id must be specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (str) – (required) Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7 database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlResponseTimeDistributionAggregationCollection`
Return type:	`Response`
Example:

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

summarize_sql_statistics(compartment_id, **kwargs)¶

Query SQL Warehouse to get the performance statistics for SQLs taking greater than X% database time for a given time period across the given databases or database types in a compartment and in all sub-compartments if specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. database_type (list[str]) – (optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. Allowed values are: “ADW-S”, “ATP-S”, “ADW-D”, “ATP-D”, “EXTERNAL-PDB”, “EXTERNAL-NONCDB”, “COMANAGED-VM-CDB”, “COMANAGED-VM-PDB”, “COMANAGED-VM-NONCDB”, “COMANAGED-BM-CDB”, “COMANAGED-BM-PDB”, “COMANAGED-BM-NONCDB”, “COMANAGED-EXACS-CDB”, “COMANAGED-EXACS-PDB”, “COMANAGED-EXACS-NONCDB”, “COMANAGED-EXACC-CDB”, “COMANAGED-EXACC-PDB”, “COMANAGED-EXACC-NONCDB”, “MDS-MYSQL” database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database insight resource OCIDs. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by one or more hostname. database_time_pct_greater_than (float) – (optional) Filter sqls by percentage of db time. sql_identifier (list[str]) – (optional) One or more unique SQL_IDs for a SQL Statement. Example: 6rgjh9bjmy2s7 analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to use when sorting SQL statistics. Example: databaseTimeInSec Allowed values are: “databaseTimeInSec”, “executionsPerHour”, “executionsCount”, “cpuTimeInSec”, “ioTimeInSec”, “inefficientWaitTimeInSec”, “responseTimeInSec”, “planCount”, “variability”, “averageActiveSessions”, “databaseTimePct”, “inefficiencyInPct”, “changeInCpuTimeInPct”, “changeInIoTimeInPct”, “changeInInefficientWaitTimeInPct”, “changeInResponseTimeInPct”, “changeInAverageActiveSessionsInPct”, “changeInExecutionsPerHourInPct”, “changeInInefficiencyInPct” category (list[str]) – (optional) Filter sqls by one or more performance categories. Allowed values are: “DEGRADING”, “VARIANT”, “INEFFICIENT”, “CHANGING_PLANS”, “IMPROVING”, “DEGRADING_VARIANT”, “DEGRADING_INEFFICIENT”, “DEGRADING_CHANGING_PLANS”, “DEGRADING_INCREASING_IO”, “DEGRADING_INCREASING_CPU”, “DEGRADING_INCREASING_INEFFICIENT_WAIT”, “DEGRADING_CHANGING_PLANS_AND_INCREASING_IO”, “DEGRADING_CHANGING_PLANS_AND_INCREASING_CPU”, “DEGRADING_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT”, “VARIANT_INEFFICIENT”, “VARIANT_CHANGING_PLANS”, “VARIANT_INCREASING_IO”, “VARIANT_INCREASING_CPU”, “VARIANT_INCREASING_INEFFICIENT_WAIT”, “VARIANT_CHANGING_PLANS_AND_INCREASING_IO”, “VARIANT_CHANGING_PLANS_AND_INCREASING_CPU”, “VARIANT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT”, “INEFFICIENT_CHANGING_PLANS”, “INEFFICIENT_INCREASING_INEFFICIENT_WAIT”, “INEFFICIENT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT” defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlStatisticAggregationCollection`
Return type:	`Response`
Example:

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

summarize_sql_statistics_time_series(compartment_id, sql_identifier, **kwargs)¶

Query SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a given time period in a compartment and in all sub-compartments if specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (str) – (required) Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7 database_id (list[str]) – (optional) Optional list of database OCIDs of the associated DBaaS entity. id (list[str]) – (optional) Optional list of database OCIDs of the database insight resource. exadata_insight_id (list[str]) – (optional) Optional list of exadata insight resource OCIDs. cdb_name (list[str]) – (optional) Filter by one or more cdb name. host_name (list[str]) – (optional) Filter by one or more hostname. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”. defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”. compartment_id_in_subtree (bool) – (optional) A flag to search all resources within a given compartment and all sub-compartments. vmcluster_name (list[str]) – (optional) Optional list of Exadata Insight VM cluster name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlStatisticsTimeSeriesAggregationCollection`
Return type:	`Response`
Example:

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

summarize_sql_statistics_time_series_by_plan(compartment_id, sql_identifier, **kwargs)¶

Query SQL Warehouse to get the performance statistics time series for a given SQL by execution plans for a given time period. Either databaseId or id must be specified.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. sql_identifier (str) – (required) Unique SQL_ID for a SQL Statement. Example: 6rgjh9bjmy2s7 database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. analysis_time_interval (str) – (optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). time_interval_start (datetime) – (optional) Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. time_interval_end (datetime) – (optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SqlStatisticsTimeSeriesByPlanAggregationCollection`
Return type:	`Response`
Example:

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

test_macs_managed_cloud_database_insight_connection(test_macs_managed_cloud_database_insight_connection_details, **kwargs)¶

Test the connection details of a Cloud MACS-managed database.

Parameters:	test_macs_managed_cloud_database_insight_connection_details (oci.opsi.models.TestMacsManagedCloudDatabaseInsightConnectionDetails) – (required) The database connection information for the Cloud MACS-managed database. database_id (str) – (optional) Optional OCID of the associated DBaaS entity. id (str) – (optional) OCID of the database insight resource. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_awr_hub(awr_hub_id, update_awr_hub_details, **kwargs)¶

Updates the configuration of a hub .

Parameters:	awr_hub_id (str) – (required) Unique Awr Hub identifier update_awr_hub_details (oci.opsi.models.UpdateAwrHubDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_awr_hub_source(update_awr_hub_source_details, awr_hub_source_id, **kwargs)¶

Update Awr Hub Source object.

Parameters:	update_awr_hub_source_details (oci.opsi.models.UpdateAwrHubSourceDetails) – (required) The configuration to be updated. awr_hub_source_id (str) – (required) Unique Awr Hub Source identifier if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_database_insight(database_insight_id, update_database_insight_details, **kwargs)¶

Updates configuration of a database insight.

Parameters:	database_insight_id (str) – (required) Unique database insight identifier update_database_insight_details (oci.opsi.models.UpdateDatabaseInsightDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_enterprise_manager_bridge(enterprise_manager_bridge_id, update_enterprise_manager_bridge_details, **kwargs)¶

Updates configuration of an Operations Insights Enterprise Manager bridge.

Parameters:	enterprise_manager_bridge_id (str) – (required) Unique Enterprise Manager bridge identifier update_enterprise_manager_bridge_details (oci.opsi.models.UpdateEnterpriseManagerBridgeDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_exadata_insight(exadata_insight_id, update_exadata_insight_details, **kwargs)¶

Updates configuration of an Exadata insight.

Parameters:	exadata_insight_id (str) – (required) Unique Exadata insight identifier update_exadata_insight_details (oci.opsi.models.UpdateExadataInsightDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_host_insight(host_insight_id, update_host_insight_details, **kwargs)¶

Updates configuration of a host insight.

Parameters:	host_insight_id (str) – (required) Unique host insight identifier update_host_insight_details (oci.opsi.models.UpdateHostInsightDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_news_report(news_report_id, update_news_report_details, **kwargs)¶

Updates the configuration of a news report.

Parameters:	news_report_id (str) – (required) Unique news report identifier. update_news_report_details (oci.opsi.models.UpdateNewsReportDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_operations_insights_private_endpoint(operations_insights_private_endpoint_id, update_operations_insights_private_endpoint_details, **kwargs)¶

Updates one or more attributes of the specified private endpoint.

Parameters:	operations_insights_private_endpoint_id (str) – (required) The OCID of the Operation Insights private endpoint. update_operations_insights_private_endpoint_details (oci.opsi.models.UpdateOperationsInsightsPrivateEndpointDetails) – (required) The details used to update a private endpoint. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_operations_insights_warehouse(operations_insights_warehouse_id, update_operations_insights_warehouse_details, **kwargs)¶

Updates the configuration of an Ops Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment.

Parameters:	operations_insights_warehouse_id (str) – (required) Unique Ops Insights Warehouse identifier update_operations_insights_warehouse_details (oci.opsi.models.UpdateOperationsInsightsWarehouseDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_operations_insights_warehouse_user(operations_insights_warehouse_user_id, update_operations_insights_warehouse_user_details, **kwargs)¶

Updates the configuration of an Operations Insights Warehouse User.

Parameters:	operations_insights_warehouse_user_id (str) – (required) Unique Operations Insights Warehouse User identifier update_operations_insights_warehouse_user_details (oci.opsi.models.UpdateOperationsInsightsWarehouseUserDetails) – (required) The configuration to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_opsi_configuration(opsi_configuration_id, update_opsi_configuration_details, **kwargs)¶

Updates an OPSI configuration resource with the given ID.

Parameters:	opsi_configuration_id (str) – (required) OCID of OPSI configuration resource. update_opsi_configuration_details (oci.opsi.models.UpdateOpsiConfigurationDetails) – (required) The OPSI configuration resource details to be updated. if_match (str) – (optional) Used for optimistic concurrency control. In the update or delete call for a resource, set the if-match parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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