LogAnalyticsClient

class oci.log_analytics.LogAnalyticsClient(config, **kwargs)

The LogAnalytics API for the LogAnalytics service.

Methods

__init__(config, **kwargs) Creates a new service client
add_entity_association(namespace_name, …) Adds association between input source log analytics entity and one or more existing destination entities.
append_lookup_data(namespace_name, …) Append data to a lookup.
batch_get_basic_info(namespace_name, …) get basic information about a specified set of labels
cancel_query_work_request(namespace_name, …) Cancel/Remove query job work request.
change_log_analytics_entity_compartment(…) Update the compartment of the log analytics entity with the given id.
change_log_analytics_log_group_compartment(…) Updates the compartment of the Log-Analytics group with the given id.
change_log_analytics_object_collection_rule_compartment(…) Move the rule from it’s current compartment to the given compartment.
change_scheduled_task_compartment(…) Move the scheduled task into a different compartment within the same tenancy.
clean(namespace_name, scheduled_task_id, …) Clean accumulated acceleration data stored for the accelerated saved search.
create_log_analytics_entity(namespace_name, …) Create a new log analytics entity.
create_log_analytics_entity_type(…) Add custom log analytics entity type.
create_log_analytics_log_group(…) Creates a new Log-Analytics group.
create_log_analytics_object_collection_rule(…) Creates a rule to collect logs from an object storage bucket.
create_scheduled_task(namespace_name, …) Schedule a task as specified and return task info.
delete_associations(namespace_name, …) delete associations
delete_field(namespace_name, field_name, …) delete field with specified name
delete_label(namespace_name, label_name, …) delete a label
delete_log_analytics_entity(namespace_name, …) Delete log analytics entity with the given id.
delete_log_analytics_entity_type(…) Delete log analytics entity type with the given name.
delete_log_analytics_log_group(…) Deletes the Log-Analytics group with the given id.
delete_log_analytics_object_collection_rule(…) Deletes the configured object storage bucket based collection rule and stop the log collection.
delete_lookup(namespace_name, lookup_name, …) Delete the specified lookup.
delete_parser(namespace_name, parser_name, …) delete parser with specified name
delete_scheduled_task(namespace_name, …) Delete the scheduled task.
delete_source(namespace_name, source_name, …) delete source with specified ID
delete_upload(namespace_name, …) Deletes an Upload by its reference.
delete_upload_file(namespace_name, …) Deletes a specific log file inside an upload by upload file reference.
delete_upload_warning(namespace_name, …) Suppresses a specific warning inside an upload.
disable_archiving(namespace_name, **kwargs) This API disables archiving.
enable_archiving(namespace_name, **kwargs) THis API enables archiving.
estimate_purge_data_size(namespace_name, …) This API estimates the size of data to be purged based based on time interval, purge query etc.
estimate_recall_data_size(namespace_name, …) This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.
estimate_release_data_size(namespace_name, …) This API gives an active storage usage estimate for recalled data to be released and the time range of such data.
export_custom_content(namespace_name, …) export
export_query_result(namespace_name, …) Export data based on query.
extract_structured_log_field_paths(…) structured log fieldpaths
extract_structured_log_header_paths(…) structured log header paths
filter(namespace_name, filter_details, **kwargs) Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.
get_association_summary(namespace_name, …) association summary
get_column_names(namespace_name, sql_query, …) extract column names from SQL query
get_config_work_request(namespace_name, …) association summary by source
get_field(namespace_name, field_name, **kwargs) get common field with specified name
get_fields_summary(namespace_name, **kwargs) get field summary
get_label(namespace_name, label_name, **kwargs) get label with specified name
get_label_summary(namespace_name, **kwargs) get total count
get_log_analytics_entities_summary(…) Returns log analytics entities count summary report.
get_log_analytics_entity(namespace_name, …) Retrieve the log analytics entity with the given id.
get_log_analytics_entity_type(…) Retrieve the log analytics entity type with the given name.
get_log_analytics_log_group(namespace_name, …) Retrieves the Log-Analytics group with the given id.
get_log_analytics_log_groups_summary(…) Returns a count of Log-Analytics groups.
get_log_analytics_object_collection_rule(…) Gets a configured object storage based collection rule by given id
get_lookup(namespace_name, lookup_name, **kwargs) Obtains the lookup with the specified reference.
get_namespace(namespace_name, **kwargs) This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application
get_parser(namespace_name, parser_name, **kwargs) get parser with fields by Name
get_parser_summary(namespace_name, **kwargs) parser summary
get_query_result(namespace_name, …) Returns the intermediate results for a query that was specified to run asynchronously if the query has not completed, otherwise the final query results identified by a queryWorkRequestId returned when submitting the query execute asynchronously.
get_query_work_request(namespace_name, …) Retrieve work request details by workRequestId.
get_scheduled_task(namespace_name, …) Get the scheduled task for the specified task identifier.
get_source(namespace_name, source_name, …) get source with specified name
get_source_summary(namespace_name, **kwargs) source summary
get_storage(namespace_name, **kwargs) This API gets the storage configuration of a tenancy
get_storage_usage(namespace_name, **kwargs) This API gets storage usage information of a tenancy.
get_storage_work_request(work_request_id, …) This API returns work request details specified by {workRequestId}.
get_upload(namespace_name, upload_reference, …) Gets an On-Demand Upload info by reference.
get_work_request(namespace_name, …) Gets the status of the work request with the given ID.
import_custom_content(namespace_name, …) register custom content
list_associated_entities(namespace_name, …) list of entities that have been associated to at least one source
list_config_work_requests(namespace_name, …) association summary by source
list_entity_associations(namespace_name, …) Return a list of log analytics entities associated with input source log analytics entity.
list_entity_source_associations(…) entity associations summary
list_fields(namespace_name, **kwargs) get all common field with specified display name and description
list_label_priorities(namespace_name, **kwargs) get list of priorities
list_label_source_details(namespace_name, …) get details of sources using the label
list_labels(namespace_name, **kwargs) get labels passing specified filter
list_log_analytics_entities(namespace_name, …) Return a list of log analytics entities.
list_log_analytics_entity_types(…) Return a list of log analytics entity types.
list_log_analytics_log_groups(…) Returns a list of Log-Analytics groups.
list_log_analytics_object_collection_rules(…) Gets list of collection rules.
list_lookups(namespace_name, type, **kwargs) Obtains a list of lookups.
list_meta_source_types(namespace_name, **kwargs) get all meta source types
list_namespaces(compartment_id, **kwargs) Given a tenancy OCID, this API returns the namespace of the tenancy if it is valid and subscribed to the region.
list_parser_functions(namespace_name, **kwargs) get pre-process plugin instance
list_parser_meta_plugins(namespace_name, …) get pre-process Meta plugins
list_parsers(namespace_name, **kwargs) List parsers passing specified filter
list_query_work_requests(namespace_name, …) List active asynchronous queries.
list_recalled_data(namespace_name, **kwargs) This API returns the list of recalled data of a tenancy.
list_scheduled_tasks(namespace_name, …) Lists scheduled tasks.
list_source_associations(namespace_name, …) association summary by source
list_source_extended_field_definitions(…) get source extended fields for source with specified Id
list_source_label_operators(namespace_name, …) list source label operators
list_source_meta_functions(namespace_name, …) get source meta functions
list_source_patterns(namespace_name, …) get source patterns for source with specified Id
list_sources(namespace_name, compartment_id, …) source list
list_storage_work_request_errors(…) This API returns the list of work request errors if any.
list_storage_work_requests(compartment_id, …) This API lists storage work requests.
list_supported_char_encodings(…) Gets list of character encodings which are supported by on-demand upload.
list_supported_timezones(namespace_name, …) Gets list of timezones which are supported by on-demand upload.
list_upload_files(namespace_name, …) Gets list of files in an upload along with its processing state.
list_upload_warnings(namespace_name, …) Gets list of warnings in an upload caused by incorrect configuration.
list_uploads(namespace_name, **kwargs) Gets a list of all On-demand uploads.
list_warnings(namespace_name, …) Obtains a list of warnings.
list_work_request_errors(namespace_name, …) Return a (paginated) list of errors for a given work request.
list_work_request_logs(namespace_name, …) Return a (paginated) list of logs for a given work request.
list_work_requests(namespace_name, …) Lists the work requests in a compartment.
offboard_namespace(namespace_name, **kwargs) Off-boards a tenant from Logging Analytics
onboard_namespace(namespace_name, **kwargs) On-boards a tenant to Logging Analytics.
parse_query(namespace_name, …) Describe query
pause_scheduled_task(namespace_name, …) Pause the scheduled task specified by {scheduledTaskId}.
purge_storage_data(namespace_name, …) This API submits a work request to purge data.
put_query_work_request_background(…) Put the work request specified by {workRequestId} into the background.
query(namespace_name, query_details, **kwargs) Performs a log analytics search, if shouldRunAsync is false returns the query results once they become available subject to 60 second timeout.
recall_archived_data(namespace_name, …) This API submits a work request to recall archived data based on time interval and data type.
register_lookup(namespace_name, type, …) register lookup
release_recalled_data(namespace_name, …) This API submits a work request to release recalled data based on time interval and data type.
remove_entity_associations(namespace_name, …) Delete association between input source log analytics entity and destination entities.
resume_scheduled_task(namespace_name, …) Resume the scheduled task specified by {scheduledTaskId}.
run(namespace_name, scheduled_task_id, **kwargs) Execute the saved search acceleration task in the foreground.
suggest(namespace_name, suggest_details, …) Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.
suppress_warning(namespace_name, …) Accepts a list of warnings.
test_parser(namespace_name, …) test parser
unsuppress_warning(namespace_name, …) Accepts a list of warnings.
update_log_analytics_entity(namespace_name, …) Update the log analytics entity with the given id.
update_log_analytics_entity_type(…) Update custom log analytics entity type.
update_log_analytics_log_group(…) Updates the Log-Analytics group with the given id.
update_log_analytics_object_collection_rule(…) Updates configuration of the object collection rule for the given id.
update_lookup(namespace_name, lookup_name, …) Updates the metadata of the specified lookup, such as the lookup description.
update_lookup_data(namespace_name, …) Updates the specified lookup with the details provided.
update_scheduled_task(namespace_name, …) Update the scheduled task.
update_storage(namespace_name, …) This API updates the archiving configuration
upload_log_file(namespace_name, upload_name, …) Accepts log data for processing by Logging Analytics.
upsert_associations(namespace_name, …) create or update associations for a source
upsert_field(namespace_name, …) Defines or update a field.
upsert_label(namespace_name, …) Define or update a label.
upsert_parser(namespace_name, …) Define or update parser
upsert_source(namespace_name, …) Define or update a source
validate_association_parameters(…) association parameter validation
validate_file(namespace_name, …) Validates a log file to check whether it is eligible to be uploaded or not.
validate_source(namespace_name, …) Pre-define or update a source
validate_source_extended_field_details(…) test extended fields
validate_source_mapping(namespace_name, …) Validates the source mapping for a given file and provides match status and the parsed representation of log data.
__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.

