OS Management Event Functions

Package: DBMS_CLOUD_OCI_OM_EVENT

DELETE_EVENT_CONTENT Function

Delete an event content ZIP archive from the service

Syntax

FUNCTION delete_event_content (
  managed_instance_id varchar2,
  event_id varchar2,
  compartment_id varchar2,
  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_om_event_delete_event_content_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) Instance Oracle Cloud identifier (ocid)
`event_id`	(required) Unique Event identifier (OCID)
`compartment_id`	(required) The ID of the compartment in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`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://osms.{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_EVENT Function

Gets an Event by identifier

Syntax

FUNCTION get_event (
  managed_instance_id varchar2,
  event_id varchar2,
  compartment_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_om_event_get_event_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) Instance Oracle Cloud identifier (ocid)
`event_id`	(required) Unique Event identifier (OCID)
`compartment_id`	(required) The ID of the compartment in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`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://osms.{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_EVENT_CONTENT Function

Get additional data about a event as a ZIP archive. The archive content depends on the event eventType.

Syntax

FUNCTION get_event_content (
  managed_instance_id varchar2,
  event_id varchar2,
  compartment_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_om_event_get_event_content_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) Instance Oracle Cloud identifier (ocid)
`event_id`	(required) Unique Event identifier (OCID)
`compartment_id`	(required) The ID of the compartment in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`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://osms.{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_EVENT_REPORT Function

Get summary information about events on this instance.

Syntax

FUNCTION get_event_report (
  managed_instance_id varchar2,
  compartment_id varchar2,
  latest_timestamp_less_than timestamp with time zone DEFAULT NULL,
  latest_timestamp_greater_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_om_event_get_event_report_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) Instance Oracle Cloud identifier (ocid)
`compartment_id`	(required) The ID of the compartment in which to list resources.
`latest_timestamp_less_than`	(optional) filter event occurrence. Selecting only those last occurred before given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z
`latest_timestamp_greater_than_or_equal_to`	(optional) filter event occurrence. Selecting only those last occurred on or after given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z
`opc_request_id`	(optional) The client request ID for tracing.
`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://osms.{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_EVENTS Function

Returns a list of Events.

Syntax

FUNCTION list_events (
  managed_instance_id varchar2,
  compartment_id varchar2,
  event_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,
  event_type varchar2 DEFAULT NULL,
  latest_timestamp_less_than timestamp with time zone DEFAULT NULL,
  latest_timestamp_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_om_event_list_events_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) Instance Oracle Cloud identifier (ocid)
`compartment_id`	(required) The ID of the compartment in which to list resources.
`event_id`	(optional) Unique event identifier (OCID)
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or '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) The client request ID for tracing.
`event_type`	(optional) A filter to return only event of given type. Allowed values are: 'KERNEL_OOPS', 'KERNEL_CRASH', 'CRASH', 'EXPLOIT_ATTEMPT', 'COMPLIANCE', 'TUNING_SUGGESTION', 'TUNING_APPLIED', 'SECURITY', 'ERROR', 'WARNING'
`latest_timestamp_less_than`	(optional) filter event occurrence. Selecting only those last occurred before given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z
`latest_timestamp_greater_than_or_equal_to`	(optional) filter event occurrence. Selecting only those last occurred on or after given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z
`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://osms.{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_RELATED_EVENTS Function

Returns a list of related events. For now pagination is not implemented.

Syntax

FUNCTION list_related_events (
  event_fingerprint varchar2,
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  latest_timestamp_less_than timestamp with time zone DEFAULT NULL,
  latest_timestamp_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_om_event_list_related_events_response_t;

Parameters

Parameter	Description
`event_fingerprint`	(required) Event fingerprint identifier
`compartment_id`	(required) The ID of the compartment in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for id is descending. Allowed values are: 'instanceId', 'id', 'eventFingerprint'
`latest_timestamp_less_than`	(optional) filter event occurrence. Selecting only those last occurred before given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z
`latest_timestamp_greater_than_or_equal_to`	(optional) filter event occurrence. Selecting only those last occurred on or after given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z
`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://osms.{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_EVENT Function

Updates an existing event associated to a managed instance

Syntax

FUNCTION update_event (
  managed_instance_id varchar2,
  event_id varchar2,
  compartment_id varchar2,
  update_event_details dbms_cloud_oci_os_management_update_event_details_t,
  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_om_event_update_event_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) Instance Oracle Cloud identifier (ocid)
`event_id`	(required) Unique Event identifier (OCID)
`compartment_id`	(required) The ID of the compartment in which to list resources.
`update_event_details`	(required) Details about the event to update
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`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://osms.{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.

UPLOAD_EVENT_CONTENT Function

Upload the event content as a ZIP archive from the managed instance to the service

Syntax

FUNCTION upload_event_content (
  managed_instance_id varchar2,
  event_id varchar2,
  compartment_id varchar2,
  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_om_event_upload_event_content_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) Instance Oracle Cloud identifier (ocid)
`event_id`	(required) Unique Event identifier (OCID)
`compartment_id`	(required) The ID of the compartment in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`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://osms.{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.

Oracle Cloud Infrastructure Documentation

DELETE_EVENT_CONTENT Function

GET_EVENT Function

GET_EVENT_CONTENT Function

GET_EVENT_REPORT Function

LIST_EVENTS Function

LIST_RELATED_EVENTS Function

UPDATE_EVENT Function

UPLOAD_EVENT_CONTENT Function