LoggingManagementClient

class oci.logging.LoggingManagementClient(config, **kwargs)

Use the Logging Management API to create, read, list, update, and delete log groups, log objects, and agent configurations.

Methods

__init__(config, **kwargs) Creates a new service client
change_log_group_compartment(log_group_id, …) Moves a log group into a different compartment within the same tenancy.
change_log_log_group(log_group_id, log_id, …) Moves a log into a different log group within the same tenancy.
change_log_saved_search_compartment(…) Moves a saved search into a different compartment within the same tenancy.
change_unified_agent_configuration_compartment(…) Moves the unified agent configuration into a different compartment within the same tenancy.
create_log(log_group_id, create_log_details, …) Creates a log within the specified log group.
create_log_group(create_log_group_details, …) Create a new log group with a unique display name.
create_log_saved_search(…) Creates a new LogSavedSearch.
create_unified_agent_configuration(…) Create unified agent configuration registration.
delete_log(log_group_id, log_id, **kwargs) Deletes the log object in a log group.
delete_log_group(log_group_id, **kwargs) Deletes the specified log group.
delete_log_saved_search(log_saved_search_id, …) Deletes the specified log saved search.
delete_unified_agent_configuration(…) Delete unified agent configuration.
delete_work_request(work_request_id, **kwargs) Cancel a work request that has not started yet.
get_log(log_group_id, log_id, **kwargs) Gets the log object configuration for the log object OCID.
get_log_group(log_group_id, **kwargs) Get the specified log group’s information.
get_log_included_search(compartment_id, …) Retrieves a LogIncludedSearch.
get_log_saved_search(log_saved_search_id, …) Retrieves a log saved search.
get_unified_agent_configuration(…) Get the unified agent configuration for an ID.
get_work_request(work_request_id, **kwargs) Gets the details of the work request with the given ID.
list_log_groups(compartment_id, **kwargs) Lists all log groups for the specified compartment or tenancy.
list_log_included_searches(compartment_id, …) Lists Logging Included Searches for this compartment.
list_log_saved_searches(compartment_id, **kwargs) Lists Logging Saved Searches for this compartment.
list_logs(log_group_id, **kwargs) Lists the specified log group’s log objects.
list_services(**kwargs) Lists all services that support logging.
list_unified_agent_configurations(…) Lists all unified agent configurations in the specified compartment.
list_work_request_errors(work_request_id, …) Return a list of errors for a given work request.
list_work_request_logs(work_request_id, **kwargs) Return a list of logs for a given work request.
list_work_requests(compartment_id, **kwargs) Lists the work requests in a compartment.
update_log(log_group_id, log_id, …) Updates the existing log object with the associated configuration.
update_log_group(log_group_id, …) Updates the existing log group with the associated configuration.
update_log_saved_search(log_saved_search_id, …) Updates an existing log saved search.
update_unified_agent_configuration(…) Update an existing unified agent configuration.
__init__(config, **kwargs)

Creates a new service client

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

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

change_log_group_compartment(log_group_id, change_log_group_compartment_details, **kwargs)

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.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • change_log_group_compartment_details (oci.logging.models.ChangeLogGroupCompartmentDetails) – (required) Request to change the compartment of a given resource.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

change_log_log_group(log_group_id, log_id, change_log_log_group_details, **kwargs)

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.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • log_id (str) – (required) OCID of a log to work with.
  • change_log_log_group_details (oci.logging.models.ChangeLogLogGroupDetails) – (required) Request to change the log group of a given log.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

change_log_saved_search_compartment(log_saved_search_id, change_log_saved_search_compartment_details, **kwargs)

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.