add_entity_association(namespace_name, log_analytics_entity_id, add_entity_association_details, **kwargs)

Adds association between input source log analytics entity and one or more existing destination entities.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • add_entity_association_details (oci.log_analytics.models.AddEntityAssociationDetails) – (required) This parameter specifies the destination entity OCIDs with which associations are to be created.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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.
  • 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 add_entity_association API.

append_lookup_data(namespace_name, lookup_name, append_lookup_file_body, **kwargs)

Append data to a lookup. The file containing the information to append must be provided.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • append_lookup_file_body (stream) – (required) The file to append.
  • is_force (bool) – (optional) is force
  • char_encoding (str) – (optional) Character Encoding
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 append_lookup_data API.

batch_get_basic_info(namespace_name, basic_details, is_include_deleted, **kwargs)

get basic information about a specified set of labels

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • basic_details (oci.log_analytics.models.LabelNames) – (required) List of label names to get information on
  • is_include_deleted (bool) – (required) flag for whether or not to include information on deleted labels
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • basic_label_sort_by (str) –

    (optional) sort by label

    Allowed values are: “name”, “priority”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLabelCollection

Return type:

Response

Example:

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

cancel_query_work_request(namespace_name, work_request_id, **kwargs)

Cancel/Remove query job work request.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 cancel_query_work_request API.

change_log_analytics_entity_compartment(namespace_name, log_analytics_entity_id, change_log_analytics_entity_compartment_details, **kwargs)

Update the compartment of the log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • change_log_analytics_entity_compartment_details (oci.log_analytics.models.ChangeLogAnalyticsEntityCompartmentDetails) – (required) Log analytics entity compartment Id to be updated.
  • 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) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 change_log_analytics_entity_compartment API.

change_log_analytics_log_group_compartment(namespace_name, log_analytics_log_group_id, change_log_analytics_log_group_compartment_details, **kwargs)

Updates the compartment of the Log-Analytics group with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • change_log_analytics_log_group_compartment_details (oci.log_analytics.models.ChangeLogAnalyticsLogGroupCompartmentDetails) – (required) The information to be updated.
  • 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) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 change_log_analytics_log_group_compartment API.

change_log_analytics_object_collection_rule_compartment(namespace_name, log_analytics_object_collection_rule_id, change_log_analytics_object_collection_rule_compartment_details, **kwargs)

Move the rule from it’s current compartment to the given compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • change_log_analytics_object_collection_rule_compartment_details (oci.log_analytics.models.ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails) – (required) The new compartment this Object Collection Rule will be moved to.
  • 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) The client request ID for tracing.
  • 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_analytics_object_collection_rule_compartment API.

change_scheduled_task_compartment(namespace_name, scheduled_task_id, change_scheduled_task_compartment_details, **kwargs)

Move the scheduled task into a different compartment within the same tenancy.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • change_scheduled_task_compartment_details (oci.log_analytics.models.ChangeScheduledTaskCompartmentDetails) – (required) The destination compartment identifier.
  • 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) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 change_scheduled_task_compartment API.

clean(namespace_name, scheduled_task_id, **kwargs)

Clean accumulated acceleration data stored for the accelerated saved search. The ScheduledTask taskType must be ACCELERATION.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • time_start (datetime) – (optional) Optional parameter to specify start of time range, in the format defined by RFC3339. Default value is beginning of time.
  • time_end (datetime) – (optional) Optional parameter to specify end of time range, in the format defined by RFC3339. Default value is end of time.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 clean API.

