OperationsInsightsClient

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

Use the Operations 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 Operations 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_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.
create_awr_hub(create_awr_hub_details, **kwargs) Create a AWR hub resource for the tenant in Operations Insights.
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 Operations Insights.
create_operations_insights_warehouse(…) Create a Operations Insights Warehouse resource for the tenant in Operations Insights.
create_operations_insights_warehouse_user(…) Create a Operations Insights Warehouse user resource for the tenant in Operations Insights.
delete_awr_hub(awr_hub_id, **kwargs) Deletes an AWR hub.
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_operations_insights_warehouse(…) Deletes an Operations Insights Warehouse.
delete_operations_insights_warehouse_user(…) Deletes an Operations Insights Warehouse User.
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 Operations Insights.
download_operations_insights_warehouse_wallet(…) Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.
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 Operations Insights.
get_awr_hub(awr_hub_id, **kwargs) Gets details of an AWR hub.
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_operations_insights_warehouse(…) Gets details of an Operations Insights Warehouse.
get_operations_insights_warehouse_user(…) Gets details of an Operations Insights Warehouse User.
get_work_request(work_request_id, **kwargs) Gets the status of the work request with the given ID.
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_sql_bucket(ingest_sql_bucket_details, …) The sqlbucket endpoint takes in a JSON payload, persists it in Operations 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 Operations 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_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 Operations 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_enterprise_manager_entities(…) Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before.
list_operations_insights_warehouse_users(…) Gets a list of Operations Insights Warehouse users.
list_operations_insights_warehouses(**kwargs) Gets a list of Operations Insights warehouses.
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_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.
rotate_operations_insights_warehouse_wallet(…) Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.
summarize_awr_sources_summaries(awr_hub_id, …) Gets a list of summary of AWR Sources.
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_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_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.
update_awr_hub(awr_hub_id, …) Updates the configuration of a hub .
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_operations_insights_warehouse(…) Updates the configuration of an Operations Insights Warehouse.
update_operations_insights_warehouse_user(…) Updates the configuration of an Operations Insights Warehouse User.
__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.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_exadata_insight_members 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_host_insight_compartment 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AwrHub

Return type:

Response

Example:

Click here to see an example of how to use create_awr_hub 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 Operations Insights. The host will be enabled in Operations 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 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type HostInsight

Return type:

Response

Example:

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

create_operations_insights_warehouse(create_operations_insights_warehouse_details, **kwargs)

Create a Operations Insights Warehouse resource for the tenant in Operations 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.

Parameters:
  • create_operations_insights_warehouse_details (oci.opsi.models.CreateOperationsInsightsWarehouseDetails) – (required) Details using which an Operations Insights Warehouse 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type OperationsInsightsWarehouseUser

Return type:

Response

Example:

Click here to see an example of how to use create_operations_insights_warehouse_user 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_awr_hub 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_host_insight 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_operations_insights_warehouse_user 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

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

disable_host_insight(host_insight_id, **kwargs)

Disables a host in Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use disable_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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use download_operations_insights_warehouse_wallet 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

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

enable_host_insight(enable_host_insight_details, host_insight_id, **kwargs)

Enables a host in Operations 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use enable_host_insight 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AwrHub

Return type:

Response

Example:

Click here to see an example of how to use get_awr_hub 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type HostInsight

Return type:

Response

Example:

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

get_operations_insights_warehouse(operations_insights_warehouse_id, **kwargs)

Gets details of 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type OperationsInsightsWarehouseUser

Return type:

Response

Example:

Click here to see an example of how to use get_operations_insights_warehouse_user 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

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

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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type IngestHostMetricsResponseDetails

Return type:

Response

Example:

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

ingest_sql_bucket(ingest_sql_bucket_details, **kwargs)

The sqlbucket endpoint takes in a JSON payload, persists it in Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type IngestSqlTextResponseDetails

Return type:

Response

Example:

Click here to see an example of how to use ingest_sql_text 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

  • 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.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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”.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 value is EXTERNAL-HOST.
  • platform_type (list[str]) –

    (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

  1. The agent OCID is not already being used for an existing hostInsight.
  2. The agent availabilityStatus = ‘ACTIVE’
  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) 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ImportableAgentEntitySummaryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_importable_agent_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ImportableEnterpriseManagerEntityCollection

Return type:

Response

Example:

Click here to see an example of how to use list_importable_enterprise_manager_entities 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 Operations 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type OperationsInsightsWarehouseSummaryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_operations_insights_warehouses 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SqlTextCollection

Return type:

Response

Example:

Click here to see an example of how to use list_sql_texts 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

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

list_work_request_logs(work_request_id, **kwargs)

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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestLogEntryCollection

Return type:

Response

Example:

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

list_work_requests(**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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestCollection

Return type:

Response

Example:

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

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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use rotate_operations_insights_warehouse_wallet 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SummarizeAwrSourcesSummariesCollection

Return type:

Response

Example:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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”.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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”.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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”.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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”.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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”.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ExadataMemberCollection

Return type:

Response

Example:

Click here to see an example of how to use summarize_exadata_members 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, and LOGICAL_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.
  • platform_type (list[str]) –

    (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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, and LOGICAL_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.
  • platform_type (list[str]) –

    (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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, and LOGICAL_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.
  • platform_type (list[str]) –

    (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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, and LOGICAL_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.
  • platform_type (list[str]) –

    (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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, and LOGICAL_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.
  • platform_type (list[str]) –

    (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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, and LOGICAL_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.
  • platform_type (list[str]) –

    (optional) Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS].

    Allowed values are: “LINUX”, “SOLARIS”, “SUNOS”

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SummarizeHostInsightResourceUtilizationInsightAggregation

Return type:

Response

Example:

Click here to see an example of how to use summarize_host_insight_resource_utilization_insight 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

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

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

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SqlStatisticsTimeSeriesByPlanAggregationCollection

Return type:

Response

Example:

Click here to see an example of how to use summarize_sql_statistics_time_series_by_plan 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_awr_hub 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

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

update_operations_insights_warehouse(operations_insights_warehouse_id, update_operations_insights_warehouse_details, **kwargs)

Updates the configuration of 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 Operations 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

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