Parameters:
  • log_saved_search_id (str) – (required) OCID of the logSavedSearch
  • change_log_saved_search_compartment_details (oci.logging.models.ChangeLogSavedSearchCompartmentDetails) – (required) Contains details indicating which compartment the resource should move to.
  • opc_retry_token (str) – (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 (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

change_unified_agent_configuration_compartment(unified_agent_configuration_id, change_unified_agent_configuration_compartment_details, **kwargs)

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.

Parameters:
  • unified_agent_configuration_id (str) – (required) The OCID of the Unified Agent configuration.
  • change_unified_agent_configuration_compartment_details (oci.logging.models.ChangeUnifiedAgentConfigurationCompartmentDetails) – (required) Request to change the compartment of a given resource.
  • opc_retry_token (str) – (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 (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

create_log(log_group_id, create_log_details, **kwargs)

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.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • create_log_details (oci.logging.models.CreateLogDetails) – (required) Log object configuration details.
  • opc_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

create_log_group(create_log_group_details, **kwargs)

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.

Parameters:
  • create_log_group_details (oci.logging.models.CreateLogGroupDetails) – (required) Details to create log group.
  • opc_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

Creates a new LogSavedSearch.

Parameters:
  • create_log_saved_search_details (oci.logging.models.CreateLogSavedSearchDetails) – (required) Specification of the Saved Search to create
  • opc_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type LogSavedSearch

Return type:

Response

Example:

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

create_unified_agent_configuration(create_unified_agent_configuration_details, **kwargs)

Create unified agent configuration registration.

Parameters:
  • create_unified_agent_configuration_details (oci.logging.models.CreateUnifiedAgentConfigurationDetails) – (required) Unified agent configuration creation object.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request 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).
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

delete_log(log_group_id, log_id, **kwargs)

Deletes the log object in a log group.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • log_id (str) – (required) OCID of a log to work with.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

delete_log_group(log_group_id, **kwargs)

Deletes the specified log group.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

Deletes the specified log saved search.

Parameters:
  • log_saved_search_id (str) – (required) OCID of the logSavedSearch
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

delete_unified_agent_configuration(unified_agent_configuration_id, **kwargs)

Delete unified agent configuration.

Parameters:
  • unified_agent_configuration_id (str) – (required) The OCID of the Unified Agent configuration.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) 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.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

delete_work_request(work_request_id, **kwargs)

Cancel a work request that has not started yet.

Parameters:
  • work_request_id (str) – (required) The asynchronous request ID.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

get_log(log_group_id, log_id, **kwargs)

Gets the log object configuration for the log object OCID.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • log_id (str) – (required) OCID of a log to work with.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Log

Return type:

Response

Example:

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

get_log_group(log_group_id, **kwargs)

Get the specified log group’s information.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type LogGroup

Return type:

Response

Example:

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

Retrieves a LogIncludedSearch.

Parameters:
  • compartment_id (str) –

    (required) Compartment OCID to list resources in. See compartmentIdInSubtree

    for nested compartments traversal.
  • log_included_search_id (str) – (required) OCID of the included search
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type LogIncludedSearch

Return type:

Response

Example:

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

Retrieves a log saved search.

Parameters:
  • log_saved_search_id (str) – (required) OCID of the logSavedSearch
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type LogSavedSearch

Return type:

Response

Example:

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

get_unified_agent_configuration(unified_agent_configuration_id, **kwargs)

Get the unified agent configuration for an ID.

Parameters:
  • unified_agent_configuration_id (str) – (required) The OCID of the Unified Agent configuration.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type UnifiedAgentConfiguration

Return type:

Response

Example:

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

get_work_request(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) – (required) The asynchronous request ID.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

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

list_log_groups(compartment_id, **kwargs)

Lists all log groups for the specified compartment or tenancy.

Parameters:
  • compartment_id (str) –

    (required) Compartment OCID to list resources in. See compartmentIdInSubtree

    for nested compartments traversal.
  • is_compartment_id_in_subtree (bool) – (optional) Specifies whether or not nested compartments should be traversed. Defaults to false.
  • display_name (str) – (optional) Resource name
  • page (str) –

    (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 (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, whether ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

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

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of LogGroupSummary

Return type:

Response

Example:

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

list_log_included_searches(compartment_id, **kwargs)

Lists Logging Included Searches for this compartment.

Parameters:
  • compartment_id (str) –

    (required) Compartment OCID to list resources in. See compartmentIdInSubtree

    for nested compartments traversal.
  • log_included_search_id (str) – (optional) OCID of the LogIncludedSearch
  • display_name (str) – (optional) Resource name
  • page (str) –

    (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 (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, whether ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

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

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type LogIncludedSearchSummaryCollection

Return type:

Response

Example:

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

list_log_saved_searches(compartment_id, **kwargs)

Lists Logging Saved Searches for this compartment.

Parameters:
  • compartment_id (str) –

    (required) Compartment OCID to list resources in. See compartmentIdInSubtree

    for nested compartments traversal.
  • log_saved_search_id (str) – (optional) OCID of the LogSavedSearch
  • name (str) – (optional) Resource name
  • page (str) –

    (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 (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, whether ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

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

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type LogSavedSearchSummaryCollection

Return type:

Response

Example:

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

list_logs(log_group_id, **kwargs)

Lists the specified log group’s log objects.

Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • log_type (str) –

    (optional) The logType that the log object is for, whether custom or service.

    Allowed values are: “CUSTOM”, “SERVICE”

  • source_service (str) – (optional) Service that created the log object.
  • source_resource (str) – (optional) Log object resource.
  • display_name (str) – (optional) Resource name
  • lifecycle_state (str) –

    (optional) Lifecycle state of the log object

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “INACTIVE”, “DELETING”, “FAILED”

  • page (str) –

    (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 (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, whether ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

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

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of LogSummary

Return type:

Response

Example:

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

list_services(**kwargs)

Lists all services that support logging.

Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of ServiceSummary

Return type:

Response

Example:

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

list_unified_agent_configurations(compartment_id, **kwargs)

Lists all unified agent configurations in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) Compartment OCID to list resources in. See compartmentIdInSubtree

    for nested compartments traversal.
  • log_id (str) – (optional) Custom log OCID to list resources with the log as destination.
  • is_compartment_id_in_subtree (bool) – (optional) Specifies whether or not nested compartments should be traversed. Defaults to false.
  • group_id (str) – (optional) The OCID of a group or a dynamic group.
  • display_name (str) – (optional) Resource name
  • lifecycle_state (str) –

    (optional) Lifecycle state of the log object

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “INACTIVE”, “DELETING”, “FAILED”

  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • page (str) –

    (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 (str) –

    (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 (str) –

    (optional) The sort order to use, whether ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

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

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type UnifiedAgentConfigurationCollection

Return type:

Response

Example:

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

list_work_request_errors(work_request_id, **kwargs)

Return a list of errors for a given work request.

Parameters:
  • work_request_id (str) – (required) The asynchronous request ID.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) –

    (optional) For list pagination. The value of the opc-next-page or opc-previous-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

Example:

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

list_work_request_logs(work_request_id, **kwargs)

Return a list of logs for a given work request.

Parameters:
  • work_request_id (str) – (required) The asynchronous request ID.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) –

    (optional) For list pagination. The value of the opc-next-page or opc-previous-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestLog

Return type:

Response

Example:

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

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:
  • compartment_id (str) –

    (required) Compartment OCID to list resources in. See compartmentIdInSubtree

    for nested compartments traversal.
  • status (str) –

    (optional) Filter results by work request status.

    Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELLING”, “CANCELED”

  • id (str) –

    (optional) <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type.

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

    (optional) For list pagination. The value of the opc-next-page or opc-previous-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • sort_order (str) –

    (optional) The sort order to use, whether ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

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

  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestSummary

Return type:

Response

Example:

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

update_log(log_group_id, log_id, update_log_details, **kwargs)
Updates the existing log object with the associated configuration. This call
fails if the log object does not exist.
Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • log_id (str) – (required) OCID of a log to work with.
  • update_log_details (oci.logging.models.UpdateLogDetails) – (required) Log config parameters to update.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

update_log_group(log_group_id, update_log_group_details, **kwargs)
Updates the existing log group with the associated configuration. This call
fails if the log group does not exist.
Parameters:
  • log_group_id (str) – (required) OCID of a log group to work with.
  • update_log_group_details (oci.logging.models.UpdateLogGroupDetails) – (required) LogGroup config parameters to update.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

Updates an existing log saved search.

Parameters:
  • log_saved_search_id (str) – (required) OCID of the logSavedSearch
  • update_log_saved_search_details (oci.logging.models.UpdateLogSavedSearchDetails) – (required) Updates to the saved search.
  • if_match (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type LogSavedSearch

Return type:

Response

Example:

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

update_unified_agent_configuration(unified_agent_configuration_id, update_unified_agent_configuration_details, **kwargs)
Update an existing unified agent configuration. This call
fails if the log group does not exist.
Parameters:
  • unified_agent_configuration_id (str) – (required) The OCID of the Unified Agent configuration.
  • update_unified_agent_configuration_details (oci.logging.models.UpdateUnifiedAgentConfigurationDetails) – (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 (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

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

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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