create_log_analytics_entity(namespace_name, create_log_analytics_entity_details, **kwargs)

Create a new log analytics entity.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_entity_details (oci.log_analytics.models.CreateLogAnalyticsEntityDetails) – (required) Details for the new log analytics entity.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsEntity

Return type:

Response

Example:

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

create_log_analytics_entity_type(namespace_name, create_log_analytics_entity_type_details, **kwargs)

Add custom log analytics entity type.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_entity_type_details (oci.log_analytics.models.CreateLogAnalyticsEntityTypeDetails) – (required) Definition for custom log analytics entity type.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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_log_analytics_entity_type API.

create_log_analytics_log_group(namespace_name, create_log_analytics_log_group_details, **kwargs)

Creates a new Log-Analytics group.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_log_group_details (oci.log_analytics.models.CreateLogAnalyticsLogGroupDetails) – (required) Details for the new Log-Analytics 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLogGroup

Return type:

Response

Example:

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

create_log_analytics_object_collection_rule(namespace_name, create_log_analytics_object_collection_rule_details, **kwargs)

Creates a rule to collect logs from an object storage bucket.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_log_analytics_object_collection_rule_details (oci.log_analytics.models.CreateLogAnalyticsObjectCollectionRuleDetails) – (required) Details of the rule to be created.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsObjectCollectionRule

Return type:

Response

Example:

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

create_scheduled_task(namespace_name, create_scheduled_task_details, **kwargs)

Schedule a task as specified and return task info.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • create_scheduled_task_details (oci.log_analytics.models.CreateScheduledTaskDetails) – (required) Scheduled task to be created.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 ScheduledTask

Return type:

Response

Example:

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

delete_associations(namespace_name, delete_log_analytics_association_details, **kwargs)

delete associations

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • delete_log_analytics_association_details (oci.log_analytics.models.DeleteLogAnalyticsAssociationDetails) – (required) details for association
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_associations API.

delete_field(namespace_name, field_name, **kwargs)

delete field with specified name

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • field_name (str) – (required) name of the field to get
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_field API.

delete_label(namespace_name, label_name, **kwargs)

delete a label

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (required) name of the label to get
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_label API.

delete_log_analytics_entity(namespace_name, log_analytics_entity_id, **kwargs)

Delete log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • 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) The client request ID for tracing.
  • 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_analytics_entity API.

delete_log_analytics_entity_type(namespace_name, entity_type_name, **kwargs)

Delete log analytics entity type with the given name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • entity_type_name (str) – (required) Log analytics entity type name.
  • 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) The client request ID for tracing.
  • 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_analytics_entity_type API.

delete_log_analytics_log_group(namespace_name, log_analytics_log_group_id, **kwargs)

Deletes the Log-Analytics group with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • 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) The client request ID for tracing.
  • 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_analytics_log_group API.

delete_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, **kwargs)

Deletes the configured object storage bucket based collection rule and stop the log collection. It will not delete the existing processed data associated with this bucket from logging analytics storage.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_log_analytics_object_collection_rule API.

delete_lookup(namespace_name, lookup_name, **kwargs)

Delete the specified lookup.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • is_force (bool) – (optional) is force
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_lookup API.

delete_parser(namespace_name, parser_name, **kwargs)

delete parser with specified name

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parser_name (str) – (required) parserName
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_parser API.

delete_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Delete the scheduled task.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_scheduled_task API.

delete_source(namespace_name, source_name, **kwargs)

delete source with specified ID

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) source name
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_source API.

delete_upload(namespace_name, upload_reference, **kwargs)

Deletes an Upload by its reference. It deletes all the logs in storage asscoiated with the upload and the corresponding upload metadata.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • 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) The client request ID for tracing.
  • 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_upload API.

delete_upload_file(namespace_name, upload_reference, file_reference, **kwargs)

Deletes a specific log file inside an upload by upload file reference. It deletes all the logs from storage associated with the file and the corresponding metadata.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • file_reference (str) – (required) Unique internal identifier to refer upload file.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_upload_file API.

delete_upload_warning(namespace_name, upload_reference, warning_reference, **kwargs)

Suppresses a specific warning inside an upload.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • warning_reference (str) – (required) Unique internal identifier to refer upload warning.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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_upload_warning API.

disable_archiving(namespace_name, **kwargs)

This API disables archiving.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 Success

Return type:

Response

Example:

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

enable_archiving(namespace_name, **kwargs)

THis API enables archiving.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 Success

Return type:

Response

Example:

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

estimate_purge_data_size(namespace_name, estimate_purge_data_size_details, **kwargs)

This API estimates the size of data to be purged based based on time interval, purge query etc.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • estimate_purge_data_size_details (oci.log_analytics.models.EstimatePurgeDataSizeDetails) – (required) This is the input to estimate the size of data to be purged.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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.
  • 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 EstimatePurgeDataSizeResult

Return type:

Response

Example:

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

estimate_recall_data_size(namespace_name, estimate_recall_data_size_details, **kwargs)

This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • estimate_recall_data_size_details (oci.log_analytics.models.EstimateRecallDataSizeDetails) – (required) This is the input to estimate the size of data to be recalled.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 EstimateRecallDataSizeResult

Return type:

Response

Example:

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

estimate_release_data_size(namespace_name, estimate_release_data_size_details, **kwargs)

This API gives an active storage usage estimate for recalled data to be released and the time range of such data.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • estimate_release_data_size_details (oci.log_analytics.models.EstimateReleaseDataSizeDetails) – (required) This is the input to estimate the size of recalled data to be released.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 EstimateReleaseDataSizeResult

Return type:

Response

Example:

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

export_custom_content(namespace_name, export_custom_content_details, **kwargs)

export

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • export_custom_content_details (oci.log_analytics.models.ExportContent) – (required) content to export
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 stream

Return type:

Response

Example:

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

export_query_result(namespace_name, export_details, **kwargs)

Export data based on query. Endpoint returns a stream of data. Endpoint is synchronous. Queries must deliver first result within 60 seconds or calls are subject to timeout.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • export_details (oci.log_analytics.models.ExportDetails) – (required) Query to be exported
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 stream

Return type:

Response

Example:

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

extract_structured_log_field_paths(namespace_name, logan_parser_details, **kwargs)

structured log fieldpaths

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • logan_parser_details (oci.log_analytics.models.LogAnalyticsParser) – (required) parser definition
  • parser_type (str) –

    (optional) type - possible values are xml or json

    Allowed values are: “XML”, “JSON”

  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ExtractLogFieldResults

Return type:

Response

Example:

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

extract_structured_log_header_paths(namespace_name, logan_parser_details, **kwargs)

structured log header paths

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • logan_parser_details (oci.log_analytics.models.LogAnalyticsParser) – (required) parser definition
  • parser_type (str) –

    (optional) type - possible values are xml or json

    Allowed values are: “XML”, “JSON”

  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ExtractLogHeaderResults

Return type:

Response

Example:

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

filter(namespace_name, filter_details, **kwargs)

Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • filter_details (oci.log_analytics.models.FilterDetails) – (required) Query string and filters to add or remove
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 FilterOutput

Return type:

Response

Example:

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

get_association_summary(namespace_name, compartment_id, **kwargs)

association summary

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 AssociationSummaryReport

Return type:

Response

Example:

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

get_column_names(namespace_name, sql_query, **kwargs)

