Logging Functions

Package: DBMS_CLOUD_OCI_LOG_LOGGING_MANAGEMENT

CHANGE_LOG_GROUP_COMPARTMENT Function

Moves a log group into a different compartment within the same tenancy. When provided, the If-Match is checked against the resource ETag values. For information about moving resources between compartments, see Moving Resources Between Compartments.

Syntax

FUNCTION change_log_group_compartment (
  log_group_id varchar2,
  change_log_group_compartment_details dbms_cloud_oci_logging_change_log_group_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_log_logging_management_change_log_group_compartment_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`change_log_group_compartment_details`	(required) Request to change the compartment of a given resource.
`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_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://logging.{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_LOG_LOG_GROUP Function

Moves a log into a different log group within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.

Syntax

FUNCTION change_log_log_group (
  log_group_id varchar2,
  log_id varchar2,
  change_log_log_group_details dbms_cloud_oci_logging_change_log_log_group_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_log_logging_management_change_log_log_group_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`log_id`	(required) OCID of a log to work with.
`change_log_log_group_details`	(required) Request to change the log group of a given log.
`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_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://logging.{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_LOG_SAVED_SEARCH_COMPARTMENT Function

Moves a saved search into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_log_saved_search_compartment (
  log_saved_search_id varchar2,
  change_log_saved_search_compartment_details dbms_cloud_oci_logging_change_log_saved_search_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_log_logging_management_change_log_saved_search_compartment_response_t;

Parameters

Parameter	Description
`log_saved_search_id`	(required) OCID of the logSavedSearch.
`change_log_saved_search_compartment_details`	(required) Contains details indicating which compartment the resource should move to.
`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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`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_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://logging.{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_UNIFIED_AGENT_CONFIGURATION_COMPARTMENT Function

Moves the unified agent configuration into a different compartment within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Syntax

FUNCTION change_unified_agent_configuration_compartment (
  unified_agent_configuration_id varchar2,
  change_unified_agent_configuration_compartment_details dbms_cloud_oci_logging_change_unified_agent_configuration_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_log_logging_management_change_unified_agent_configuration_compartment_response_t;

Parameters

Parameter	Description
`unified_agent_configuration_id`	(required) The OCID of the Unified Agent configuration.
`change_unified_agent_configuration_compartment_details`	(required) Request to change the compartment of a given resource.
`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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`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_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://logging.{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_LOG Function

Creates a log within the specified log group. This call fails if a log group has already been created with the same displayName or (service, resource, category) triplet.

Syntax

FUNCTION create_log (
  log_group_id varchar2,
  create_log_details dbms_cloud_oci_logging_create_log_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_log_logging_management_create_log_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`create_log_details`	(required) Log object configuration details.
`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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`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://logging.{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_LOG_GROUP Function

Create a new log group with a unique display name. This call fails if the log group is already created with the same displayName in the compartment.

Syntax

FUNCTION create_log_group (
  create_log_group_details dbms_cloud_oci_logging_create_log_group_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_log_logging_management_create_log_group_response_t;

Parameters

Parameter	Description
`create_log_group_details`	(required) Details to create log group.
`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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`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://logging.{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_LOG_SAVED_SEARCH Function

Creates a new LogSavedSearch.

Syntax

FUNCTION create_log_saved_search (
  create_log_saved_search_details dbms_cloud_oci_logging_create_log_saved_search_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_log_logging_management_create_log_saved_search_response_t;

Parameters

Parameter	Description
`create_log_saved_search_details`	(required) Specification of the saved search to create.
`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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`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://logging.{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_UNIFIED_AGENT_CONFIGURATION Function

Create unified agent configuration registration.

Syntax

FUNCTION create_unified_agent_configuration (
  create_unified_agent_configuration_details dbms_cloud_oci_logging_create_unified_agent_configuration_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_log_logging_management_create_unified_agent_configuration_response_t;

Parameters

Parameter	Description
`create_unified_agent_configuration_details`	(required) Unified agent configuration creation object.
`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 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may 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://logging.{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_LOG Function

Deletes the log object in a log group.

Syntax

FUNCTION delete_log (
  log_group_id varchar2,
  log_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_log_logging_management_delete_log_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`log_id`	(required) OCID of a log to work with.
`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_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://logging.{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_LOG_GROUP Function

Deletes the specified log group.

Syntax

FUNCTION delete_log_group (
  log_group_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_log_logging_management_delete_log_group_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`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_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://logging.{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_LOG_SAVED_SEARCH Function

Deletes the specified LogSavedSearch.

Syntax

FUNCTION delete_log_saved_search (
  log_saved_search_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_log_logging_management_delete_log_saved_search_response_t;

Parameters

Parameter	Description
`log_saved_search_id`	(required) OCID of the logSavedSearch.
`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_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://logging.{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_UNIFIED_AGENT_CONFIGURATION Function

Delete unified agent configuration.

Syntax

FUNCTION delete_unified_agent_configuration (
  unified_agent_configuration_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_log_logging_management_delete_unified_agent_configuration_response_t;

Parameters

Parameter	Description
`unified_agent_configuration_id`	(required) The OCID of the Unified Agent configuration.
`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) 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://logging.{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_WORK_REQUEST Function

Cancel a work request that has not started yet.

Syntax

FUNCTION delete_work_request (
  work_request_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_log_logging_management_delete_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The asynchronous request ID.
`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_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://logging.{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_LOG Function

Gets the log object configuration for the log object OCID.

Syntax

FUNCTION get_log (
  log_group_id varchar2,
  log_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_log_logging_management_get_log_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`log_id`	(required) OCID of a log to work with.
`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://logging.{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_LOG_GROUP Function

Get the specified log group's information.

Syntax

FUNCTION get_log_group (
  log_group_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_log_logging_management_get_log_group_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`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://logging.{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_LOG_SAVED_SEARCH Function

Retrieves a LogSavedSearch.

Syntax

FUNCTION get_log_saved_search (
  log_saved_search_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_log_logging_management_get_log_saved_search_response_t;

Parameters

Parameter	Description
`log_saved_search_id`	(required) OCID of the logSavedSearch.
`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://logging.{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_UNIFIED_AGENT_CONFIGURATION Function

Get the unified agent configuration for an ID.

Syntax

FUNCTION get_unified_agent_configuration (
  unified_agent_configuration_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_log_logging_management_get_unified_agent_configuration_response_t;

Parameters

Parameter	Description
`unified_agent_configuration_id`	(required) The OCID of the Unified Agent configuration.
`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://logging.{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 details 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_log_logging_management_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The asynchronous request ID.
`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://logging.{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_LOG_GROUPS Function

Lists all log groups for the specified compartment or tenancy.

Syntax

FUNCTION list_log_groups (
  compartment_id varchar2,
  is_compartment_id_in_subtree number DEFAULT NULL,
  display_name 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_log_logging_management_list_log_groups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.
`is_compartment_id_in_subtree`	(optional) Specifies whether or not nested compartments should be traversed. Defaults to false.
`display_name`	(optional) Resource name.
`page`	(optional) For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`sort_by`	(optional) The field to sort by (one column only). Default sort order is ascending exception of `timeCreated` and `timeLastModified` columns (descending). Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, whether 'asc' or '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://logging.{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_LOG_SAVED_SEARCHES Function

Lists LogSavedSearches for this compartment.

Syntax

FUNCTION list_log_saved_searches (
  compartment_id varchar2,
  log_saved_search_id varchar2 DEFAULT NULL,
  name 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_log_logging_management_list_log_saved_searches_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.
`log_saved_search_id`	(optional) OCID of the LogSavedSearch.
`name`	(optional) Resource name.
`page`	(optional) For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`sort_by`	(optional) The field to sort by (one column only). Default sort order is ascending exception of `timeCreated` and `timeLastModified` columns (descending). Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, whether 'asc' or '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://logging.{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_LOGS Function

Lists the specified log group's log objects.

Syntax

FUNCTION list_logs (
  log_group_id varchar2,
  log_type varchar2 DEFAULT NULL,
  source_service varchar2 DEFAULT NULL,
  source_resource varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state 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_log_logging_management_list_logs_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`log_type`	(optional) The logType that the log object is for, whether custom or service. Allowed values are: 'CUSTOM', 'SERVICE'
`source_service`	(optional) Service that created the log object, which is a field of LogSummary.Configuration.Source.
`source_resource`	(optional) Log object resource, which is a field of LogSummary.Configuration.Source.
`display_name`	(optional) Resource name.
`lifecycle_state`	(optional) Lifecycle state of the log object Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'INACTIVE', 'DELETING', 'FAILED'
`page`	(optional) For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`sort_by`	(optional) The field to sort by (one column only). Default sort order is ascending exception of `timeCreated` and `timeLastModified` columns (descending). Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, whether 'asc' or '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://logging.{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_SERVICES Function

Lists all services that support logging.

Syntax

FUNCTION list_services (
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_log_logging_management_list_services_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.
`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://logging.{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_UNIFIED_AGENT_CONFIGURATIONS Function

Lists all unified agent configurations in the specified compartment.

Syntax

FUNCTION list_unified_agent_configurations (
  compartment_id varchar2,
  log_id varchar2 DEFAULT NULL,
  is_compartment_id_in_subtree number DEFAULT NULL,
  group_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state 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_log_logging_management_list_unified_agent_configurations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.
`log_id`	(optional) Custom log OCID to list resources with the log as destination.
`is_compartment_id_in_subtree`	(optional) Specifies whether or not nested compartments should be traversed. Defaults to false.
`group_id`	(optional) The OCID of a group or a dynamic group.
`display_name`	(optional) Resource name.
`lifecycle_state`	(optional) Lifecycle state of the log object Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'INACTIVE', 'DELETING', 'FAILED'
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_by`	(optional) The field to sort by (one column only). Default sort order is ascending exception of `timeCreated` and `timeLastModified` columns (descending). Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, whether 'asc' or '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://logging.{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 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,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_log_logging_management_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The asynchronous request ID.
`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` or `opc-previous-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`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://logging.{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 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,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_log_logging_management_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The asynchronous request ID.
`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` or `opc-previous-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`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://logging.{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.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  status varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number 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_log_logging_management_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.
`status`	(optional) Filter results by work request status. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELLING', 'CANCELED'
`id`	(optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.
`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` or `opc-previous-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`sort_order`	(optional) The sort order to use, whether 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Allowed values are: 'operationType', 'status', '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://logging.{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_LOG Function

Updates the existing log object with the associated configuration. This call fails if the log object does not exist.

Syntax

FUNCTION update_log (
  log_group_id varchar2,
  log_id varchar2,
  update_log_details dbms_cloud_oci_logging_update_log_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_log_logging_management_update_log_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`log_id`	(required) OCID of a log to work with.
`update_log_details`	(required) Log config parameters to update.
`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_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://logging.{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_LOG_GROUP Function

Updates the existing log group with the associated configuration. This call fails if the log group does not exist.

Syntax

FUNCTION update_log_group (
  log_group_id varchar2,
  update_log_group_details dbms_cloud_oci_logging_update_log_group_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_log_logging_management_update_log_group_response_t;

Parameters

Parameter	Description
`log_group_id`	(required) OCID of a log group to work with.
`update_log_group_details`	(required) LogGroup config parameters to update.
`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_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://logging.{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_LOG_SAVED_SEARCH Function

Updates an existing LogSavedSearch.

Syntax

FUNCTION update_log_saved_search (
  log_saved_search_id varchar2,
  update_log_saved_search_details dbms_cloud_oci_logging_update_log_saved_search_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_log_logging_management_update_log_saved_search_response_t;

Parameters

Parameter	Description
`log_saved_search_id`	(required) OCID of the logSavedSearch.
`update_log_saved_search_details`	(required) Updates to the saved search.
`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_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://logging.{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_UNIFIED_AGENT_CONFIGURATION Function

Update an existing unified agent configuration. This call fails if the log group does not exist.

Syntax

FUNCTION update_unified_agent_configuration (
  unified_agent_configuration_id varchar2,
  update_unified_agent_configuration_details dbms_cloud_oci_logging_update_unified_agent_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_log_logging_management_update_unified_agent_configuration_response_t;

Parameters

Parameter	Description
`unified_agent_configuration_id`	(required) The OCID of the Unified Agent configuration.
`update_unified_agent_configuration_details`	(required) Unified agent configuration to update. Empty group associations list doesn't modify the list, null value for group association clears all the previous associations.
`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_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://logging.{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