OPSI Functions

Package: DBMS_CLOUD_OCI_OPSI_OPERATIONS_INSIGHTS

ADD_EXADATA_INSIGHT_MEMBERS Function

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

Syntax

FUNCTION add_exadata_insight_members (
  add_exadata_insight_members_details dbms_cloud_oci_opsi_add_exadata_insight_members_details_t,
  exadata_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_add_exadata_insight_members_response_t;

Parameters

Parameter Description

add_exadata_insight_members_details

(required) Details for the members (e.g. databases and hosts) of an Exadata system to be added in Operations Insights.

exadata_insight_id

(required) Unique Exadata insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_AUTONOMOUS_DATABASE_INSIGHT_ADVANCED_FEATURES Function

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

Syntax

FUNCTION change_autonomous_database_insight_advanced_features (
  change_autonomous_database_insight_advanced_features_details dbms_cloud_oci_opsi_change_autonomous_database_insight_advanced_features_details_t,
  database_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_autonomous_database_insight_advanced_features_response_t;

Parameters

Parameter Description

change_autonomous_database_insight_advanced_features_details

(required) Details for the advanced features of Autonomous Database in Operations Insights.

database_insight_id

(required) Unique database insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_AWR_HUB_SOURCE_COMPARTMENT Function

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

Syntax

FUNCTION change_awr_hub_source_compartment (
  awr_hub_source_id varchar2,
  change_awr_hub_source_compartment_details dbms_cloud_oci_opsi_change_awr_hub_source_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_awr_hub_source_compartment_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

change_awr_hub_source_compartment_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATABASE_INSIGHT_COMPARTMENT Function

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

Syntax

FUNCTION change_database_insight_compartment (
  database_insight_id varchar2,
  change_database_insight_compartment_details dbms_cloud_oci_opsi_change_database_insight_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_database_insight_compartment_response_t;

Parameters

Parameter Description

database_insight_id

(required) Unique database insight identifier

change_database_insight_compartment_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_ENTERPRISE_MANAGER_BRIDGE_COMPARTMENT Function

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

Syntax

FUNCTION change_enterprise_manager_bridge_compartment (
  enterprise_manager_bridge_id varchar2,
  change_enterprise_manager_bridge_compartment_details dbms_cloud_oci_opsi_change_enterprise_manager_bridge_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_enterprise_manager_bridge_compartment_response_t;

Parameters

Parameter Description

enterprise_manager_bridge_id

(required) Unique Enterprise Manager bridge identifier

change_enterprise_manager_bridge_compartment_details

(required) The information to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_EXADATA_INSIGHT_COMPARTMENT Function

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

Syntax

FUNCTION change_exadata_insight_compartment (
  exadata_insight_id varchar2,
  change_exadata_insight_compartment_details dbms_cloud_oci_opsi_change_exadata_insight_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_exadata_insight_compartment_response_t;

Parameters

Parameter Description

exadata_insight_id

(required) Unique Exadata insight identifier

change_exadata_insight_compartment_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_HOST_INSIGHT_COMPARTMENT Function

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

Syntax

FUNCTION change_host_insight_compartment (
  host_insight_id varchar2,
  change_host_insight_compartment_details dbms_cloud_oci_opsi_change_host_insight_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_host_insight_compartment_response_t;

Parameters

Parameter Description

host_insight_id

(required) Unique host insight identifier

change_host_insight_compartment_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_NEWS_REPORT_COMPARTMENT Function

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

Syntax

FUNCTION change_news_report_compartment (
  news_report_id varchar2,
  change_news_report_compartment_details dbms_cloud_oci_opsi_change_news_report_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_news_report_compartment_response_t;

Parameters

Parameter Description

news_report_id

(required) Unique news report identifier.

change_news_report_compartment_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_OPERATIONS_INSIGHTS_PRIVATE_ENDPOINT_COMPARTMENT Function

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

Syntax

FUNCTION change_operations_insights_private_endpoint_compartment (
  operations_insights_private_endpoint_id varchar2,
  change_operations_insights_private_endpoint_compartment_details dbms_cloud_oci_opsi_change_operations_insights_private_endpoint_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_operations_insights_private_endpoint_compartment_response_t;

Parameters

Parameter Description

operations_insights_private_endpoint_id

(required) The OCID of the Operation Insights private endpoint.

change_operations_insights_private_endpoint_compartment_details

(required) The details used to change the compartment of a private endpoint

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_OPERATIONS_INSIGHTS_WAREHOUSE_COMPARTMENT Function

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

Syntax

FUNCTION change_operations_insights_warehouse_compartment (
  operations_insights_warehouse_id varchar2,
  change_operations_insights_warehouse_compartment_details dbms_cloud_oci_opsi_change_operations_insights_warehouse_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_operations_insights_warehouse_compartment_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

change_operations_insights_warehouse_compartment_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_OPSI_CONFIGURATION_COMPARTMENT Function

Moves an OpsiConfiguration resource from one compartment to another.

Syntax

FUNCTION change_opsi_configuration_compartment (
  opsi_configuration_id varchar2,
  change_opsi_configuration_compartment_details dbms_cloud_oci_opsi_change_opsi_configuration_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_opsi_configuration_compartment_response_t;

Parameters

Parameter Description

opsi_configuration_id

(required) OCID of OPSI configuration resource.

change_opsi_configuration_compartment_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PE_COMANAGED_DATABASE_INSIGHT Function

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

Syntax

FUNCTION change_pe_comanaged_database_insight (
  database_insight_id varchar2,
  change_pe_comanaged_database_insight_details dbms_cloud_oci_opsi_change_pe_comanaged_database_insight_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_change_pe_comanaged_database_insight_response_t;

Parameters

Parameter Description

database_insight_id

(required) Unique database insight identifier

change_pe_comanaged_database_insight_details

(required) The information to be updated.

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_AWR_HUB Function

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

Syntax

FUNCTION create_awr_hub (
  create_awr_hub_details dbms_cloud_oci_opsi_create_awr_hub_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_awr_hub_response_t;

Parameters

Parameter Description

create_awr_hub_details

(required) Details using which an AWR hub resource will be created in Operations Insights.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_AWR_HUB_SOURCE Function

Register Awr Hub source

Syntax

FUNCTION create_awr_hub_source (
  create_awr_hub_source_details dbms_cloud_oci_opsi_create_awr_hub_source_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_awr_hub_source_response_t;

Parameters

Parameter Description

create_awr_hub_source_details

(required) Payload containing details to register the source database

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DATABASE_INSIGHT Function

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.

Syntax

FUNCTION create_database_insight (
  create_database_insight_details dbms_cloud_oci_opsi_create_database_insight_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_database_insight_response_t;

Parameters

Parameter Description

create_database_insight_details

(required) Details for the database for which a Database Insight resource will be created in Operations Insights.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ENTERPRISE_MANAGER_BRIDGE Function

Create a Enterprise Manager bridge in Operations Insights.

Syntax

FUNCTION create_enterprise_manager_bridge (
  create_enterprise_manager_bridge_details dbms_cloud_oci_opsi_create_enterprise_manager_bridge_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_enterprise_manager_bridge_response_t;

Parameters

Parameter Description

create_enterprise_manager_bridge_details

(required) Details for the Enterprise Manager bridge to be created in Operations Insights.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EXADATA_INSIGHT Function

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.

Syntax

FUNCTION create_exadata_insight (
  create_exadata_insight_details dbms_cloud_oci_opsi_create_exadata_insight_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_exadata_insight_response_t;

Parameters

Parameter Description

create_exadata_insight_details

(required) Details for the Exadata system for which an Exadata insight resource will be created in Operations Insights.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_HOST_INSIGHT Function

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.

Syntax

FUNCTION create_host_insight (
  create_host_insight_details dbms_cloud_oci_opsi_create_host_insight_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_host_insight_response_t;

Parameters

Parameter Description

create_host_insight_details

(required) Details for the host for which a Host Insight resource will be created in Operations Insights.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_NEWS_REPORT Function

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

Syntax

FUNCTION create_news_report (
  create_news_report_details dbms_cloud_oci_opsi_create_news_report_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_news_report_response_t;

Parameters

Parameter Description

create_news_report_details

(required) Details for the news report that will be created in Operations Insights.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_OPERATIONS_INSIGHTS_PRIVATE_ENDPOINT Function

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

Syntax

FUNCTION create_operations_insights_private_endpoint (
  create_operations_insights_private_endpoint_details dbms_cloud_oci_opsi_create_operations_insights_private_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_operations_insights_private_endpoint_response_t;

Parameters

Parameter Description

create_operations_insights_private_endpoint_details

(required) Details to create a new private endpoint.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_OPERATIONS_INSIGHTS_WAREHOUSE Function

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. If the 'opsi-warehouse-type' header is passed to the API, a warehouse resource without ADW or Schema provisioning is created.

Syntax

FUNCTION create_operations_insights_warehouse (
  create_operations_insights_warehouse_details dbms_cloud_oci_opsi_create_operations_insights_warehouse_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_operations_insights_warehouse_response_t;

Parameters

Parameter Description

create_operations_insights_warehouse_details

(required) Details using which an Operations Insights Warehouse resource will be created in Operations Insights.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_OPERATIONS_INSIGHTS_WAREHOUSE_USER Function

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

Syntax

FUNCTION create_operations_insights_warehouse_user (
  create_operations_insights_warehouse_user_details dbms_cloud_oci_opsi_create_operations_insights_warehouse_user_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_operations_insights_warehouse_user_response_t;

Parameters

Parameter Description

create_operations_insights_warehouse_user_details

(required) Parameter using which an Operations Insights Warehouse user resource will be created.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_OPSI_CONFIGURATION Function

Create an OPSI configuration resource.

Syntax

FUNCTION create_opsi_configuration (
  create_opsi_configuration_details dbms_cloud_oci_opsi_create_opsi_configuration_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opsi_config_field dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  config_item_custom_status dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  config_items_applicable_context dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  config_item_field dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_create_opsi_configuration_response_t;

Parameters

Parameter Description

create_opsi_configuration_details

(required) Information about OPSI configuration resource to be created.

opc_retry_token

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

opsi_config_field

(optional) Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default.

Allowed values are: 'configItems'

config_item_custom_status

(optional) Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned.

Allowed values are: 'customized', 'nonCustomized'

config_items_applicable_context

(optional) Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.

config_item_field

(optional) Specifies the fields to return in a config item summary.

Allowed values are: 'name', 'value', 'defaultValue', 'metadata', 'applicableContexts'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AWR_HUB Function

Deletes an AWR hub.

Syntax

FUNCTION delete_awr_hub (
  awr_hub_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_awr_hub_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AWR_HUB_OBJECT Function

Deletes an Awr Hub object.

Syntax

FUNCTION delete_awr_hub_object (
  awr_hub_source_id varchar2,
  object_name varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_awr_hub_object_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

object_name

(required) Unique Awr Hub Object identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_AWR_HUB_SOURCE Function

Deletes an Awr Hub source object.

Syntax

FUNCTION delete_awr_hub_source (
  awr_hub_source_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_awr_hub_source_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DATABASE_INSIGHT Function

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

Syntax

FUNCTION delete_database_insight (
  database_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_database_insight_response_t;

Parameters

Parameter Description

database_insight_id

(required) Unique database insight identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ENTERPRISE_MANAGER_BRIDGE Function

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

Syntax

FUNCTION delete_enterprise_manager_bridge (
  enterprise_manager_bridge_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_enterprise_manager_bridge_response_t;

Parameters

Parameter Description

enterprise_manager_bridge_id

(required) Unique Enterprise Manager bridge identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EXADATA_INSIGHT Function

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

Syntax

FUNCTION delete_exadata_insight (
  exadata_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_exadata_insight_response_t;

Parameters

Parameter Description

exadata_insight_id

(required) Unique Exadata insight identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_HOST_INSIGHT Function

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

Syntax

FUNCTION delete_host_insight (
  host_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_host_insight_response_t;

Parameters

Parameter Description

host_insight_id

(required) Unique host insight identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_NEWS_REPORT Function

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

Syntax

FUNCTION delete_news_report (
  news_report_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_news_report_response_t;

Parameters

Parameter Description

news_report_id

(required) Unique news report identifier.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_OPERATIONS_INSIGHTS_PRIVATE_ENDPOINT Function

Deletes a private endpoint.

Syntax

FUNCTION delete_operations_insights_private_endpoint (
  operations_insights_private_endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_operations_insights_private_endpoint_response_t;

Parameters

Parameter Description

operations_insights_private_endpoint_id

(required) The OCID of the Operation Insights private endpoint.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_OPERATIONS_INSIGHTS_WAREHOUSE Function

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.

Syntax

FUNCTION delete_operations_insights_warehouse (
  operations_insights_warehouse_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_operations_insights_warehouse_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_OPERATIONS_INSIGHTS_WAREHOUSE_USER Function

Deletes an Operations Insights Warehouse User.

Syntax

FUNCTION delete_operations_insights_warehouse_user (
  operations_insights_warehouse_user_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_operations_insights_warehouse_user_response_t;

Parameters

Parameter Description

operations_insights_warehouse_user_id

(required) Unique Operations Insights Warehouse User identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_OPSI_CONFIGURATION Function

Deletes an OPSI configuration resource.

Syntax

FUNCTION delete_opsi_configuration (
  opsi_configuration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_delete_opsi_configuration_response_t;

Parameters

Parameter Description

opsi_configuration_id

(required) OCID of OPSI configuration resource.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_AUTONOMOUS_DATABASE_INSIGHT_ADVANCED_FEATURES Function

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

Syntax

FUNCTION disable_autonomous_database_insight_advanced_features (
  database_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_disable_autonomous_database_insight_advanced_features_response_t;

Parameters

Parameter Description

database_insight_id

(required) Unique database insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_AWR_HUB_SOURCE Function

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

Syntax

FUNCTION disable_awr_hub_source (
  awr_hub_source_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_disable_awr_hub_source_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_DATABASE_INSIGHT Function

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

Syntax

FUNCTION disable_database_insight (
  database_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_disable_database_insight_response_t;

Parameters

Parameter Description

database_insight_id

(required) Unique database insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_EXADATA_INSIGHT Function

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

Syntax

FUNCTION disable_exadata_insight (
  exadata_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_disable_exadata_insight_response_t;

Parameters

Parameter Description

exadata_insight_id

(required) Unique Exadata insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_HOST_INSIGHT Function

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

Syntax

FUNCTION disable_host_insight (
  host_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_disable_host_insight_response_t;

Parameters

Parameter Description

host_insight_id

(required) Unique host insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DOWNLOAD_OPERATIONS_INSIGHTS_WAREHOUSE_WALLET Function

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

Syntax

FUNCTION download_operations_insights_warehouse_wallet (
  operations_insights_warehouse_id varchar2,
  download_operations_insights_warehouse_wallet_details dbms_cloud_oci_opsi_download_operations_insights_warehouse_wallet_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_download_operations_insights_warehouse_wallet_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

download_operations_insights_warehouse_wallet_details

(required) The information to be updated.

opc_request_id

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_AUTONOMOUS_DATABASE_INSIGHT_ADVANCED_FEATURES Function

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

Syntax

FUNCTION enable_autonomous_database_insight_advanced_features (
  enable_autonomous_database_insight_advanced_features_details dbms_cloud_oci_opsi_enable_autonomous_database_insight_advanced_features_details_t,
  database_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_enable_autonomous_database_insight_advanced_features_response_t;

Parameters

Parameter Description

enable_autonomous_database_insight_advanced_features_details

(required) Connection Details for the Autonomous Database in Operations Insights.

database_insight_id

(required) Unique database insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_AWR_HUB_SOURCE Function

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

Syntax

FUNCTION enable_awr_hub_source (
  awr_hub_source_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_enable_awr_hub_source_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_DATABASE_INSIGHT Function

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

Syntax

FUNCTION enable_database_insight (
  enable_database_insight_details dbms_cloud_oci_opsi_enable_database_insight_details_t,
  database_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_enable_database_insight_response_t;

Parameters

Parameter Description

enable_database_insight_details

(required) Details for the database to be enabled in Operations Insights.

database_insight_id

(required) Unique database insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_EXADATA_INSIGHT Function

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

Syntax

FUNCTION enable_exadata_insight (
  enable_exadata_insight_details dbms_cloud_oci_opsi_enable_exadata_insight_details_t,
  exadata_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_enable_exadata_insight_response_t;

Parameters

Parameter Description

enable_exadata_insight_details

(required) Details for the Exadata system to be enabled in Operations Insights.

exadata_insight_id

(required) Unique Exadata insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_HOST_INSIGHT Function

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

Syntax

FUNCTION enable_host_insight (
  enable_host_insight_details dbms_cloud_oci_opsi_enable_host_insight_details_t,
  host_insight_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_enable_host_insight_response_t;

Parameters

Parameter Description

enable_host_insight_details

(required) Details for the host to be enabled in Operations Insights.

host_insight_id

(required) Unique host insight identifier

if_match

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_DATABASE_REPORT Function

Gets the AWR report for the specified database.

Syntax

FUNCTION get_awr_database_report (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  report_type varchar2 DEFAULT NULL,
  report_format varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_awr_database_report_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

report_type

(optional) The query parameter to filter the AWR report types.

Allowed values are: 'AWR', 'ASH'

report_format

(optional) The format of the AWR report.

Allowed values are: 'HTML', 'TEXT'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_DATABASE_SQL_REPORT Function

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

Syntax

FUNCTION get_awr_database_sql_report (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  sql_id varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  report_format varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_awr_database_sql_report_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

sql_id

(required) The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/awrHubs/{awrHubId}/awrDbReport).

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

report_format

(optional) The format of the AWR report.

Allowed values are: 'HTML', 'TEXT'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_HUB Function

Gets details of an AWR hub.

Syntax

FUNCTION get_awr_hub (
  awr_hub_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_awr_hub_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_HUB_OBJECT Function

Gets the Awr Hub object metadata and body.

Syntax

FUNCTION get_awr_hub_object (
  awr_hub_source_id varchar2,
  object_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_awr_hub_object_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

object_name

(required) Unique Awr Hub Object identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_HUB_SOURCE Function

Gets the Awr Hub source object.

Syntax

FUNCTION get_awr_hub_source (
  awr_hub_source_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_awr_hub_source_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_REPORT Function

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.

Syntax

FUNCTION get_awr_report (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  report_format varchar2 DEFAULT NULL,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_awr_report_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) AWR source database identifier.

report_format

(optional) The format of the AWR report. Default report format is HTML.

Allowed values are: 'HTML', 'TEXT'

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_INSIGHT Function

Gets details of a database insight.

Syntax

FUNCTION get_database_insight (
  database_insight_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_database_insight_response_t;

Parameters

Parameter Description

database_insight_id

(required) Unique database insight identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ENTERPRISE_MANAGER_BRIDGE Function

Gets details of an Operations Insights Enterprise Manager bridge.

Syntax

FUNCTION get_enterprise_manager_bridge (
  enterprise_manager_bridge_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_enterprise_manager_bridge_response_t;

Parameters

Parameter Description

enterprise_manager_bridge_id

(required) Unique Enterprise Manager bridge identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXADATA_INSIGHT Function

Gets details of an Exadata insight.

Syntax

FUNCTION get_exadata_insight (
  exadata_insight_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_exadata_insight_response_t;

Parameters

Parameter Description

exadata_insight_id

(required) Unique Exadata insight identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_HOST_INSIGHT Function

Gets details of a host insight.

Syntax

FUNCTION get_host_insight (
  host_insight_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_host_insight_response_t;

Parameters

Parameter Description

host_insight_id

(required) Unique host insight identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_NEWS_REPORT Function

Gets details of a news report.

Syntax

FUNCTION get_news_report (
  news_report_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_news_report_response_t;

Parameters

Parameter Description

news_report_id

(required) Unique news report identifier.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPERATIONS_INSIGHTS_PRIVATE_ENDPOINT Function

Gets the details of the specified private endpoint.

Syntax

FUNCTION get_operations_insights_private_endpoint (
  operations_insights_private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_operations_insights_private_endpoint_response_t;

Parameters

Parameter Description

operations_insights_private_endpoint_id

(required) The OCID of the Operation Insights private endpoint.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPERATIONS_INSIGHTS_WAREHOUSE Function

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.

Syntax

FUNCTION get_operations_insights_warehouse (
  operations_insights_warehouse_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_operations_insights_warehouse_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPERATIONS_INSIGHTS_WAREHOUSE_USER Function

Gets details of an Operations Insights Warehouse User.

Syntax

FUNCTION get_operations_insights_warehouse_user (
  operations_insights_warehouse_user_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_operations_insights_warehouse_user_response_t;

Parameters

Parameter Description

operations_insights_warehouse_user_id

(required) Unique Operations Insights Warehouse User identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPSI_CONFIGURATION Function

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

Syntax

FUNCTION get_opsi_configuration (
  opsi_configuration_id varchar2,
  opsi_config_field dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  config_item_custom_status dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  config_items_applicable_context dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  config_item_field dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_opsi_configuration_response_t;

Parameters

Parameter Description

opsi_configuration_id

(required) OCID of OPSI configuration resource.

opsi_config_field

(optional) Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default.

Allowed values are: 'configItems'

config_item_custom_status

(optional) Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned.

Allowed values are: 'customized', 'nonCustomized'

config_items_applicable_context

(optional) Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.

config_item_field

(optional) Specifies the fields to return in a config item summary.

Allowed values are: 'name', 'value', 'defaultValue', 'metadata', 'applicableContexts'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPSI_DATA_OBJECT Function

Gets details of an OPSI data object.

Syntax

FUNCTION get_opsi_data_object (
  compartment_id varchar2,
  opsi_data_object_identifier varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_opsi_data_object_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

opsi_data_object_identifier

(required) Unique OPSI data object identifier.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

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

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_get_work_request_response_t;

Parameters

Parameter Description

work_request_id

(required) The ID of the asynchronous request.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

HEAD_AWR_HUB_OBJECT Function

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

Syntax

FUNCTION head_awr_hub_object (
  awr_hub_source_id varchar2,
  object_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_head_awr_hub_object_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

object_name

(required) Unique Awr Hub Object identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_ADDM_REPORTS Function

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

Syntax

FUNCTION ingest_addm_reports (
  ingest_addm_reports_details dbms_cloud_oci_opsi_ingest_addm_reports_details_t,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_addm_reports_response_t;

Parameters

Parameter Description

ingest_addm_reports_details

(required) Collection of addm reports for a particular database.

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_DATABASE_CONFIGURATION Function

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

Syntax

FUNCTION ingest_database_configuration (
  ingest_database_configuration_details dbms_cloud_oci_opsi_ingest_database_configuration_details_t,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_database_configuration_response_t;

Parameters

Parameter Description

ingest_database_configuration_details

(required) Payload for one or more database configuration metrics for a particular database.

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_HOST_CONFIGURATION Function

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

Syntax

FUNCTION ingest_host_configuration (
  id varchar2,
  ingest_host_configuration_details dbms_cloud_oci_opsi_ingest_host_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_host_configuration_response_t;

Parameters

Parameter Description

id

(required) Required OCID of the host insight resource.

ingest_host_configuration_details

(required) Payload for one or more host configuration metrics for a particular host.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_HOST_METRICS Function

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

Syntax

FUNCTION ingest_host_metrics (
  id varchar2,
  ingest_host_metrics_details dbms_cloud_oci_opsi_ingest_host_metrics_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_host_metrics_response_t;

Parameters

Parameter Description

id

(required) Required OCID of the host insight resource.

ingest_host_metrics_details

(required) Payload for one or more host performance metrics for a particular host.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_SQL_BUCKET Function

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

Syntax

FUNCTION ingest_sql_bucket (
  ingest_sql_bucket_details dbms_cloud_oci_opsi_ingest_sql_bucket_details_t,
  compartment_id varchar2 DEFAULT NULL,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_sql_bucket_response_t;

Parameters

Parameter Description

ingest_sql_bucket_details

(required) Collection of SQL bucket objects for a particular database.

compartment_id

(optional) The OCID of the compartment.

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_SQL_PLAN_LINES Function

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

Syntax

FUNCTION ingest_sql_plan_lines (
  ingest_sql_plan_lines_details dbms_cloud_oci_opsi_ingest_sql_plan_lines_details_t,
  compartment_id varchar2 DEFAULT NULL,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_sql_plan_lines_response_t;

Parameters

Parameter Description

ingest_sql_plan_lines_details

(required) Collection of SQL plan line objects for a particular database.

compartment_id

(optional) The OCID of the compartment.

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_SQL_STATS Function

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

Syntax

FUNCTION ingest_sql_stats (
  ingest_sql_stats_details dbms_cloud_oci_opsi_ingest_sql_stats_details_t,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_sql_stats_response_t;

Parameters

Parameter Description

ingest_sql_stats_details

(required) Collection of SQL stats objects for a particular database.

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

INGEST_SQL_TEXT Function

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.

Syntax

FUNCTION ingest_sql_text (
  ingest_sql_text_details dbms_cloud_oci_opsi_ingest_sql_text_details_t,
  compartment_id varchar2 DEFAULT NULL,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_ingest_sql_text_response_t;

Parameters

Parameter Description

ingest_sql_text_details

(required) Collection of SQL text objects for a particular database.

compartment_id

(optional) The OCID of the compartment.

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

opc_request_id

(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

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ADDM_DB_FINDING_CATEGORIES Function

Gets list of ADDM finding categories.

Syntax

FUNCTION list_addm_db_finding_categories (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_addm_db_finding_categories_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the finding categories

Allowed values are: 'name'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ADDM_DB_FINDINGS_TIME_SERIES Function

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

Syntax

FUNCTION list_addm_db_findings_time_series (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  instance_number varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  category_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_addm_db_findings_time_series_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

time_interval_start

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

category_name

(optional) Optional value filter to match the finding category exactly.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the ADDM finding time series summary data

Allowed values are: 'timestamp'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ADDM_DB_PARAMETER_CATEGORIES Function

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

Syntax

FUNCTION list_addm_db_parameter_categories (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_addm_db_parameter_categories_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the database parameter categories

Allowed values are: 'name'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ADDM_DB_RECOMMENDATION_CATEGORIES Function

Gets list of ADDM recommendation categories for the specified databases.

Syntax

FUNCTION list_addm_db_recommendation_categories (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_addm_db_recommendation_categories_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the recommendation categories

Allowed values are: 'name'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ADDM_DB_RECOMMENDATIONS_TIME_SERIES Function

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

Syntax

FUNCTION list_addm_db_recommendations_time_series (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  instance_number varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  category_name varchar2 DEFAULT NULL,
  sql_identifier varchar2 DEFAULT NULL,
  owner_or_name_contains varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_addm_db_recommendations_time_series_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

time_interval_start

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

category_name

(optional) Optional value filter to match the finding category exactly.

sql_identifier

(optional) Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING.

owner_or_name_contains

(optional) Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT.

name_contains

(optional) Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.

name

(optional) Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the ADDM recommendation time series summary data

Allowed values are: 'timestamp'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ADDM_DBS Function

Gets a list of ADDM database information

Syntax

FUNCTION list_addm_dbs (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_addm_dbs_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

time_interval_start

(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

(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

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting ADDM database data

Allowed values are: 'databaseName', 'numberOfFindings'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_DATABASE_SNAPSHOTS Function

Lists AWR snapshots for the specified database in the AWR.

Syntax

FUNCTION list_awr_database_snapshots (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_awr_database_snapshots_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

page

(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

(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

(optional) The option to sort the AWR snapshot summary data.

Allowed values are: 'TIME_BEGIN', 'SNAPSHOT_ID'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_DATABASES Function

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

Syntax

FUNCTION list_awr_databases (
  awr_hub_id varchar2,
  name varchar2 DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_awr_databases_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

name

(optional) The optional single value query parameter to filter the entity name.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

page

(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

(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

(optional) The option to sort the AWR summary data.

Allowed values are: 'END_INTERVAL_TIME', 'NAME'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_HUB_OBJECTS Function

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

Syntax

FUNCTION list_awr_hub_objects (
  awr_hub_source_id varchar2,
  prefix varchar2 DEFAULT NULL,
  l_start varchar2 DEFAULT NULL,
  l_end varchar2 DEFAULT NULL,
  delimiter varchar2 DEFAULT NULL,
  start_after varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  fields varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_awr_hub_objects_response_t;

Parameters

Parameter Description

awr_hub_source_id

(required) Unique Awr Hub Source identifier

prefix

(optional) The string to use for matching against the start of object names in a Awr Hub list objects query.

l_start

(optional) Object names returned by Awr Hub list objects query must be greater or equal to this parameter.

l_end

(optional) Object names returned by Awr Hub list objects query must be strictly less than this parameter.

delimiter

(optional) When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the Awr Hub list objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at this time.

start_after

(optional) Awr Hub Object name after which remaining objects are listed

page

(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

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`

fields

(optional) By default all the fields are returned. Use this parameter to fetch specific fields 'size', 'etag', 'md5', 'timeCreated', 'timeModified', 'storageTier' and 'archivalState' fields. List the names of those fields in a comma-separated, case-insensitive list as the value of this parameter. For example: 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.

Allowed values are: 'name', 'size', 'etag', 'timeCreated', 'md5', 'archivalState', 'timeModified', 'storageTier'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_HUB_SOURCES Function

Gets a list of Awr Hub source objects.

Syntax

FUNCTION list_awr_hub_sources (
  awr_hub_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  awr_hub_source_id varchar2 DEFAULT NULL,
  source_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  status dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_awr_hub_sources_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

compartment_id

(optional) The OCID of the compartment.

awr_hub_source_id

(optional) Awr Hub source identifier

source_type

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW_S', 'ATP_S', 'ADW_D', 'ATP_D', 'EXTERNAL_PDB', 'EXTERNAL_NONCDB', 'COMANAGED_VM_CDB', 'COMANAGED_VM_PDB', 'COMANAGED_VM_NONCDB', 'COMANAGED_BM_CDB', 'COMANAGED_BM_PDB', 'COMANAGED_BM_NONCDB', 'COMANAGED_EXACS_CDB', 'COMANAGED_EXACS_PDB', 'COMANAGED_EXACS_NONCDB', 'UNDEFINED'

name

(optional) Awr Hub source database name

status

(optional) Resource Status

Allowed values are: 'ACCEPTING', 'NOT_ACCEPTING', 'NOT_REGISTERED', 'TERMINATED'

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_HUBS Function

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

Syntax

FUNCTION list_awr_hubs (
  operations_insights_warehouse_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_awr_hubs_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

compartment_id

(optional) The OCID of the compartment.

display_name

(optional) A filter to return only resources that match the entire display name.

id

(optional) Unique Awr Hub identifier

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_SNAPSHOTS Function

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.

Syntax

FUNCTION list_awr_snapshots (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_awr_snapshots_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) AWR source database identifier.

time_greater_than_or_equal_to

(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

(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

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The option to sort the AWR snapshot summary data. Default sort is by timeBegin.

Allowed values are: 'timeBegin', 'snapshotId'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_CONFIGURATIONS Function

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.

Syntax

FUNCTION list_database_configurations (
  compartment_id varchar2 DEFAULT NULL,
  enterprise_manager_bridge_id varchar2 DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_database_configurations_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

enterprise_manager_bridge_id

(optional) Unique Enterprise Manager bridge identifier

id

(optional) Optional list of database insight resource OCIDs.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

cdb_name

(optional) Filter by one or more cdb name.

database_type

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) Filter by one or more hostname.

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_INSIGHTS Function

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.

Syntax

FUNCTION list_database_insights (
  compartment_id varchar2 DEFAULT NULL,
  enterprise_manager_bridge_id varchar2 DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  status dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  fields dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  exadata_insight_id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  opsi_private_endpoint_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_database_insights_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

enterprise_manager_bridge_id

(optional) Unique Enterprise Manager bridge identifier

id

(optional) Optional list of database insight resource OCIDs.

status

(optional) Resource Status

Allowed values are: 'DISABLED', 'ENABLED', 'TERMINATED'

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

database_type

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

fields

(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

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) OCID of exadata insight resource.

compartment_id_in_subtree

(optional) A flag to search all resources within a given compartment and all sub-compartments.

opsi_private_endpoint_id

(optional) Unique Operations Insights PrivateEndpoint identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ENTERPRISE_MANAGER_BRIDGES Function

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.

Syntax

FUNCTION list_enterprise_manager_bridges (
  compartment_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_enterprise_manager_bridges_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

display_name

(optional) A filter to return only resources that match the entire display name.

id

(optional) Unique Enterprise Manager bridge identifier

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXADATA_CONFIGURATIONS Function

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

Syntax

FUNCTION list_exadata_configurations (
  compartment_id varchar2 DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_exadata_configurations_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXADATA_INSIGHTS Function

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.

Syntax

FUNCTION list_exadata_insights (
  compartment_id varchar2 DEFAULT NULL,
  enterprise_manager_bridge_id varchar2 DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  status dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_exadata_insights_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

enterprise_manager_bridge_id

(optional) Unique Enterprise Manager bridge identifier

id

(optional) Optional list of Exadata insight resource OCIDs.

status

(optional) Resource Status

Allowed values are: 'DISABLED', 'ENABLED', 'TERMINATED'

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_HOST_CONFIGURATIONS Function

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.

Syntax

FUNCTION list_host_configurations (
  compartment_id varchar2 DEFAULT NULL,
  enterprise_manager_bridge_id varchar2 DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_host_configurations_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

enterprise_manager_bridge_id

(optional) Unique Enterprise Manager bridge identifier

id

(optional) Optional list of host insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

platform_type

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Host configuration list sort options.

Allowed values are: 'hostName', 'platformType'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_HOST_INSIGHTS Function

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.

Syntax

FUNCTION list_host_insights (
  compartment_id varchar2 DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  status dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  enterprise_manager_bridge_id varchar2 DEFAULT NULL,
  exadata_insight_id varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_host_insights_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

id

(optional) Optional list of host insight resource OCIDs.

status

(optional) Resource Status

Allowed values are: 'DISABLED', 'ENABLED', 'TERMINATED'

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

platform_type

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) Unique Enterprise Manager bridge identifier

exadata_insight_id

(optional) OCID of exadata insight resource.

compartment_id_in_subtree

(optional) A flag to search all resources within a given compartment and all sub-compartments.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_HOSTED_ENTITIES Function

Get a list of hosted entities details.

Syntax

FUNCTION list_hosted_entities (
  compartment_id varchar2,
  id varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_hosted_entities_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

id

(required) Required OCID of the host insight resource.

analysis_time_interval

(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

(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

(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

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

exadata_insight_id

(optional) OCID of exadata insight resource.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Hosted entity list sort options.

Allowed values are: 'entityName', 'entityType'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IMPORTABLE_AGENT_ENTITIES Function

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'

Syntax

FUNCTION list_importable_agent_entities (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_importable_agent_entities_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Hosted entity list sort options.

Allowed values are: 'entityName', 'entityType'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IMPORTABLE_COMPUTE_ENTITIES Function

Gets a list of available compute intances running cloud agent to add a new hostInsight. An Compute entity is \"available\" and will be shown if all the following conditions are true: 1. Compute is running OCA 2. OCI Management Agent is not enabled or If OCI Management Agent is enabled 2.1 The agent OCID is not already being used for an existing hostInsight. 2.2 The agent availabilityStatus = 'ACTIVE' 2.3 The agent lifecycleState = 'ACTIVE'

Syntax

FUNCTION list_importable_compute_entities (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_importable_compute_entities_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Compute entity list sort options.

Allowed values are: 'computeId', 'computeDisplayName', 'platformType', 'hostName'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IMPORTABLE_ENTERPRISE_MANAGER_ENTITIES Function

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

Syntax

FUNCTION list_importable_enterprise_manager_entities (
  enterprise_manager_bridge_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  enterprise_manager_entity_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  enterprise_manager_identifier varchar2 DEFAULT NULL,
  enterprise_manager_parent_entity_identifier varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_importable_enterprise_manager_entities_response_t;

Parameters

Parameter Description

enterprise_manager_bridge_id

(required) Unique Enterprise Manager bridge identifier

limit

(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

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NEWS_REPORTS Function

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

Syntax

FUNCTION list_news_reports (
  compartment_id varchar2 DEFAULT NULL,
  news_report_id varchar2 DEFAULT NULL,
  status dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_news_reports_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

news_report_id

(optional) Unique Operations Insights news report identifier

status

(optional) Resource Status

Allowed values are: 'DISABLED', 'ENABLED', 'TERMINATED'

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) News report list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.

Allowed values are: 'name', 'newsFrequency'

compartment_id_in_subtree

(optional) A flag to search all resources within a given compartment and all sub-compartments.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPERATIONS_INSIGHTS_PRIVATE_ENDPOINTS Function

Gets a list of Operation Insights private endpoints.

Syntax

FUNCTION list_operations_insights_private_endpoints (
  compartment_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opsi_private_endpoint_id varchar2 DEFAULT NULL,
  is_used_for_rac_dbs number DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_operations_insights_private_endpoints_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

display_name

(optional) A filter to return only resources that match the entire display name.

opsi_private_endpoint_id

(optional) Unique Operations Insights PrivateEndpoint identifier

is_used_for_rac_dbs

(optional) The option to filter OPSI private endpoints that can used for RAC. Should be used along with vcnId query parameter.

vcn_id

(optional) The OCID of the VCN.

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort private endpoints.

Allowed values are: 'timeCreated', 'id', 'displayName'

compartment_id_in_subtree

(optional) A flag to search all resources within a given compartment and all sub-compartments.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPERATIONS_INSIGHTS_WAREHOUSE_USERS Function

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.

Syntax

FUNCTION list_operations_insights_warehouse_users (
  operations_insights_warehouse_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_operations_insights_warehouse_users_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

compartment_id

(optional) The OCID of the compartment.

display_name

(optional) A filter to return only resources that match the entire display name.

id

(optional) Unique Operations Insights Warehouse User identifier

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPERATIONS_INSIGHTS_WAREHOUSES Function

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.

Syntax

FUNCTION list_operations_insights_warehouses (
  compartment_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_operations_insights_warehouses_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

display_name

(optional) A filter to return only resources that match the entire display name.

id

(optional) Unique Operations Insights Warehouse identifier

lifecycle_state

(optional) Lifecycle states

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPSI_CONFIGURATIONS Function

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

Syntax

FUNCTION list_opsi_configurations (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opsi_config_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_opsi_configurations_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

display_name

(optional) Filter to return based on resources that match the entire display name.

lifecycle_state

(optional) Filter to return based on Lifecycle state of OPSI configuration.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

opsi_config_type

(optional) Filter to return based on configuration type of OPSI configuration.

Allowed values are: 'UX_CONFIGURATION'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) OPSI configurations list sort options.

Allowed values are: 'displayName'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPSI_DATA_OBJECTS Function

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

Syntax

FUNCTION list_opsi_data_objects (
  compartment_id varchar2,
  data_object_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  group_name varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_opsi_data_objects_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

data_object_type

(optional) OPSI data object types.

Allowed values are: 'DATABASE_INSIGHTS_DATA_OBJECT', 'HOST_INSIGHTS_DATA_OBJECT', 'EXADATA_INSIGHTS_DATA_OBJECT'

display_name

(optional) A filter to return only resources that match the entire display name.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) OPSI data object list sort options.

Allowed values are: 'displayName', 'dataObjectType', 'name'

group_name

(optional) A filter to return only data objects that belongs to the group of the given group name. By default, no filtering will be applied on group name.

name

(optional) A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_PLANS Function

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.

Syntax

FUNCTION list_sql_plans (
  compartment_id varchar2,
  sql_identifier varchar2,
  plan_hash dbms_cloud_oci_opsi_number_tbl,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_sql_plans_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`

plan_hash

(required) Unique plan hash for a SQL Plan of a particular SQL Statement. Example: `9820154385`

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

page

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_SEARCHES Function

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.

Syntax

FUNCTION list_sql_searches (
  compartment_id varchar2,
  sql_identifier varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_sql_searches_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`

analysis_time_interval

(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

(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

(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

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_TEXTS Function

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

Syntax

FUNCTION list_sql_texts (
  compartment_id varchar2,
  sql_identifier dbms_cloud_oci_opsi_varchar2_tbl,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_sql_texts_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) One or more unique SQL_IDs for a SQL Statement. Example: `6rgjh9bjmy2s7`

database_id

(optional) Optional list of database OCIDs of the assosicated DBaaS entity.

id

(optional) Optional list of database OCIDs of the database insight resource.

page

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WAREHOUSE_DATA_OBJECTS Function

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

Syntax

FUNCTION list_warehouse_data_objects (
  warehouse_type varchar2,
  warehouse_id varchar2,
  data_object_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  owner varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  summary_field dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_warehouse_data_objects_response_t;

Parameters

Parameter Description

warehouse_type

(required) Type of the Warehouse.

Allowed values are: 'awrHubs'

warehouse_id

(required) The OCID of a Warehouse.

data_object_type

(optional) A filter to return only data objects that match the data object type. By default, no filtering will be applied on data object type.

Allowed values are: 'VIEW', 'TABLE'

name

(optional) A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name.

owner

(optional) A filter to return only data objects that match the entire data object owner name. By default, no filtering will be applied on data object owner name.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort options for Warehouse data objects list.

Allowed values are: 'dataObjectType', 'name', 'owner'

summary_field

(optional) Specifies the optional fields to return in a WarehouseDataObjectSummary. Unless requested, these fields are not returned by default.

Allowed values are: 'details'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

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

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_work_request_errors_response_t;

Parameters

Parameter Description

work_request_id

(required) The ID of the asynchronous request.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

page

(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

(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

(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

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

Allowed values are: 'ASC', 'DESC'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

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

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_work_request_logs_response_t;

Parameters

Parameter Description

work_request_id

(required) The ID of the asynchronous request.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

page

(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

(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

(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

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

Allowed values are: 'ASC', 'DESC'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

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.

Syntax

FUNCTION list_work_requests (
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  related_resource_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_list_work_requests_response_t;

Parameters

Parameter Description

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

page

(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

(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

(optional) The OCID of the compartment.

id

(optional) The ID of the asynchronous work request.

status

(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

(optional) The ID of the resource affected by the work request.

related_resource_id

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

Allowed values are: 'timeAccepted'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

PUT_AWR_HUB_OBJECT Function

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

Syntax

FUNCTION put_awr_hub_object (
  put_awr_hub_object_body blob,
  awr_hub_source_id varchar2,
  object_name varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_put_awr_hub_object_response_t;

Parameters

Parameter Description

put_awr_hub_object_body

(required) The object to be uploaded to the Awr Hub.

awr_hub_source_id

(required) Unique Awr Hub Source identifier

object_name

(required) Unique Awr Hub Object identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

QUERY_OPSI_DATA_OBJECT_DATA Function

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

Syntax

FUNCTION query_opsi_data_object_data (
  compartment_id varchar2,
  query_opsi_data_object_data_details dbms_cloud_oci_opsi_query_opsi_data_object_data_details_t,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_query_opsi_data_object_data_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

query_opsi_data_object_data_details

(required) The information to be used for querying an OPSI data object.

limit

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

QUERY_WAREHOUSE_DATA_OBJECT_DATA Function

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

Syntax

FUNCTION query_warehouse_data_object_data (
  warehouse_type varchar2,
  warehouse_id varchar2,
  query_warehouse_data_object_data_details dbms_cloud_oci_opsi_query_warehouse_data_object_data_details_t,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_query_warehouse_data_object_data_response_t;

Parameters

Parameter Description

warehouse_type

(required) Type of the Warehouse.

Allowed values are: 'awrHubs'

warehouse_id

(required) The OCID of a Warehouse.

query_warehouse_data_object_data_details

(required) The information to be used for querying a Warehouse.

limit

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

ROTATE_OPERATIONS_INSIGHTS_WAREHOUSE_WALLET Function

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

Syntax

FUNCTION rotate_operations_insights_warehouse_wallet (
  operations_insights_warehouse_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_rotate_operations_insights_warehouse_wallet_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

opc_request_id

(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

(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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_ADDM_DB_FINDINGS Function

Summarizes ADDM findings for the specified databases.

Syntax

FUNCTION summarize_addm_db_findings (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  instance_number varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  category_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_addm_db_findings_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

time_interval_start

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

category_name

(optional) Optional value filter to match the finding category exactly.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the ADDM finding summary data

Allowed values are: 'impactOverallPercent', 'impactMaxPercent', 'impactAvgActiveSessions', 'frequencyCount'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_ADDM_DB_PARAMETER_CHANGES Function

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

Syntax

FUNCTION summarize_addm_db_parameter_changes (
  compartment_id varchar2,
  name varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  instance_number varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  value_contains varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_addm_db_parameter_changes_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

name

(required) Required filter to return only changes for the specified parameter. The match is case sensitive.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

time_interval_start

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

value_contains

(optional) Optional filter to return only resources whose value contains the substring given. The match is not case sensitive.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the database parameter change data

Allowed values are: 'isChanged', 'beginSnapId'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_ADDM_DB_PARAMETERS Function

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

Syntax

FUNCTION summarize_addm_db_parameters (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  instance_number varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  category_name varchar2 DEFAULT NULL,
  name_or_value_contains varchar2 DEFAULT NULL,
  is_changed varchar2 DEFAULT NULL,
  is_default varchar2 DEFAULT NULL,
  has_recommendations varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_addm_db_parameters_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

time_interval_start

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

category_name

(optional) Optional value filter to match the parameter category exactly. Note the list of possible category names can be retrieved from the following endpoint: /databases/{databaseId}/addmDbParameterCategories.

name_or_value_contains

(optional) Optional filter to return only resources whose name or value contains the substring given. The match is not case sensitive.

is_changed

(optional) Optional filter to return only parameters whose value changed in the specified time period. Valid values include: TRUE, FALSE

Allowed values are: 'true', 'false'

is_default

(optional) Optional filter to return only parameters whose end value was set to the default value (TRUE) or was specified in the parameter file (FALSE). Valid values include: TRUE, FALSE

Allowed values are: 'true', 'false'

has_recommendations

(optional) Optional filter to return only parameters which have recommendations in the specified time period. Valid values include: TRUE, FALSE

Allowed values are: 'true', 'false'

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the database parameter data

Allowed values are: 'isChanged', 'name'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_ADDM_DB_RECOMMENDATIONS Function

Summarizes ADDM recommendations for the specified databases.

Syntax

FUNCTION summarize_addm_db_recommendations (
  compartment_id varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  instance_number varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  category_name varchar2 DEFAULT NULL,
  finding_identifier varchar2 DEFAULT NULL,
  sql_identifier varchar2 DEFAULT NULL,
  owner_or_name_contains varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_addm_db_recommendations_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

time_interval_start

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

category_name

(optional) Optional value filter to match the finding category exactly.

finding_identifier

(optional) Unique finding ID

sql_identifier

(optional) Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING.

owner_or_name_contains

(optional) Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT.

name_contains

(optional) Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.

name

(optional) Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Field name for sorting the recommendation data

Allowed values are: 'maxBenefitPercent', 'maxBenefitAvgActiveSessions', 'frequencyCount'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_ADDM_DB_SCHEMA_OBJECTS Function

Summarizes Schema objects for the specified databases for the specified objectIdentifiers

Syntax

FUNCTION summarize_addm_db_schema_objects (
  compartment_id varchar2,
  object_identifier dbms_cloud_oci_opsi_number_tbl,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_addm_db_schema_objects_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

object_identifier

(required) One or more unique Object id (from RDBMS)

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

time_interval_start

(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

(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

(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

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_ADDM_DB_SQL_STATEMENTS Function

Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers

Syntax

FUNCTION summarize_addm_db_sql_statements (
  compartment_id varchar2,
  sql_identifier dbms_cloud_oci_opsi_varchar2_tbl,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_addm_db_sql_statements_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) One or more unique SQL_IDs for a SQL Statement. Example: `6rgjh9bjmy2s7`

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

time_interval_start

(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

(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

(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

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_CPU_USAGES Function

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

Syntax

FUNCTION summarize_awr_database_cpu_usages (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  session_type varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_cpu_usages_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

session_type

(optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND.

Allowed values are: 'FOREGROUND', 'BACKGROUND', 'ALL'

page

(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

(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

(optional) The option to sort the AWR CPU usage summary data.

Allowed values are: 'TIME_SAMPLED', 'AVG_VALUE'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_METRICS Function

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

Syntax

FUNCTION summarize_awr_database_metrics (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  name dbms_cloud_oci_opsi_varchar2_tbl,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_metrics_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

name

(required) The required multiple value query parameter to filter the entity name.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

page

(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

(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

(optional) The option to sort the AWR time series summary data.

Allowed values are: 'TIMESTAMP', 'NAME'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_PARAMETER_CHANGES Function

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

Syntax

FUNCTION summarize_awr_database_parameter_changes (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  name varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_parameter_changes_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

name

(required) The required single value query parameter to filter the entity name.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

page

(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

(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

(optional) The option to sort the AWR database parameter change history data.

Allowed values are: 'IS_CHANGED', 'NAME'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_PARAMETERS Function

Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include: Queryparam (valueChanged =\"Y\") - Each parameter whose value was changed during the time range, \"isChanged : true\" in response for the DB params. Queryparam (valueChanged =\"N\") - Each parameter whose value was unchanged during the time range, \"isChanged : false\" in response for the DB params. Queryparam (valueChanged =\"Y\" and valueModified = \"SYSTEM_MOD\") - Each parameter whose value was changed at the system level during the time range, \"isChanged : true\" & \"valueModified : SYSTEM_MOD\" in response for the DB params. Queryparam (valueChanged =\"N\" and valueDefault = \"FALSE\") - Each parameter whose value was unchanged during the time range, however, the value is not the default value, \"isChanged : true\" & \"isDefault : false\" in response for the DB params. Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /awrHubs/{awrHubId}/awrDbParameterChanges?awrSourceDatabaseIdentifier={awrSourceDbId}

Syntax

FUNCTION summarize_awr_database_parameters (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  value_changed varchar2 DEFAULT NULL,
  value_default varchar2 DEFAULT NULL,
  value_modified varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_parameters_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

name

(optional) The optional multiple value query parameter to filter the entity name.

name_contains

(optional) The optional contains query parameter to filter the entity name by any part of the name.

value_changed

(optional) The optional query parameter to filter database parameters whose values were changed.

Allowed values are: 'Y', 'N'

value_default

(optional) The optional query parameter to filter the database parameters that had the default value in the last snapshot.

Allowed values are: 'TRUE', 'FALSE'

value_modified

(optional) The optional query parameter to filter the database parameters that had a modified value in the last snapshot.

Allowed values are: 'MODIFIED', 'SYSTEM_MOD', 'FALSE'

page

(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

(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

(optional) The option to sort the AWR database parameter change history data.

Allowed values are: 'IS_CHANGED', 'NAME'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_SNAPSHOT_RANGES Function

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

Syntax

FUNCTION summarize_awr_database_snapshot_ranges (
  awr_hub_id varchar2,
  name varchar2 DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_snapshot_ranges_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

name

(optional) The optional single value query parameter to filter the entity name.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

page

(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

(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

(optional) The option to sort the AWR summary data.

Allowed values are: 'END_INTERVAL_TIME', 'NAME'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_SYSSTATS Function

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

Syntax

FUNCTION summarize_awr_database_sysstats (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  name dbms_cloud_oci_opsi_varchar2_tbl,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_sysstats_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

name

(required) The required multiple value query parameter to filter the entity name.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

page

(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

(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

(optional) The option to sort the data within a time period.

Allowed values are: 'TIME_BEGIN', 'NAME'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_TOP_WAIT_EVENTS Function

Summarizes the AWR top wait events.

Syntax

FUNCTION summarize_awr_database_top_wait_events (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  session_type varchar2 DEFAULT NULL,
  top_n number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_top_wait_events_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

session_type

(optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND.

Allowed values are: 'FOREGROUND', 'BACKGROUND', 'ALL'

top_n

(optional) The optional query parameter to filter the number of top categories to be returned.

sort_by

(optional) The option to sort the AWR top event summary data.

Allowed values are: 'WAITS_PERSEC', 'AVG_WAIT_TIME_PERSEC'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_WAIT_EVENT_BUCKETS Function

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

Syntax

FUNCTION summarize_awr_database_wait_event_buckets (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  name varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  num_bucket number DEFAULT NULL,
  min_value number DEFAULT NULL,
  max_value number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_wait_event_buckets_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

name

(required) The required single value query parameter to filter the entity name.

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

num_bucket

(optional) The number of buckets within the histogram.

min_value

(optional) The minimum value of the histogram.

max_value

(optional) The maximum value of the histogram.

page

(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

(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

(optional) The option to sort distribution data.

Allowed values are: 'CATEGORY', 'PERCENTAGE'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DATABASE_WAIT_EVENTS Function

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

Syntax

FUNCTION summarize_awr_database_wait_events (
  awr_hub_id varchar2,
  awr_source_database_identifier varchar2,
  instance_number varchar2 DEFAULT NULL,
  begin_snapshot_identifier_greater_than_or_equal_to number DEFAULT NULL,
  end_snapshot_identifier_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  session_type varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_database_wait_events_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

awr_source_database_identifier

(required) The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases

instance_number

(optional) The optional single value query parameter to filter by database instance number.

begin_snapshot_identifier_greater_than_or_equal_to

(optional) The optional greater than or equal to filter on the snapshot ID.

end_snapshot_identifier_less_than_or_equal_to

(optional) The optional less than or equal to query parameter to filter the snapshot Identifier.

time_greater_than_or_equal_to

(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

(optional) The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z

name

(optional) The optional multiple value query parameter to filter the entity name.

session_type

(optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND.

Allowed values are: 'FOREGROUND', 'BACKGROUND', 'ALL'

page

(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

(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

(optional) The option to sort the data within a time period.

Allowed values are: 'TIME_BEGIN', 'NAME'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_SOURCES_SUMMARIES Function

Gets a list of summary of AWR Sources.

Syntax

FUNCTION summarize_awr_sources_summaries (
  awr_hub_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_awr_sources_summaries_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

compartment_id

(optional) The OCID of the compartment.

name

(optional) Name for an Awr source database

limit

(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

(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

(optional) The order in which Awr sources summary records are listed

Allowed values are: 'snapshotsUploaded', 'name'

sort_order

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

Allowed values are: 'ASC', 'DESC'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_CONFIGURATION_ITEMS Function

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

Syntax

FUNCTION summarize_configuration_items (
  compartment_id varchar2 DEFAULT NULL,
  opsi_config_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  config_items_applicable_context dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  config_item_field dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_configuration_items_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment.

opsi_config_type

(optional) Filter to return configuration items based on configuration type of OPSI configuration.

Allowed values are: 'UX_CONFIGURATION'

limit

(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

(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.

config_items_applicable_context

(optional) Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.

config_item_field

(optional) Specifies the fields to return in a config item summary.

Allowed values are: 'name', 'value', 'defaultValue', 'valueSourceConfig', 'metadata', 'applicableContexts'

name

(optional) A filter to return only configuration items that match the entire name.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_DATABASE_INSIGHT_RESOURCE_CAPACITY_TREND Function

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.

Syntax

FUNCTION summarize_database_insight_resource_capacity_trend (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  utilization_level varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  tablespace_name varchar2 DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  is_database_instance_level_metrics number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_database_insight_resource_capacity_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.

analysis_time_interval

(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

(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

(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

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

cdb_name

(optional) Filter by one or more cdb name.

utilization_level

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sorts using end timestamp , capacity or baseCapacity

Allowed values are: 'endTimestamp', 'capacity', 'baseCapacity'

tablespace_name

(optional) Tablespace name for a database

host_name

(optional) Filter by one or more hostname.

is_database_instance_level_metrics

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_DATABASE_INSIGHT_RESOURCE_FORECAST_TREND Function

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.

Syntax

FUNCTION summarize_database_insight_resource_forecast_trend (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  forecast_model varchar2 DEFAULT NULL,
  utilization_level varchar2 DEFAULT NULL,
  confidence number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  tablespace_name varchar2 DEFAULT NULL,
  is_database_instance_level_metrics number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_database_insight_resource_forecast_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.

analysis_time_interval

(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

(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

(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

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

cdb_name

(optional) Filter by one or more cdb name.

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

forecast_days

(optional) Number of days used for utilization forecast analysis.

forecast_model

(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

(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

(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

(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

(optional) Filter by one or more hostname.

tablespace_name

(optional) Tablespace name for a database

is_database_instance_level_metrics

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_DATABASE_INSIGHT_RESOURCE_STATISTICS Function

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.

Syntax

FUNCTION summarize_database_insight_resource_statistics (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  percentile number DEFAULT NULL,
  insight_by varchar2 DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  is_database_instance_level_metrics number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_database_insight_resource_statistics_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.

analysis_time_interval

(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

(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

(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

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

cdb_name

(optional) Filter by one or more cdb name.

percentile

(optional) Percentile values of daily usage to be used for computing the aggregate resource usage.

insight_by

(optional) Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast

forecast_days

(optional) Number of days used for utilization forecast analysis.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The order in which resource statistics records are listed

Allowed values are: 'utilizationPercent', 'usage', 'usageChangePercent', 'databaseName', 'databaseType'

host_name

(optional) Filter by one or more hostname.

is_database_instance_level_metrics

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_DATABASE_INSIGHT_RESOURCE_USAGE Function

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.

Syntax

FUNCTION summarize_database_insight_resource_usage (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  is_database_instance_level_metrics number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  percentile number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_database_insight_resource_usage_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.

analysis_time_interval

(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

(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

(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

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

host_name

(optional) Filter by one or more hostname.

is_database_instance_level_metrics

(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

(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

(optional) Percentile values of daily usage to be used for computing the aggregate resource usage.

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

cdb_name

(optional) Filter by one or more cdb name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_DATABASE_INSIGHT_RESOURCE_USAGE_TREND Function

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.

Syntax

FUNCTION summarize_database_insight_resource_usage_trend (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  is_database_instance_level_metrics number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_database_insight_resource_usage_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.

analysis_time_interval

(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

(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

(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

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

page

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sorts using end timestamp, usage or capacity

Allowed values are: 'endTimestamp', 'usage', 'capacity'

host_name

(optional) Filter by one or more hostname.

is_database_instance_level_metrics

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

cdb_name

(optional) Filter by one or more cdb name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_DATABASE_INSIGHT_RESOURCE_UTILIZATION_INSIGHT Function

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.

Syntax

FUNCTION summarize_database_insight_resource_utilization_insight (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  is_database_instance_level_metrics number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_database_insight_resource_utilization_insight_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.

analysis_time_interval

(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

(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

(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

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

forecast_days

(optional) Number of days used for utilization forecast analysis.

host_name

(optional) Filter by one or more hostname.

is_database_instance_level_metrics

(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

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

cdb_name

(optional) Filter by one or more cdb name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_DATABASE_INSIGHT_TABLESPACE_USAGE_TREND Function

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.

Syntax

FUNCTION summarize_database_insight_tablespace_usage_trend (
  compartment_id varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_database_insight_tablespace_usage_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

analysis_time_interval

(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

(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

(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

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

page

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_CAPACITY_TREND Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_capacity_trend (
  resource_type varchar2,
  resource_metric varchar2,
  exadata_insight_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  storage_server_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_capacity_trend_response_t;

Parameters

Parameter Description

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

exadata_insight_id

(required) OCID of exadata insight resource.

compartment_id

(optional) The OCID of the compartment.

analysis_time_interval

(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

(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

(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

(optional) Optional list of database insight resource OCIDs.

host_insight_id

(optional) Optional list of host insight resource OCIDs.

storage_server_name

(optional) Optional storage server name on an exadata system.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

page

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The order in which resource capacity trend records are listed

Allowed values are: 'id', 'name'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_CAPACITY_TREND_AGGREGATED Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_capacity_trend_aggregated (
  resource_type varchar2,
  resource_metric varchar2,
  compartment_id varchar2 DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_capacity_trend_aggregated_response_t;

Parameters

Parameter Description

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

compartment_id

(optional) The OCID of the compartment.

analysis_time_interval

(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

(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

(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

(optional) Optional list of exadata insight resource OCIDs.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

page

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sorts using end timestamp or capacity.

Allowed values are: 'endTimestamp', 'capacity'

defined_tag_equals

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_FORECAST_TREND Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_forecast_trend (
  resource_type varchar2,
  resource_metric varchar2,
  exadata_insight_id varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  database_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  storage_server_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  forecast_start_day number DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  forecast_model varchar2 DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  confidence number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_forecast_trend_response_t;

Parameters

Parameter Description

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

exadata_insight_id

(required) OCID of exadata insight resource.

analysis_time_interval

(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

(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

(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

(optional) Optional list of database insight resource OCIDs.

host_insight_id

(optional) Optional list of host insight resource OCIDs.

storage_server_name

(optional) Optional storage server name on an exadata system.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

forecast_start_day

(optional) Number of days used for utilization forecast analysis.

forecast_days

(optional) Number of days used for utilization forecast analysis.

forecast_model

(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

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The order in which resource Forecast trend records are listed

Allowed values are: 'id', 'name', 'daysToReachCapacity'

page

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_FORECAST_TREND_AGGREGATED Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_forecast_trend_aggregated (
  resource_type varchar2,
  resource_metric varchar2,
  compartment_id varchar2 DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  forecast_start_day number DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  forecast_model varchar2 DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  confidence number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_forecast_trend_aggregated_response_t;

Parameters

Parameter Description

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

compartment_id

(optional) The OCID of the compartment.

analysis_time_interval

(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

(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

(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

(optional) Optional list of exadata insight resource OCIDs.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

forecast_start_day

(optional) Number of days used for utilization forecast analysis.

forecast_days

(optional) Number of days used for utilization forecast analysis.

forecast_model

(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

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

confidence

(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

(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

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_STATISTICS Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_statistics (
  exadata_insight_id varchar2,
  resource_type varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  percentile number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_statistics_response_t;

Parameters

Parameter Description

exadata_insight_id

(required) OCID of exadata insight resource.

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

analysis_time_interval

(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

(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

(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

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

percentile

(optional) Percentile values of daily usage to be used for computing the aggregate resource usage.

sort_order

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The order in which resource statistics records are listed

Allowed values are: 'utilizationPercent', 'usage', 'usageChangePercent'

limit

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_USAGE Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_usage (
  compartment_id varchar2,
  resource_type varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  percentile number DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_usage_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

analysis_time_interval

(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

(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

(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

(optional) Optional list of exadata insight resource OCIDs.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

sort_order

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The order in which resource usage summary records are listed

Allowed values are: 'utilizationPercent', 'usage', 'capacity', 'usageChangePercent'

page

(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

(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

(optional) Percentile values of daily usage to be used for computing the aggregate resource usage.

defined_tag_equals

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_USAGE_AGGREGATED Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_usage_aggregated (
  compartment_id varchar2,
  resource_type varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  percentile number DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_usage_aggregated_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

analysis_time_interval

(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

(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

(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

(optional) Optional list of exadata insight resource OCIDs.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

page

(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

(optional) Percentile values of daily usage to be used for computing the aggregate resource usage.

defined_tag_equals

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_INSIGHT_RESOURCE_UTILIZATION_INSIGHT Function

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.

Syntax

FUNCTION summarize_exadata_insight_resource_utilization_insight (
  compartment_id varchar2,
  resource_type varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  forecast_start_day number DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_insight_resource_utilization_insight_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_type

(required) Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE

resource_metric

(required) Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT

analysis_time_interval

(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

(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

(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

(optional) Optional list of exadata insight resource OCIDs.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

forecast_start_day

(optional) Number of days used for utilization forecast analysis.

forecast_days

(optional) Number of days used for utilization forecast analysis.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by hostname.

limit

(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

(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

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXADATA_MEMBERS Function

Lists the software and hardware inventory of the Exadata System.

Syntax

FUNCTION summarize_exadata_members (
  exadata_insight_id varchar2,
  exadata_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_exadata_members_response_t;

Parameters

Parameter Description

exadata_insight_id

(required) OCID of exadata insight resource.

exadata_type

(optional) Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.

sort_order

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The order in which exadata member records are listed

Allowed values are: 'name', 'displayName', 'entityType'

limit

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_DISK_STATISTICS Function

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

Syntax

FUNCTION summarize_host_insight_disk_statistics (
  compartment_id varchar2,
  id varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_disk_statistics_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

id

(required) Required OCID of the host insight resource.

analysis_time_interval

(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

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

host_id

(optional) Optional OCID of the host (Compute Id)

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_HOST_RECOMMENDATION Function

Returns response with some recommendations if apply for a host.

Syntax

FUNCTION summarize_host_insight_host_recommendation (
  compartment_id varchar2,
  id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_host_recommendation_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

id

(required) Required OCID of the host insight resource.

resource_metric

(required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

analysis_time_interval

(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

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

host_id

(optional) Optional OCID of the host (Compute Id)

limit

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_NETWORK_USAGE_TREND Function

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

Syntax

FUNCTION summarize_host_insight_network_usage_trend (
  compartment_id varchar2,
  id varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_network_usage_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

id

(required) Required OCID of the host insight resource.

analysis_time_interval

(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

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

host_id

(optional) Optional OCID of the host (Compute Id)

page

(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

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_RESOURCE_CAPACITY_TREND Function

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.

Syntax

FUNCTION summarize_host_insight_resource_capacity_trend (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  utilization_level varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_resource_capacity_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

analysis_time_interval

(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

(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

(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

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

id

(optional) Optional list of host insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

utilization_level

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sorts using end timestamp or capacity

Allowed values are: 'endTimestamp', 'capacity'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_RESOURCE_FORECAST_TREND Function

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.

Syntax

FUNCTION summarize_host_insight_resource_forecast_trend (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  forecast_model varchar2 DEFAULT NULL,
  utilization_level varchar2 DEFAULT NULL,
  confidence number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  mount_point varchar2 DEFAULT NULL,
  interface_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_resource_forecast_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

analysis_time_interval

(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

(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

(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

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

id

(optional) Optional list of host insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

forecast_days

(optional) Number of days used for utilization forecast analysis.

forecast_model

(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

(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

(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

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

mount_point

(optional) Mount points are specialized NTFS filesystem objects.

interface_name

(optional) Name of the network interface.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_RESOURCE_STATISTICS Function

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.

Syntax

FUNCTION summarize_host_insight_resource_statistics (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  percentile number DEFAULT NULL,
  insight_by varchar2 DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_resource_statistics_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

analysis_time_interval

(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

(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

(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

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

id

(optional) Optional list of host insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

percentile

(optional) Percentile values of daily usage to be used for computing the aggregate resource usage.

insight_by

(optional) Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast

forecast_days

(optional) Number of days used for utilization forecast analysis.

limit

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The order in which resource statistics records are listed.

Allowed values are: 'utilizationPercent', 'usage', 'usageChangePercent', 'hostName', 'platformType'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_RESOURCE_USAGE Function

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.

Syntax

FUNCTION summarize_host_insight_resource_usage (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  percentile number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_resource_usage_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

analysis_time_interval

(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

(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

(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

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

id

(optional) Optional list of host insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

page

(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

(optional) Percentile values of daily usage to be used for computing the aggregate resource usage.

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_RESOURCE_USAGE_TREND Function

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.

Syntax

FUNCTION summarize_host_insight_resource_usage_trend (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_resource_usage_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

analysis_time_interval

(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

(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

(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

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

id

(optional) Optional list of host insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

page

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sorts using end timestamp, usage or capacity

Allowed values are: 'endTimestamp', 'usage', 'capacity'

opc_request_id

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_RESOURCE_UTILIZATION_INSIGHT Function

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.

Syntax

FUNCTION summarize_host_insight_resource_utilization_insight (
  compartment_id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  platform_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  forecast_days number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  high_utilization_threshold number DEFAULT NULL,
  low_utilization_threshold number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_resource_utilization_insight_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

resource_metric

(required) Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

analysis_time_interval

(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

(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

(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

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

Allowed values are: 'LINUX', 'SOLARIS', 'SUNOS', 'ZLINUX', 'WINDOWS', 'AIX', 'HP_UX'

id

(optional) Optional list of host insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

forecast_days

(optional) Number of days used for utilization forecast analysis.

page

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

high_utilization_threshold

(optional) Percent value in which a resource metric is considered highly utilized.

low_utilization_threshold

(optional) Percent value in which a resource metric is considered low utilized.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_STORAGE_USAGE_TREND Function

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

Syntax

FUNCTION summarize_host_insight_storage_usage_trend (
  compartment_id varchar2,
  id varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_storage_usage_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

id

(required) Required OCID of the host insight resource.

analysis_time_interval

(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

(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

(optional) Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

host_id

(optional) Optional OCID of the host (Compute Id)

page

(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

(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_TOP_PROCESSES_USAGE Function

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

Syntax

FUNCTION summarize_host_insight_top_processes_usage (
  compartment_id varchar2,
  id varchar2,
  resource_metric varchar2,
  l_timestamp timestamp with time zone,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_top_processes_usage_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

id

(required) Required OCID of the host insight resource.

resource_metric

(required) Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY.

l_timestamp

(required) Timestamp at which to gather the top processes. This will be top processes over the hour or over the day pending the time range passed into the query.

time_interval_start

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

analysis_time_interval

(optional) Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_HOST_INSIGHT_TOP_PROCESSES_USAGE_TREND Function

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

Syntax

FUNCTION summarize_host_insight_top_processes_usage_trend (
  compartment_id varchar2,
  id varchar2,
  resource_metric varchar2,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  host_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  process_hash varchar2 DEFAULT NULL,
  statistic varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_host_insight_top_processes_usage_trend_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

id

(required) Required OCID of the host insight resource.

resource_metric

(required) Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY.

analysis_time_interval

(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

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

host_type

(optional) Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST

host_id

(optional) Optional OCID of the host (Compute Id)

process_hash

(optional) Unique identifier for a process.

statistic

(optional) Choose the type of statistic metric data to be used for forecasting.

Allowed values are: 'AVG', 'MAX'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_OPERATIONS_INSIGHTS_WAREHOUSE_RESOURCE_USAGE Function

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.

Syntax

FUNCTION summarize_operations_insights_warehouse_resource_usage (
  operations_insights_warehouse_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_operations_insights_warehouse_resource_usage_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_INSIGHTS Function

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.

Syntax

FUNCTION summarize_sql_insights (
  compartment_id varchar2,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_time_pct_greater_than number DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_sql_insights_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_type

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by one or more hostname.

database_time_pct_greater_than

(optional) Filter sqls by percentage of db time.

analysis_time_interval

(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

(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

(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

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_PLAN_INSIGHTS Function

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.

Syntax

FUNCTION summarize_sql_plan_insights (
  compartment_id varchar2,
  sql_identifier varchar2,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_sql_plan_insights_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

analysis_time_interval

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_RESPONSE_TIME_DISTRIBUTIONS Function

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.

Syntax

FUNCTION summarize_sql_response_time_distributions (
  compartment_id varchar2,
  sql_identifier varchar2,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_sql_response_time_distributions_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

analysis_time_interval

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_STATISTICS Function

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.

Syntax

FUNCTION summarize_sql_statistics (
  compartment_id varchar2,
  database_type dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  database_time_pct_greater_than number DEFAULT NULL,
  sql_identifier dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  category dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_sql_statistics_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

database_type

(optional) Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.

Allowed values are: 'ADW-S', 'ATP-S', 'ADW-D', 'ATP-D', 'EXTERNAL-PDB', 'EXTERNAL-NONCDB', 'COMANAGED-VM-CDB', 'COMANAGED-VM-PDB', 'COMANAGED-VM-NONCDB', 'COMANAGED-BM-CDB', 'COMANAGED-BM-PDB', 'COMANAGED-BM-NONCDB', 'COMANAGED-EXACS-CDB', 'COMANAGED-EXACS-PDB', 'COMANAGED-EXACS-NONCDB'

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database insight resource OCIDs.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by one or more hostname.

database_time_pct_greater_than

(optional) Filter sqls by percentage of db time.

sql_identifier

(optional) One or more unique SQL_IDs for a SQL Statement. Example: `6rgjh9bjmy2s7`

analysis_time_interval

(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

(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

(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

(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

(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

(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

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

Allowed values are: 'ASC', 'DESC'

sort_by

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_STATISTICS_TIME_SERIES Function

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.

Syntax

FUNCTION summarize_sql_statistics_time_series (
  compartment_id varchar2,
  sql_identifier varchar2,
  database_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  exadata_insight_id dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  cdb_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  host_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  defined_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_equals dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  defined_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  freeform_tag_exists dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  vmcluster_name dbms_cloud_oci_opsi_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_sql_statistics_time_series_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`

database_id

(optional) Optional list of database OCIDs of the associated DBaaS entity.

id

(optional) Optional list of database OCIDs of the database insight resource.

exadata_insight_id

(optional) Optional list of exadata insight resource OCIDs.

cdb_name

(optional) Filter by one or more cdb name.

host_name

(optional) Filter by one or more hostname.

analysis_time_interval

(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

(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

(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

(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

(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

(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

(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

(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

(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

(optional) A flag to search all resources within a given compartment and all sub-compartments.

vmcluster_name

(optional) Optional list of Exadata Insight VM cluster name.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_STATISTICS_TIME_SERIES_BY_PLAN Function

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.

Syntax

FUNCTION summarize_sql_statistics_time_series_by_plan (
  compartment_id varchar2,
  sql_identifier varchar2,
  database_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  analysis_time_interval varchar2 DEFAULT NULL,
  time_interval_start timestamp with time zone DEFAULT NULL,
  time_interval_end timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_summarize_sql_statistics_time_series_by_plan_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

sql_identifier

(required) Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7`

database_id

(optional) Optional OCID of the associated DBaaS entity.

id

(optional) OCID of the database insight resource.

analysis_time_interval

(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

(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

(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

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AWR_HUB Function

Updates the configuration of a hub .

Syntax

FUNCTION update_awr_hub (
  awr_hub_id varchar2,
  update_awr_hub_details dbms_cloud_oci_opsi_update_awr_hub_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_awr_hub_response_t;

Parameters

Parameter Description

awr_hub_id

(required) Unique Awr Hub identifier

update_awr_hub_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AWR_HUB_SOURCE Function

Update Awr Hub Source object.

Syntax

FUNCTION update_awr_hub_source (
  update_awr_hub_source_details dbms_cloud_oci_opsi_update_awr_hub_source_details_t,
  awr_hub_source_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_awr_hub_source_response_t;

Parameters

Parameter Description

update_awr_hub_source_details

(required) The configuration to be updated.

awr_hub_source_id

(required) Unique Awr Hub Source identifier

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DATABASE_INSIGHT Function

Updates configuration of a database insight.

Syntax

FUNCTION update_database_insight (
  database_insight_id varchar2,
  update_database_insight_details dbms_cloud_oci_opsi_update_database_insight_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_database_insight_response_t;

Parameters

Parameter Description

database_insight_id

(required) Unique database insight identifier

update_database_insight_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ENTERPRISE_MANAGER_BRIDGE Function

Updates configuration of an Operations Insights Enterprise Manager bridge.

Syntax

FUNCTION update_enterprise_manager_bridge (
  enterprise_manager_bridge_id varchar2,
  update_enterprise_manager_bridge_details dbms_cloud_oci_opsi_update_enterprise_manager_bridge_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_enterprise_manager_bridge_response_t;

Parameters

Parameter Description

enterprise_manager_bridge_id

(required) Unique Enterprise Manager bridge identifier

update_enterprise_manager_bridge_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXADATA_INSIGHT Function

Updates configuration of an Exadata insight.

Syntax

FUNCTION update_exadata_insight (
  exadata_insight_id varchar2,
  update_exadata_insight_details dbms_cloud_oci_opsi_update_exadata_insight_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_exadata_insight_response_t;

Parameters

Parameter Description

exadata_insight_id

(required) Unique Exadata insight identifier

update_exadata_insight_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_HOST_INSIGHT Function

Updates configuration of a host insight.

Syntax

FUNCTION update_host_insight (
  host_insight_id varchar2,
  update_host_insight_details dbms_cloud_oci_opsi_update_host_insight_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_host_insight_response_t;

Parameters

Parameter Description

host_insight_id

(required) Unique host insight identifier

update_host_insight_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_NEWS_REPORT Function

Updates the configuration of a news report.

Syntax

FUNCTION update_news_report (
  news_report_id varchar2,
  update_news_report_details dbms_cloud_oci_opsi_update_news_report_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_news_report_response_t;

Parameters

Parameter Description

news_report_id

(required) Unique news report identifier.

update_news_report_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_OPERATIONS_INSIGHTS_PRIVATE_ENDPOINT Function

Updates one or more attributes of the specified private endpoint.

Syntax

FUNCTION update_operations_insights_private_endpoint (
  operations_insights_private_endpoint_id varchar2,
  update_operations_insights_private_endpoint_details dbms_cloud_oci_opsi_update_operations_insights_private_endpoint_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_operations_insights_private_endpoint_response_t;

Parameters

Parameter Description

operations_insights_private_endpoint_id

(required) The OCID of the Operation Insights private endpoint.

update_operations_insights_private_endpoint_details

(required) The details used to update a private endpoint.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_OPERATIONS_INSIGHTS_WAREHOUSE Function

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.

Syntax

FUNCTION update_operations_insights_warehouse (
  operations_insights_warehouse_id varchar2,
  update_operations_insights_warehouse_details dbms_cloud_oci_opsi_update_operations_insights_warehouse_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_operations_insights_warehouse_response_t;

Parameters

Parameter Description

operations_insights_warehouse_id

(required) Unique Operations Insights Warehouse identifier

update_operations_insights_warehouse_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_OPERATIONS_INSIGHTS_WAREHOUSE_USER Function

Updates the configuration of an Operations Insights Warehouse User.

Syntax

FUNCTION update_operations_insights_warehouse_user (
  operations_insights_warehouse_user_id varchar2,
  update_operations_insights_warehouse_user_details dbms_cloud_oci_opsi_update_operations_insights_warehouse_user_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_operations_insights_warehouse_user_response_t;

Parameters

Parameter Description

operations_insights_warehouse_user_id

(required) Unique Operations Insights Warehouse User identifier

update_operations_insights_warehouse_user_details

(required) The configuration to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_OPSI_CONFIGURATION Function

Updates an OPSI configuration resource with the given ID.

Syntax

FUNCTION update_opsi_configuration (
  opsi_configuration_id varchar2,
  update_opsi_configuration_details dbms_cloud_oci_opsi_update_opsi_configuration_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_opsi_operations_insights_update_opsi_configuration_response_t;

Parameters

Parameter Description

opsi_configuration_id

(required) OCID of OPSI configuration resource.

update_opsi_configuration_details

(required) The OPSI configuration resource details to be updated.

if_match

(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

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://operationsinsights.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.