extract column names from SQL query

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • sql_query (str) – (required) sql query to get the columns
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ColumnNameCollection

Return type:

Response

Example:

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

get_config_work_request(namespace_name, work_request_id, **kwargs)

association summary by source

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsConfigWorkRequest

Return type:

Response

Example:

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

get_field(namespace_name, field_name, **kwargs)

get common field with specified name

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • field_name (str) – (required) name of the field to get
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsField

Return type:

Response

Example:

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

get_fields_summary(namespace_name, **kwargs)

get field summary

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • is_show_detail (bool) – (optional) show detail flag
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 FieldSummaryReport

Return type:

Response

Example:

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

get_label(namespace_name, label_name, **kwargs)

get label with specified name

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (required) name of the label to get
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLabel

Return type:

Response

Example:

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

get_label_summary(namespace_name, **kwargs)

get total count

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LabelSummaryReport

Return type:

Response

Example:

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

get_log_analytics_entities_summary(namespace_name, compartment_id, **kwargs)

Returns log analytics entities count summary report.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsEntitySummaryReport

Return type:

Response

Example:

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

get_log_analytics_entity(namespace_name, log_analytics_entity_id, **kwargs)

Retrieve the log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsEntity

Return type:

Response

Example:

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

get_log_analytics_entity_type(namespace_name, entity_type_name, **kwargs)

Retrieve the log analytics entity type with the given name.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • entity_type_name (str) – (required) Log analytics entity type name.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsEntityType

Return type:

Response

Example:

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

get_log_analytics_log_group(namespace_name, log_analytics_log_group_id, **kwargs)

Retrieves the Log-Analytics group with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLogGroup

Return type:

Response

Example:

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

get_log_analytics_log_groups_summary(namespace_name, compartment_id, **kwargs)

Returns a count of Log-Analytics groups.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogGroupSummaryReport

Return type:

Response

Example:

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

get_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, **kwargs)

Gets a configured object storage based collection rule by given id

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsObjectCollectionRule

Return type:

Response

Example:

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

get_lookup(namespace_name, lookup_name, **kwargs)

Obtains the lookup with the specified reference.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLookup

Return type:

Response

Example:

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

get_namespace(namespace_name, **kwargs)

This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 Namespace

Return type:

Response

Example:

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

get_parser(namespace_name, parser_name, **kwargs)

get parser with fields by Name

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parser_name (str) – (required) parserName
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsParser

Return type:

Response

Example:

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

get_parser_summary(namespace_name, **kwargs)

parser summary

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ParserSummaryReport

Return type:

Response

Example:

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

get_query_result(namespace_name, work_request_id, **kwargs)

Returns the intermediate results for a query that was specified to run asynchronously if the query has not completed, otherwise the final query results identified by a queryWorkRequestId returned when submitting the query execute asynchronously.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) Maximum number of results to return in this request. Note a limit=-1 returns all results from pageId onwards up to maxtotalCount.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • should_include_columns (bool) – (optional) Include columns in response
  • should_include_fields (bool) – (optional) Include fields in response
  • output_mode (str) –

    (optional) Specifies the format for the returned results.

    Allowed values are: “JSON_ROWS”

  • 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 QueryAggregation

Return type:

Response

Example:

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

get_query_work_request(namespace_name, work_request_id, **kwargs)

Retrieve work request details by workRequestId. This endpoint can be polled for status tracking of work request. Clients should poll using the interval returned in the retry-after header.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 QueryWorkRequest

Return type:

Response

Example:

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

get_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Get the scheduled task for the specified task identifier.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ScheduledTask

Return type:

Response

Example:

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

get_source(namespace_name, source_name, compartment_id, **kwargs)

get source with specified name

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) source name
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsSource

Return type:

Response

Example:

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

get_source_summary(namespace_name, **kwargs)

source summary

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 SourceSummaryReport

Return type:

Response

Example:

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

get_storage(namespace_name, **kwargs)

This API gets the storage configuration of a tenancy

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 Storage

Return type:

Response

Example:

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

get_storage_usage(namespace_name, **kwargs)

This API gets storage usage information of a tenancy. Storage usage information includes active, archived or recalled data. The unit of return data is in bytes.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 StorageUsage

Return type:

Response

Example:

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

get_storage_work_request(work_request_id, namespace_name, **kwargs)

This API returns work request details specified by {workRequestId}. This API can be polled for status tracking of work request. Clients should poll using the interval returned in retry-after header.

Parameters:
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 StorageWorkRequest

Return type:

Response

Example:

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

get_upload(namespace_name, upload_reference, **kwargs)

Gets an On-Demand Upload info by reference.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 Upload

Return type:

Response

Example:

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

get_work_request(namespace_name, work_request_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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.

import_custom_content(namespace_name, import_custom_content_file_body, **kwargs)

register custom content

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • import_custom_content_file_body (stream) – (required) The file to upload which contains the custom content.
  • is_overwrite (bool) – (optional) is overwrite
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsImportCustomContent

Return type:

Response

Example:

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

list_associated_entities(namespace_name, compartment_id, **kwargs)

list of entities that have been associated to at least one source

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_id (str) – (optional) The entity OCID.
  • entity_type (str) – (optional) entity type name
  • entity_type_display_name (str) – (optional) entity type display name
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “entityName”, “entityTypeDisplayName”, “associationCount”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsAssociatedEntityCollection

Return type:

Response

Example:

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

list_config_work_requests(namespace_name, compartment_id, **kwargs)

association summary by source

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) work requests sort by

    Allowed values are: “timeAccepted”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous 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 LogAnalyticsConfigWorkRequestCollection

Return type:

Response

Example:

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

list_entity_associations(namespace_name, log_analytics_entity_id, **kwargs)

Return a list of log analytics entities associated with input source log analytics entity.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • direct_or_all_associations (str) –

    (optional) Indicates whether to return direct associated entities or direct and inferred associated entities.

    Allowed values are: “DIRECT”, “ALL”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort entities by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsEntityCollection

Return type:

Response

Example:

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

list_entity_source_associations(namespace_name, compartment_id, **kwargs)

entity associations summary

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_id (str) – (optional) The entity OCID.
  • entity_type (str) – (optional) entity type name
  • entity_type_display_name (str) – (optional) entity type display name
  • life_cycle_state (str) –

    (optional) Status

    Allowed values are: “ALL”, “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”

  • is_show_total (bool) – (optional) is Show Total
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “sourceDisplayName”, “timeLastAttempted”, “status”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsAssociationCollection

Return type:

Response

Example:

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

list_fields(namespace_name, **kwargs)

get all common field with specified display name and description

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • is_match_all (bool) – (optional) isMatchAll
  • source_ids (str) – (optional) comma delimited list of source ids
  • source_names (str) – (optional) comma delimited list of source Names
  • parser_type (str) –

    (optional) parserType

    Allowed values are: “ALL”, “REGEX”, “XML”, “JSON”

  • parser_ids (str) – (optional) comma delimited list of parser ids
  • parser_names (str) – (optional) comma delimited list of parser names
  • is_include_parser (bool) – (optional) isIncludeParser
  • filter (str) – (optional) filter
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “name”, “dataType”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsFieldCollection

Return type:

Response

Example:

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

list_label_priorities(namespace_name, **kwargs)

get list of priorities

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LabelPriorityCollection

Return type:

Response

Example:

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

list_label_source_details(namespace_name, **kwargs)

get details of sources using the label

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (optional) label name
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • label_source_sort_by (str) –

    (optional) sort by source displayname

    Allowed values are: “sourceDisplayName”, “labelFieldDisplayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LabelSourceCollection

Return type:

Response

Example:

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

list_labels(namespace_name, **kwargs)

get labels passing specified filter

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • label_name (str) – (optional) label name
  • label_display_text (str) – (optional) search by label display name or description
  • is_system (str) –

    (optional) Is system param of value (all, custom, sourceUsing)

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • label_priority (str) –

    (optional) label priority

    Allowed values are: “NONE”, “LOW”, “MEDIUM”, “HIGH”

  • is_count_pop (bool) – (optional) isCountPop
  • is_alias_pop (bool) – (optional) isAliasPop
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • label_sort_by (str) –

    (optional) sort by label

    Allowed values are: “name”, “priority”, “sourceUsing”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLabelCollection

Return type:

Response

Example:

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

list_log_analytics_entities(namespace_name, compartment_id, **kwargs)

Return a list of log analytics entities.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • name (str) – (optional) A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.
  • name_contains (str) – (optional) A filter to return only log analytics entities whose name contains the name given. The match is case-insensitive.
  • entity_type_name (list[str]) – (optional) A filter to return only log analytics entities whose entityTypeName matches the entire log analytics entity type name of one of the entityTypeNames given in the list. The match is case-insensitive.
  • cloud_resource_id (str) – (optional) A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.
  • lifecycle_state (str) –

    (optional) A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”, “DELETED”

  • lifecycle_details_contains (str) – (optional) A filter to return only log analytics entities whose lifecycleDetails contains the specified string.
  • is_management_agent_id_null (str) –

    (optional) A filter to return only those log analytics entities whose managementAgentId is null or is not null.

    Allowed values are: “true”, “false”

  • hostname (str) – (optional) A filter to return only log analytics entities whose hostname matches the entire hostname given.
  • hostname_contains (str) – (optional) A filter to return only log analytics entities whose hostname contains the substring given. The match is case-insensitive.
  • source_id (str) – (optional) A filter to return only log analytics entities whose sourceId matches the sourceId given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort entities by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsEntityCollection

Return type:

Response

Example:

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

list_log_analytics_entity_types(namespace_name, **kwargs)

Return a list of log analytics entity types.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • name (str) – (optional) A filter to return only log analytics entity types whose name matches the entire name given. The match is case-insensitive.
  • name_contains (str) – (optional) A filter to return only log analytics entity types whose name or internalName contains name given. The match is case-insensitive.
  • cloud_type (str) –

    (optional) A filter to return CLOUD or NON_CLOUD entity types.

    Allowed values are: “CLOUD”, “NON_CLOUD”

  • lifecycle_state (str) –

    (optional) A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”, “DELETED”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for name is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsEntityTypeCollection

Return type:

Response

Example:

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

list_log_analytics_log_groups(namespace_name, compartment_id, **kwargs)

Returns a list of Log-Analytics groups.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) – (optional) A filter to return only log analytics log groups whose displayName matches the entire display name given. The match is case-insensitive.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLogGroupSummaryCollection

Return type:

Response

Example:

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

list_log_analytics_object_collection_rules(namespace_name, compartment_id, **kwargs)

Gets list of collection rules.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • name (str) – (optional) A filter to return rules only matching with this name.
  • lifecycle_state (str) –

    (optional) Lifecycle state filter.

    Allowed values are: “ACTIVE”, “DELETED”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for name is ascending. If no value is specified timeUpdated is default.

    Allowed values are: “timeUpdated”, “timeCreated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsObjectCollectionRuleCollection

Return type:

Response

Example:

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

list_lookups(namespace_name, type, **kwargs)

Obtains a list of lookups. The list is filtered according to the filter criteria specified by the user, and sorted according to the ordering criteria specified.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • type (str) –

    (required) type - possible values are Lookup or Dictionary

    Allowed values are: “Lookup”, “Dictionary”

  • lookup_display_text (str) – (optional) Search by lookup display name or description.
  • is_system (str) –

    (optional) Is system param of value (all, custom, sourceUsing)

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “displayName”, “status”, “type”, “updatedTime”, “creationType”

  • status (str) –

    (optional) The lookup status used for filtering when fetching a list of lookups.

    Allowed values are: “ALL”, “SUCCESFUL”, “FAILED”, “INPROGRESS”

  • is_hide_special (bool) – (optional) is include items
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLookupCollection

Return type:

Response

Example:

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

list_meta_source_types(namespace_name, **kwargs)

get all meta source types

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “name”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsMetaSourceTypeCollection

Return type:

Response

Example:

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

list_namespaces(compartment_id, **kwargs)

Given a tenancy OCID, this API returns the namespace of the tenancy if it is valid and subscribed to the region. The result also indicates if the tenancy is onboarded with Logging Analytics.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 NamespaceCollection

Return type:

Response

Example:

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

list_parser_functions(namespace_name, **kwargs)

get pre-process plugin instance

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parser_name (str) – (optional) parserName
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “name”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsParserFunctionCollection

Return type:

Response

Example:

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

list_parser_meta_plugins(namespace_name, **kwargs)

get pre-process Meta plugins

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “name”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsParserMetaPluginCollection

Return type:

Response

Example:

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

list_parsers(namespace_name, **kwargs)

List parsers passing specified filter

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • is_match_all (bool) – (optional) isMatchAll
  • source_type (str) –

    (optional) source type

    Allowed values are: “OS_FILE”, “SYSLOG”, “ODL”, “OS_WINDOWS_SYS”

  • parser_name (str) – (optional) parserName
  • parser_display_text (str) – (optional) search by parser display name or description
  • parser_type (str) –

    (optional) parserType

    Allowed values are: “ALL”, “REGEX”, “XML”, “JSON”

  • is_system (str) –

    (optional) Is system param of value (all, custom, sourceUsing)

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) sort by parser

    Allowed values are: “name”, “type”, “sourcesCount”, “timeUpdated”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsParserCollection

Return type:

Response

Example:

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

list_query_work_requests(namespace_name, compartment_id, **kwargs)

List active asynchronous queries.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • mode (str) –

    (optional) Filter based on job execution mode

    Allowed values are: “ALL”, “FOREGROUND”, “BACKGROUND”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeStarted is descending. If no value is specified timeStarted is default.

    Allowed values are: “timeStarted”, “timeExpires”

  • 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 QueryWorkRequestCollection

Return type:

Response

Example:

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

list_recalled_data(namespace_name, **kwargs)

This API returns the list of recalled data of a tenancy.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) This is the query parameter of which field to sort by. Only one sort order may be provided. Default order for timeDataStarted is descending. If no value is specified timeDataStarted is default.

    Allowed values are: “timeStarted”, “timeDataStarted”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • time_data_started_greater_than_or_equal (datetime) – (optional) This is the start of the time range for recalled data
  • time_data_ended_less_than (datetime) – (optional) This is the end of the time range for recalled data
  • 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 RecalledDataCollection

Return type:

Response

Example:

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

list_scheduled_tasks(namespace_name, task_type, compartment_id, **kwargs)

Lists scheduled tasks.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • task_type (str) –

    (required) Required parameter to specify schedule task type.

    Allowed values are: “SAVED_SEARCH”, “ACCELERATION”, “PURGE”, “ACCELERATION_MAINTENANCE”

  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “timeUpdated”, “displayName”

  • 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 ScheduledTaskCollection

Return type:

Response

Example:

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

list_source_associations(namespace_name, source_name, compartment_id, **kwargs)

association summary by source

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) sourceName
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_id (str) – (optional) The entity OCID.
  • life_cycle_state (str) –

    (optional) Status

    Allowed values are: “ALL”, “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”

  • is_show_total (bool) – (optional) is Show Total
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “entityName”, “timeLastAttempted”, “status”

  • 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 LogAnalyticsAssociationCollection

Return type:

Response

Example:

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

list_source_extended_field_definitions(namespace_name, source_name, **kwargs)

get source extended fields for source with specified Id

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) source name
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) sort by source extended field definition

    Allowed values are: “baseFieldName”, “regularExpression”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsSourceExtendedFieldDefinitionCollection

Return type:

Response

Example:

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

list_source_label_operators(namespace_name, **kwargs)

list source label operators

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “name”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLabelOperatorCollection

Return type:

Response

Example:

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

list_source_meta_functions(namespace_name, **kwargs)

get source meta functions

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “name”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsMetaFunctionCollection

Return type:

Response

Example:

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

list_source_patterns(namespace_name, source_name, **kwargs)

get source patterns for source with specified Id

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • source_name (str) – (required) source name
  • is_include (bool) – (optional) is included source patterns
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_by (str) –

    (optional) sort by source pattern text

    Allowed values are: “patternText”

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsSourcePatternCollection

Return type:

Response

Example:

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

list_sources(namespace_name, compartment_id, **kwargs)

source list

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • entity_type (str) – (optional) entityType
  • source_display_text (str) – (optional) Search by source display name or description.
  • is_system (str) –

    (optional) Is system param of value (all, custom, sourceUsing)

    Allowed values are: “ALL”, “CUSTOM”, “BUILT_IN”

  • is_auto_associated (bool) – (optional) auto association flag
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) sort by source

    Allowed values are: “name”, “timeUpdated”, “associationCount”, “sourceType”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • name (str) – (optional) A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.
  • is_simplified (bool) – (optional) is simplified
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsSourceCollection

Return type:

Response

Example:

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

list_storage_work_request_errors(compartment_id, work_request_id, namespace_name, **kwargs)

This API returns the list of work request errors if any.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”

  • 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 WorkRequestErrorCollection

Return type:

Response

Example:

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

list_storage_work_requests(compartment_id, namespace_name, **kwargs)

This API lists storage work requests. Use query parameters to narrow down or sort the result list.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This is the query parameter of which field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default.

    Allowed values are: “timeAccepted”, “timeExpires”, “timeFinished”

  • operation_type (str) –

    (optional) The is the work request type query parameter

    Allowed values are: “OFFBOARD_TENANCY”, “PURGE_STORAGE_DATA”, “RECALL_ARCHIVED_STORAGE_DATA”, “RELEASE_RECALLED_STORAGE_DATA”, “ARCHIVE_STORAGE_DATA”, “CLEANUP_ARCHIVAL_STORAGE_DATA”

  • status (str) –

    (optional) The is the work request status query parameter

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

  • time_started (datetime) – (optional) The is the query parameter of when the processing of work request was started
  • time_finished (datetime) – (optional) The is the query parameter of when the processing of work request was finished
  • policy_name (str) – (optional) This is the query parameter of purge policy name
  • policy_id (str) – (optional) This is the query parameter of purge policy 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 StorageWorkRequestCollection

Return type:

Response

Example:

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

list_supported_char_encodings(namespace_name, **kwargs)

Gets list of character encodings which are supported by on-demand upload.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 CharEncodingCollection

Return type:

Response

Example:

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

list_supported_timezones(namespace_name, **kwargs)

Gets list of timezones which are supported by on-demand upload.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 TimezoneCollection

Return type:

Response

Example:

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

list_upload_files(namespace_name, upload_reference, **kwargs)

Gets list of files in an upload along with its processing state.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeStarted is descending. timeCreated, fileName and logGroup are deprecated. Instead use timestarted, name, logGroup accordingly.

    Allowed values are: “timeStarted”, “name”, “logGroupName”, “sourceName”, “status”, “timeCreated”, “fileName”, “logGroup”

  • search_str (str) – (optional) This can be used to filter upload files based on the file, log group and log source names.
  • status (list[str]) –

    (optional) Upload File processing state.

    Allowed values are: “IN_PROGRESS”, “SUCCESSFUL”, “FAILED”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 UploadFileCollection

Return type:

Response

Example:

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

list_upload_warnings(namespace_name, upload_reference, **kwargs)

Gets list of warnings in an upload caused by incorrect configuration.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_reference (str) – (required) Unique internal identifier to refer upload container.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 UploadWarningCollection

Return type:

Response

Example:

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

list_uploads(namespace_name, **kwargs)

Gets a list of all On-demand uploads. To use this and other API operations, you must be authorized in an IAM policy.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • name (str) – (optional) Name of the upload container.
  • name_contains (str) – (optional) A filter to return only uploads whose name contains the given name.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for name is ascending. If no value is specified timeUpdated is default.

    Allowed values are: “timeUpdated”, “timeCreated”, “name”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 UploadCollection

Return type:

Response

Example:

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

list_warnings(namespace_name, compartment_id, **kwargs)

Obtains a list of warnings. The list is filtered according to the filter criteria specified by the user, and sorted according to the ordering criteria specified.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • warning_state (str) –

    (optional) The warning state used for filtering. A value of SUPPRESSED will return only suppressed warnings, a value of UNSUPPRESSED will return only unsuppressed warnings, and a value of ALL will return all warnings regardless of their suppression state. Default is UNSUPPRESSED.

    Allowed values are: “ALL”, “SUPPRESSED”, “UNSUPPRESSED”

  • source_name (str) – (optional) sourceName
  • source_pattern (str) – (optional) sourcePattern
  • warning_message (str) – (optional) warning message query parameter
  • entity_name (str) – (optional) entityName
  • entity_type (str) – (optional) entity type name
  • warning_type (str) – (optional) The warning type query parameter.
  • is_no_source (bool) – (optional) isNoSource
  • start_time (str) – (optional) The warning start date query parameter.
  • end_time (str) – (optional) The warning end date query parameter.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The attribute used to sort the returned warnings

    Allowed values are: “EntityType”, “SourceName”, “PatternText”, “FirstReported”, “WarningMessage”, “Host”, “EntityName”, “InitialWarningDate”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsWarningCollection

Return type:

Response

Example:

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

list_work_request_errors(namespace_name, work_request_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • 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 WorkRequestErrorCollection

Return type:

Response

Example:

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

list_work_request_logs(namespace_name, work_request_id, **kwargs)

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

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • 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 WorkRequestLogCollection

Return type:

Response

Example:

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

list_work_requests(namespace_name, compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • 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 WorkRequestCollection

Return type:

Response

Example:

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

offboard_namespace(namespace_name, **kwargs)

Off-boards a tenant from Logging Analytics

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 offboard_namespace API.

onboard_namespace(namespace_name, **kwargs)

On-boards a tenant to Logging Analytics.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 onboard_namespace API.

parse_query(namespace_name, parse_query_details, **kwargs)

Describe query

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • parse_query_details (oci.log_analytics.models.ParseQueryDetails) – (required) Query string to be parsed
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ParseQueryOutput

Return type:

Response

Example:

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

pause_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Pause the scheduled task specified by {scheduledTaskId}.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • 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) The client request ID for tracing.
  • 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 ScheduledTask

Return type:

Response

Example:

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

purge_storage_data(namespace_name, purge_storage_data_details, **kwargs)

This API submits a work request to purge data. Only data from log groups that the user has permission to delete will be purged. To purge all data, the user must have permission to all log groups.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • purge_storage_data_details (oci.log_analytics.models.PurgeStorageDataDetails) – (required) This is the input to purge old data.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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.
  • 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 purge_storage_data API.

put_query_work_request_background(namespace_name, work_request_id, **kwargs)

Put the work request specified by {workRequestId} into the background. Backgrounded queries will preserve query results on query completion for up to 7 days for recall. After 7 days the results and query expire.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • work_request_id (str) –

    (required) Work Request Identifier OCID] for the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 QueryWorkRequest

Return type:

Response

Example:

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

query(namespace_name, query_details, **kwargs)

Performs a log analytics search, if shouldRunAsync is false returns the query results once they become available subject to 60 second timeout. If a query is subject to exceed that time then it should be run asynchronously. Asynchronous query submissions return the queryWorkRequestId to use for execution tracking, query submission lifecycle actions and to poll for query results.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • query_details (oci.log_analytics.models.QueryDetails) – (required) Query to be executed.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • limit (int) – (optional) Maximum number of results to return in this request. Note a limit=-1 returns all results from pageId onwards up to maxtotalCount.
  • 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 QueryAggregation

Return type:

Response

Example:

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

recall_archived_data(namespace_name, recall_archived_data_details, **kwargs)

This API submits a work request to recall archived data based on time interval and data type.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • recall_archived_data_details (oci.log_analytics.models.RecallArchivedDataDetails) – (required) This is the input to recall archived data.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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.
  • 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 recall_archived_data API.

register_lookup(namespace_name, type, register_lookup_content_file_body, **kwargs)

register lookup

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • type (str) –

    (required) type - possible values are Lookup or Dictionary

    Allowed values are: “Lookup”, “Dictionary”

  • register_lookup_content_file_body (stream) – (required) file containing data for lookup creation
  • name (str) – (optional) A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.
  • description (str) – (optional) Description of the fields to get
  • char_encoding (str) – (optional) Character Encoding
  • is_hidden (bool) – (optional) is hidden
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLookup

Return type:

Response

Example:

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

release_recalled_data(namespace_name, release_recalled_data_details, **kwargs)

This API submits a work request to release recalled data based on time interval and data type.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • release_recalled_data_details (oci.log_analytics.models.ReleaseRecalledDataDetails) – (required) This is the input to release recalled data
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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.
  • 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 release_recalled_data API.

remove_entity_associations(namespace_name, log_analytics_entity_id, remove_entity_associations_details, **kwargs)

Delete association between input source log analytics entity and destination entities.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • remove_entity_associations_details (oci.log_analytics.models.RemoveEntityAssociationsDetails) – (required) This parameter specifies the entity OCIDs with which associations are to be deleted.
  • 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) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 remove_entity_associations API.

resume_scheduled_task(namespace_name, scheduled_task_id, **kwargs)

Resume the scheduled task specified by {scheduledTaskId}.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • 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) The client request ID for tracing.
  • 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 ScheduledTask

Return type:

Response

Example:

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

run(namespace_name, scheduled_task_id, **kwargs)

Execute the saved search acceleration task in the foreground. The ScheduledTask taskType must be ACCELERATION. Optionally specify time range (timeStart and timeEnd). The default is all time.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • time_start (datetime) – (optional) Optional parameter to specify start of time range, in the format defined by RFC3339. Default value is beginning of time.
  • time_end (datetime) – (optional) Optional parameter to specify end of time range, in the format defined by RFC3339. Default value is end of time.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 run API.

suggest(namespace_name, suggest_details, **kwargs)

Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • suggest_details (oci.log_analytics.models.SuggestDetails) – (required) Query string seeking suggestions for.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 SuggestOutput

Return type:

Response

Example:

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

suppress_warning(namespace_name, warning_reference_details, compartment_id, **kwargs)

Accepts a list of warnings. Any unsuppressed warnings in the input list will be suppressed. Warnings in the input list which are already suppressed will not be modified.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • warning_reference_details (oci.log_analytics.models.WarningReferenceDetails) – (required) list of agent warning references to suppress
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 suppress_warning API.

test_parser(namespace_name, test_parser_payload_details, **kwargs)

test parser

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • test_parser_payload_details (oci.log_analytics.models.TestParserPayloadDetails) – (required) Details for test payload
  • scope (str) –

    (optional) scope

    Allowed values are: “LOG_LINES”, “LOG_ENTRIES”, “LOG_LINES_LOG_ENTRIES”

  • req_origin_module (str) – (optional) module
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ParserTestResult

Return type:

Response

Example:

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

unsuppress_warning(namespace_name, warning_reference_details, compartment_id, **kwargs)

Accepts a list of warnings. Any suppressed warnings in the input list will be unsuppressed. Warnings in the input list which are unsuppressed will not be modified.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • warning_reference_details (oci.log_analytics.models.WarningReferenceDetails) – (required) warnings list
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 unsuppress_warning API.

update_log_analytics_entity(namespace_name, log_analytics_entity_id, update_log_analytics_entity_details, **kwargs)

Update the log analytics entity with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_entity_id (str) – (required) The log analytics entity OCID.
  • update_log_analytics_entity_details (oci.log_analytics.models.UpdateLogAnalyticsEntityDetails) – (required) Log analytics entity information to be updated.
  • 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) The client request ID for tracing.
  • 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 LogAnalyticsEntity

Return type:

Response

Example:

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

update_log_analytics_entity_type(namespace_name, update_log_analytics_entity_type_details, entity_type_name, **kwargs)

Update custom log analytics entity type. Out of box entity types cannot be udpated.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • update_log_analytics_entity_type_details (oci.log_analytics.models.UpdateLogAnalyticsEntityTypeDetails) – (required) Log analytics entity type update details.
  • entity_type_name (str) – (required) Log analytics entity type name.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 update_log_analytics_entity_type API.

update_log_analytics_log_group(namespace_name, log_analytics_log_group_id, update_log_analytics_log_group_details, **kwargs)

Updates the Log-Analytics group with the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_log_group_id (str) – (required) unique logAnalytics log group identifier
  • update_log_analytics_log_group_details (oci.log_analytics.models.UpdateLogAnalyticsLogGroupDetails) – (required) The information to be updated.
  • 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) The client request ID for tracing.
  • 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 LogAnalyticsLogGroup

Return type:

Response

Example:

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

update_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, update_log_analytics_object_collection_rule_details, **kwargs)

Updates configuration of the object collection rule for the given id.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_object_collection_rule_id (str) –

    (required) The Logging Analytics Object Collection Rule OCID.

  • update_log_analytics_object_collection_rule_details (oci.log_analytics.models.UpdateLogAnalyticsObjectCollectionRuleDetails) – (required) The rule config to be updated.
  • 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) The client request ID for tracing.
  • 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 LogAnalyticsObjectCollectionRule

Return type:

Response

Example:

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

update_lookup(namespace_name, lookup_name, update_lookup_metadata_details, **kwargs)

Updates the metadata of the specified lookup, such as the lookup description.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • update_lookup_metadata_details (oci.log_analytics.models.UpdateLookupMetadataDetails) – (required) The information required to update a lookup.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLookup

Return type:

Response

Example:

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

update_lookup_data(namespace_name, lookup_name, update_lookup_file_body, **kwargs)

Updates the specified lookup with the details provided. This API will not update lookup metadata (such as lookup description).

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • lookup_name (str) – (required) The name of the lookup to operate on.
  • update_lookup_file_body (stream) – (required) The file to use for the lookup update.
  • is_force (bool) – (optional) is force
  • char_encoding (str) – (optional) Character Encoding
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 update_lookup_data API.

update_scheduled_task(namespace_name, scheduled_task_id, update_scheduled_task_details, **kwargs)

Update the scheduled task. Schedules may be updated only for taskType SAVED_SEARCH and PURGE.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • scheduled_task_id (str) – (required) Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.
  • update_scheduled_task_details (oci.log_analytics.models.UpdateScheduledTaskDetails) – (required) Update details. Schedules may be updated only for taskType SAVED_SEARCH and PURGE.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ScheduledTask

Return type:

Response

Example:

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

update_storage(namespace_name, update_storage_details, **kwargs)

This API updates the archiving configuration

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • update_storage_details (oci.log_analytics.models.UpdateStorageDetails) – (required) This is the archiving configuration
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 Storage

Return type:

Response

Example:

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

upload_log_file(namespace_name, upload_name, log_source_name, filename, opc_meta_loggrpid, upload_log_file_body, **kwargs)

Accepts log data for processing by Logging Analytics.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upload_name (str) – (required) The name of the upload. This can be considered as a container name where different kind of logs will be collected and searched together. This upload name/id can further be used for retrieving the details of the upload, including its status or deleting the upload.
  • log_source_name (str) – (required) Name of the log source that will be used to process the files being uploaded.
  • filename (str) – (required) The name of the file being uploaded. The extension of the filename part will be used to detect the type of file (like zip, tar).
  • opc_meta_loggrpid (str) – (required) The log group OCID to which the log data in this upload will be mapped to.
  • upload_log_file_body (stream) – (required) Log data
  • entity_id (str) – (optional) The entity OCID.
  • timezone (str) – (optional) Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used
  • char_encoding (str) – (optional) Character encoding to be used to detect the encoding type of file(s) being uploaded. When this property is not specified, system detected character encoding will be used.
  • date_format (str) – (optional) This property is used to specify the format of the date. This is to be used for ambiguous dates like 12/11/10. This property can take any of the following values - MONTH_DAY_YEAR, DAY_MONTH_YEAR, YEAR_MONTH_DAY, MONTH_DAY, DAY_MONTH.
  • date_year (str) – (optional) Used to indicate the year where the log entries timestamp do not mention year (Ex: Nov 8 20:45:56).
  • invalidate_cache (bool) – (optional) This property can be used to reset configuration cache in case of an issue with the upload.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • content_md5 (str) –

    (optional) The base-64 encoded MD5 hash of the body. If the Content-MD5 header is present, Logging Analytics performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the log data is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message:

    ”The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)”

  • content_type (str) – (optional) The content type of the log data.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 Upload

Return type:

Response

Example:

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

upsert_associations(namespace_name, upsert_log_analytics_association_details, **kwargs)

create or update associations for a source

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_association_details (oci.log_analytics.models.UpsertLogAnalyticsAssociationDetails) – (required) list of association details
  • is_from_republish (bool) – (optional) isFromRepublish
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 upsert_associations API.

upsert_field(namespace_name, upsert_log_analytics_field_details, **kwargs)

Defines or update a field.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_field_details (oci.log_analytics.models.UpsertLogAnalyticsFieldDetails) – (required) Details for the new LogAnalyticsFieldDetails.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsField

Return type:

Response

Example:

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

upsert_label(namespace_name, upsert_log_analytics_label_details, **kwargs)

Define or update a label.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_label_details (oci.log_analytics.models.UpsertLogAnalyticsLabelDetails) – (required) Details for the new LogAnalyticsTagDetails.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsLabel

Return type:

Response

Example:

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

upsert_parser(namespace_name, upsert_log_analytics_parser_details, **kwargs)

Define or update parser

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_parser_details (oci.log_analytics.models.UpsertLogAnalyticsParserDetails) – (required) Details for the new LoganParserDetails.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsParser

Return type:

Response

Example:

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

upsert_source(namespace_name, upsert_log_analytics_source_details, **kwargs)

Define or update a source

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_source_details (oci.log_analytics.models.UpsertLogAnalyticsSourceDetails) – (required) Details for the new LoganSourceDetails.
  • create_like_source_id (int) – (optional) create like sourceId
  • is_incremental (bool) – (optional) is incremental
  • is_ignore_warning (bool) – (optional) is ignore warning
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsSource

Return type:

Response

Example:

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

validate_association_parameters(namespace_name, upsert_log_analytics_association_details, **kwargs)

association parameter validation

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_association_details (oci.log_analytics.models.UpsertLogAnalyticsAssociationDetails) – (required) Details for the new log analytics associations.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) sort by field

    Allowed values are: “sourceDisplayName”, “status”

  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 LogAnalyticsAssociationParameterCollection

Return type:

Response

Example:

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

validate_file(namespace_name, object_location, filename, **kwargs)

Validates a log file to check whether it is eligible to be uploaded or not.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • object_location (str) – (required) Location of the log file.
  • filename (str) – (required) The name of the file being uploaded. The extension of the filename part will be used to detect the type of file (like zip, tar).
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 FileValidationResponse

Return type:

Response

Example:

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

validate_source(namespace_name, upsert_log_analytics_source_details, **kwargs)

Pre-define or update a source

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • upsert_log_analytics_source_details (oci.log_analytics.models.UpsertLogAnalyticsSourceDetails) – (required) Details for the new LoganSourceDetails.
  • create_like_source_id (int) – (optional) create like sourceId
  • is_incremental (bool) – (optional) is incremental
  • is_ignore_warning (bool) – (optional) is ignore warning
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 SourceValidateResults

Return type:

Response

Example:

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

validate_source_extended_field_details(namespace_name, log_analytics_source, **kwargs)

test extended fields

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • log_analytics_source (oci.log_analytics.models.LogAnalyticsSource) – (required) Details for the new LogAnalyticsSource.
  • 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. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 ExtendedFieldsValidationResult

Return type:

Response

Example:

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

validate_source_mapping(namespace_name, object_location, filename, log_source_name, **kwargs)

Validates the source mapping for a given file and provides match status and the parsed representation of log data.

Parameters:
  • namespace_name (str) – (required) The Logging Analytics namespace used for the request.
  • object_location (str) – (required) Location of the log file.
  • filename (str) – (required) The name of the file being uploaded. The extension of the filename part will be used to detect the type of file (like zip, tar).
  • log_source_name (str) – (required) Name of the log source that will be used to process the files being uploaded.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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 SourceMappingResponse

Return type:

Response

Example:

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