openapi: 3.2.0
info:
description: 'The LogAnalytics API for the LogAnalytics service.
'
title: Log Analytics API
version: '20200601'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/db21a29f3d8cc25f49231b268a4881bbb85252534de8fe254209cbe42cd8b9e0.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the LogAnalytics API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/db21a29f3d8cc25f49231b268a4881bbb85252534de8fe254209cbe42cd8b9e0.yaml
what: the harvested document for LogAnalytics API
servers:
- url: https://127.0.0.1/20200601
tags:
- name: logAnalytics
paths:
/namespaces:
get:
description: '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 Log Analytics.
'
operationId: ListNamespaces
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentDeleteParam'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NamespaceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Given a tenancy OCID, this API returns the namespace of the tenancy if it is valid and subscribed to the region.
tags:
- logAnalytics
x-obmcs-authz-declarations:
authorizationRequired: false
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Namespace'
/namespaces/{namespaceName}:
get:
description: 'This API gets the namespace details of a tenancy already onboarded in Log Analytics Application
'
operationId: GetNamespace
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Namespace'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gets the namespace details of a tenancy already onboarded in Log Analytics Application
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
/namespaces/{namespaceName}/actions/offboard:
post:
description: Off-boards a tenant from Log Analytics
operationId: OffboardNamespace
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request. The tenant will be deleted from Log Analytics.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Off-boards a tenant from Log Analytics
tags:
- logAnalytics
x-related-resource: '#/definitions/Namespace'
/namespaces/{namespaceName}/actions/onboard:
post:
description: 'On-boards a tenant to Log Analytics.
'
operationId: OnboardNamespace
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The tenant will be on-boarded to Log Analytics.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: On-boards a tenant to Log Analytics
tags:
- logAnalytics
x-related-resource: '#/definitions/Namespace'
/namespaces/{namespaceName}/actions/otlp/v1/logs:
post:
description: 'Accepts log data in OTLP JSON-encoded Protobuf format.
'
operationId: UploadOtlpLogs
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OpcLogGroupHeader'
- $ref: '#/components/parameters/OptionalLogSetHeader'
- $ref: '#/components/parameters/OptionalContentTypeHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/OpcMetaPropertiesHeader'
responses:
200:
description: The data was successfully accepted
headers:
opc-object-id:
description: Unique Oracle-assigned identifier for log data.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
timeCreated:
description: The time the upload was created, in the format defined by RFC3339
schema:
type: string
format: date-time
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: API to ingest log data in OTLP JSON-encoded Protobuf format
tags:
- logAnalytics
x-example: "POST /20200601/namespaces/<namespaceName>/actions/otlp/v1/logs HTTP/1.1\nHost: loganalytics.us-phoenix-1.oraclecloud.com\ndate: Tue, 19 Jan 2021 02:56:35 GMT\ncontent-type: application/octet-stream\ncontent-length: 49\nauthorization: <authorization string>\n{\n \"resourceLogs\": [\n {\n \"resource\": {\n \"attributes\": [\n {\n \"key\": \"resource-attr\",\n \"value\": {\n \"stringValue\": \"resource-attr-val-1\"\n }\n }\n ]\n },\n \"scopeLogs\": [\n {\n \"scope\": {},\n \"logRecords\": [\n {\n \"timeUnixNano\": \"1581452773000000789\",\n \"severityNumber\": 9,\n \"severityText\": \"Info\",\n \"body\": {\n \"stringValue\": \"This is a log message\"\n },\n \"attributes\": [\n {\n \"key\": \"app\",\n \"value\": {\n \"stringValue\": \"server\"\n }\n },\n {\n \"key\": \"instance_num\",\n \"value\": {\n \"intValue\": \"1\"\n }\n }\n ],\n \"droppedAttributesCount\": 1,\n \"traceId\": \"08040201000000000000000000000000\",\n \"spanId\": \"0102040800000000\"\n },\n {\n \"timeUnixNano\": \"1581452773000000789\",\n \"severityNumber\": 9,\n \"severityText\": \"Info\",\n \"body\": {\n \"stringValue\": \"something happened\"\n },\n \"attributes\": [\n {\n \"key\": \"customer\",\n \"value\": {\n \"stringValue\": \"acme\"\n }\n },\n {\n \"key\": \"env\",\n \"value\": {\n \"stringValue\": \"dev\"\n }\n }\n ],\n \"droppedAttributesCount\": 1,\n \"traceId\": \"\",\n \"spanId\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-signing-strategy: exclude_body
x-related-resource: '#/definitions/Upload'
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
application/json:
schema:
format: binary
type: string
description: 'Accepts log data in OTLP JSON-encoded Protobuf format.
Sample format: https://github.com/open-telemetry/opentelemetry-proto/blob/v1.3.1/examples/logs.json
'
required: true
/namespaces/{namespaceName}/actions/setUnprocessedDataBucket:
post:
description: 'This API configures a bucket to store unprocessed payloads.
While processing there could be reasons a payload cannot be processed (mismatched structure, corrupted archive format, etc),
if configured the payload would be uploaded to the bucket for verification.
'
operationId: SetUnprocessedDataBucket
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/BucketNameQueryParam'
- $ref: '#/components/parameters/IsEnabledQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Response object containing represenation of object storage bucket for unprocessed data.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessedDataBucket'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Configure Unprocessed Data Bucket
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/actions/uploadDiscoveryData:
post:
description: 'Accepts discovery data for processing by Log Analytics.
'
operationId: UploadDiscoveryData
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OpcMetaPropertiesHeader'
- $ref: '#/components/parameters/DiscoveryDataTypeQueryParam'
- $ref: '#/components/parameters/OptionalLogGroupQueryParam'
- $ref: '#/components/parameters/PayloadTypeQueryParam'
- $ref: '#/components/parameters/OptionalContentTypeHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The discovery data was successfully accepted
headers:
opc-object-id:
description: Unique Oracle-assigned identifier for log data.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
timeCreated:
description: The time the upload was created, in the format defined by RFC3339
schema:
type: string
format: date-time
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Upload Log Analytics Discovery Data
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-signing-strategy: exclude_body
x-related-resource: '#/definitions/LogAnalyticsEntity'
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: Discovery data
required: true
/namespaces/{namespaceName}/actions/uploadLogEventsFile:
post:
description: 'Accepts log events for processing by Log Analytics.
'
operationId: UploadLogEventsFile
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/LogGroupQueryParam'
- $ref: '#/components/parameters/LogSetQueryParam'
- $ref: '#/components/parameters/PayloadTypeQueryParam'
- $ref: '#/components/parameters/OptionalContentTypeHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/OpcMetaPropertiesHeader'
responses:
200:
description: The log events data was successfully accepted
headers:
opc-object-id:
description: Unique Oracle-assigned identifier for log data.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
timeCreated:
description: The time the upload was created, in the format defined by RFC3339
schema:
type: string
format: date-time
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create Log Analytics Log Events Upload
tags:
- logAnalytics
x-example: "(without logSet) POST /20200601/namespaces/<namespaceName>/actions/uploadLogEventsFile?logGroupId=<logGroup_OCID>&payloadType=<JSON> HTTP/1.1\n(with logSet) POST /20200601/namespaces/<namespaceName>/actions/uploadLogEventsFile?logGroupId=<logGroup_OCID>&logSet=<logSet>&payloadType=<JSON> HTTP/1.1\nHost: loganalytics.us-phoenix-1.oraclecloud.com\ndate: Tue, 19 Jan 2021 02:56:35 GMT\ncontent-type: application/octet-stream\ncontent-length: 49\nauthorization: <authorization string>\n{\n \"metadata\": {\n \"Environment\": \"prod\",\n \"Client Host Region\": \"IST\"\n },\n \"logEvents\": [\n {\n \"metadata\": {\n \"Environment\": \"dev\"\n },\n \"entityType\": \"Host (Linux)\",\n \"entityId\": \"ocid1.loganalyticsentity.oc1.phx.amaaaaaa...\",\n \"logSourceName\": \"Linux Syslog Logs\",\n \"logPath\": \"/var/log/messages\",\n \"logRecords\": [\n \"Jan 18 2021 04:02:37 hostname syslogd 1.4.1: restart.\",\n \"Jan 18 2021 04:02:36 hostname syslogd 1.4.1: shutdown.\"\n ]\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-signing-strategy: exclude_body
x-related-resource: '#/definitions/Upload'
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: "Log events data to be uploaded. The data could be uploaded with or without logSet information depending on whether logSet is enabled for the tenancy or not. Supported formats include\n1. json file : logSet (if needed) should be sent as \"logSet\" query parameter\n2. gzip file : logSet (if needed) should be sent as \"logSet\" query parameter\n3. zip file : containing multiple json files. LogSet information (if needed) should be appended to every filename in the zip.\n Supported filename format with logSet detail is <filename>_logSet=<logset>.json\n"
required: true
/namespaces/{namespaceName}/actions/uploadLogFile:
post:
description: 'Accepts log data for processing by Log Analytics.
'
operationId: UploadLogFile
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadNameQueryParam'
- $ref: '#/components/parameters/LogSourceNameQueryParam'
- $ref: '#/components/parameters/EntityIdQueryParam'
- $ref: '#/components/parameters/TimezoneQueryParam'
- $ref: '#/components/parameters/CharacterEncodingQueryParam'
- $ref: '#/components/parameters/DateFormatQueryParam'
- $ref: '#/components/parameters/DateYearQueryParam'
- $ref: '#/components/parameters/InvalidateCacheQueryParam'
- $ref: '#/components/parameters/FileNameQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OptionalContentMD5Header'
- $ref: '#/components/parameters/OptionalContentTypeHeader'
- $ref: '#/components/parameters/OpcLogGroupHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/LogSetQueryParam'
responses:
200:
description: The log data was successfully accepted
headers:
opc-content-md5:
description: The base-64 encoded MD5 hash of the request body as computed by the server.
schema:
type: string
opc-object-id:
description: Unique Oracle-assigned identifier for log data.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Upload'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create Log Analytics Upload
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-signing-strategy: exclude_body
x-related-resource: '#/definitions/Upload'
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: Log data
required: true
/namespaces/{namespaceName}/associatedEntities:
get:
description: 'Lists the association details of entities in the specified compartment that are associated with at least one source.
'
operationId: ListAssociatedEntities
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNameQueryParam'
- $ref: '#/components/parameters/EntityIdQueryParam'
- $ref: '#/components/parameters/EntityTypeOptionalQueryParam'
- $ref: '#/components/parameters/EntityTypeDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/AssociatedEntitySortByQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The association details were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsAssociatedEntityCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: list of entities with associations
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsAssociation'
/namespaces/{namespaceName}/associationSummary:
get:
description: 'Returns the count of source associations for entities in the specified compartment.
'
operationId: GetAssociationSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The association summary details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/AssociationSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: association summary
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsAssociation'
/namespaces/{namespaceName}/associations/actions/delete:
post:
description: 'Deletes the associations between the sources and entities specified.
'
operationId: DeleteAssociations
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: delete associations
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-request-operation: GetConfigWorkRequest
x-related-resource: '#/definitions/LogAnalyticsAssociation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteLogAnalyticsAssociationDetails'
description: details for association
required: true
/namespaces/{namespaceName}/associations/actions/upsert:
post:
description: 'Creates or updates associations between sources and entities. All entities should belong to the specified input compartment.
'
operationId: UpsertAssociations
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IsFromRepublishQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: create or update associations for a source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-request-operation: GetConfigWorkRequest
x-related-resource: '#/definitions/LogAnalyticsAssociation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertLogAnalyticsAssociationDetails'
description: list of association details
required: true
/namespaces/{namespaceName}/associations/actions/validateParameters:
post:
description: 'Checks if the passed in entities could be associated with the specified sources. The validation is performed to ensure that the entities have the relevant property values that are used in the corresponding source patterns.
'
operationId: ValidateAssociationParameters
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/AssociationParameterSortByQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The source-entity associations were successfully validated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsAssociationParameterCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: association parameter validation
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsAssociation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertLogAnalyticsAssociationDetails'
description: Details for the new log analytics associations.
required: true
/namespaces/{namespaceName}/categories:
get:
description: 'Returns a list of categories, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as category name or description.
'
operationId: ListCategories
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CategoryTypeQueryParam'
- $ref: '#/components/parameters/CategoryDisplayTextQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/CategorySortByQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The categories were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsCategoryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: category list
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsCategory'
/namespaces/{namespaceName}/categories/actions/removeResourceCategories:
post:
description: 'Removes the category assignments of DASHBOARD and SAVEDSEARCH resources.
'
operationId: RemoveResourceCategories
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The resource category assignments were successfully removed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: delete resource categories
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsCategory'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsResourceCategoryDetails'
description: Details for removing the specified category assignments of resources.
required: true
/namespaces/{namespaceName}/categories/actions/updateResourceCategories:
post:
description: 'Updates the category assignments of DASHBOARD and SAVEDSEARCH resources.
'
operationId: UpdateResourceCategories
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The resource category assignments were successfully updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: update resource categories
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsCategory'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsResourceCategoryDetails'
description: Details for updating the specified category assignments of resources.
required: true
/namespaces/{namespaceName}/categories/resourceCategories:
get:
description: 'Returns a list of resources and their category assignments.
You may limit the number of results, provide sorting order, and filter by information such as resource type.
'
operationId: ListResourceCategories
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CategoriesQueryParam'
- $ref: '#/components/parameters/ResourceTypesQueryParam'
- $ref: '#/components/parameters/ResourceIdsQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParamOptional'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ResourceCategoriesSortByQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The category resources were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsResourceCategoryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: category resource list
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsCategory'
/namespaces/{namespaceName}/categories/{categoryName}:
get:
description: 'Gets detailed information about the category with the specified name.
'
operationId: GetCategory
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CategoryNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The category details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsCategory'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get category with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsCategory'
/namespaces/{namespaceName}/configWorkRequests:
get:
description: 'Returns the list of configuration work requests such as association or lookup operations, containing detailed information about them. You may paginate or limit the number of results.
'
operationId: ListConfigWorkRequests
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
responses:
200:
description: The configuration work requests were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsConfigWorkRequestCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: association summary by source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsConfigWorkRequest'
/namespaces/{namespaceName}/configWorkRequests/{workRequestId}:
get:
description: 'Returns detailed information about the configuration work request with the specified id.
'
operationId: GetConfigWorkRequest
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The work request details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsConfigWorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: association summary by source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsConfigWorkRequest'
/namespaces/{namespaceName}/contents/actions/exportCustomContent:
post:
description: 'Exports all custom details of the specified sources, parsers, fields and labels, in zip format.
'
operationId: ExportCustomContent
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The export was successfully completed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/octet-stream:
schema:
format: binary
type: string
application/json:
schema:
format: binary
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: export
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportContent'
description: content to export
required: true
/namespaces/{namespaceName}/contents/actions/importCustomContent:
post:
description: 'Imports the specified custom content from the input in zip format.
'
operationId: ImportCustomContent
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IsOverwriteQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The import was successfully completed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsImportCustomContent'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: register custom content
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: The file to upload which contains the custom content.
required: true
/namespaces/{namespaceName}/effectiveProperties:
get:
description: 'Returns a list of effective properties for the specified resource.
'
operationId: ListEffectiveProperties
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/AgentIdQueryParam'
- $ref: '#/components/parameters/SourceNameQueryParam'
- $ref: '#/components/parameters/IsIncludePatternsQueryParam'
- $ref: '#/components/parameters/EntityIdConfigQueryParam'
- $ref: '#/components/parameters/PatternIdQueryParam'
- $ref: '#/components/parameters/PatternIdLongQueryParam'
- $ref: '#/components/parameters/PropertyNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PropertySortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The effective properties were successfully retrieved.
headers:
opc-next-page:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EffectivePropertyCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a list of effective properties for the specified resource.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsProperty'
/namespaces/{namespaceName}/entityAssociations:
get:
description: 'Returns the list of source associations for the specified entity.
'
operationId: ListEntitySourceAssociations
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNameQueryParam'
- $ref: '#/components/parameters/EntityIdQueryParam'
- $ref: '#/components/parameters/EntityTypeOptionalQueryParam'
- $ref: '#/components/parameters/EntityTypeDisplayNameQueryParam'
- $ref: '#/components/parameters/LogAnalyticsAssociationLifeCycleStateQueryParam'
- $ref: '#/components/parameters/IsShowTotalQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/EntityAssociationSummarySortByQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The associations were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsAssociationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: entity associations summary
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsAssociation'
/namespaces/{namespaceName}/fieldSummary:
get:
description: 'Returns the count of fields. You may optionally specify isShowDetail=true to view a summary of each field data type.
'
operationId: GetFieldsSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IsShowDetailQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The field summary details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FieldSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get field summary
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsField'
/namespaces/{namespaceName}/fields:
get:
description: 'Returns a list of log fields, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by specifying various options including parser and source names.
'
operationId: ListFields
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IsMatchAllQueryParam'
- $ref: '#/components/parameters/SourceIdsQueryParam'
- $ref: '#/components/parameters/SourceNamesQueryParam'
- $ref: '#/components/parameters/ParserTypeQueryParam'
- $ref: '#/components/parameters/ParserIdsQueryParam'
- $ref: '#/components/parameters/ParserNamesQueryParam'
- $ref: '#/components/parameters/IsIncludeParserQueryParam'
- $ref: '#/components/parameters/FilterQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FieldSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The fields were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsFieldCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get all common field with specified display name and description
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsField'
/namespaces/{namespaceName}/fields/actions/upsert:
post:
description: 'Creates or updates a field that could be used in parser expressions to extract and assign value. To create a field, specify its display name. A name would be generated for the field. For subsequent calls to update the field, include the name attribute.
'
operationId: UpsertField
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The field was successfully created or updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsField'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Defines or updates a field.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsField'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertLogAnalyticsFieldDetails'
description: Details for the new LogAnalyticsFieldDetails.
required: true
/namespaces/{namespaceName}/fields/{fieldName}:
delete:
description: 'Deletes field with the specified name.
'
operationId: DeleteField
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/FieldNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The field was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: delete field with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsField'
get:
description: 'Gets detailed information about the field with the specified name.
'
operationId: GetField
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/FieldNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The field details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsField'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get common field with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsField'
/namespaces/{namespaceName}/fields/{fieldName}/usages:
get:
description: 'Gets usage information about the field with the specified name.
'
operationId: GetFieldUsages
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/FieldNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The field usage details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsFieldUsages'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get usages of the common field with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsField'
/namespaces/{namespaceName}/ingestTimeRules:
get:
description: 'Returns a list of ingest time rules in a compartment. You may limit the number of rules, provide sorting options, and filter the results.
'
operationId: ListIngestTimeRules
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RuleDisplayNameQueryParam'
- $ref: '#/components/parameters/RuleLifecycleStateQueryParam'
- $ref: '#/components/parameters/IngestTimeRuleConditionKindQueryParam'
- $ref: '#/components/parameters/IngestTimeRuleFieldNameQueryParam'
- $ref: '#/components/parameters/IngestTimeRuleFieldValueQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The ingest time rules were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/IngestTimeRuleSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all ingest time rules in a compartment.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/IngestTimeRule'
post:
description: 'Creates a new ingest time rule in the specified compartment. You may also specify optional information such as description, defined tags, and free-form tags.
'
operationId: CreateIngestTimeRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The ingest time rule was successfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/IngestTimeRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new ingest time rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/IngestTimeRule'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIngestTimeRuleDetails'
description: Details of the new ingest time rule.
required: true
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}:
delete:
description: 'Deletes the specified ingest time rule.
'
operationId: DeleteIngestTimeRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IngestTimeRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The ingest time rule was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes an ingest time rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/IngestTimeRule'
get:
description: 'Gets detailed information about the specified ingest time rule such as description, defined tags, and free-form tags.
'
operationId: GetIngestTimeRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IngestTimeRuleIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The ingest time rule details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/IngestTimeRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves an ingest time rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/IngestTimeRule'
put:
description: 'Updates the specified ingest time rule''s description, defined tags, and free-form tags.
'
operationId: UpdateIngestTimeRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IngestTimeRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The ingest time rule was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/IngestTimeRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an ingest time rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/IngestTimeRule'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IngestTimeRule'
description: The information to be updated.
required: true
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}/actions/changeCompartment:
post:
description: 'Moves the specified ingest time rule to a different compartment.
'
operationId: ChangeIngestTimeRuleCompartment
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IngestTimeRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The ingest time rule was successfully moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the compartment of an ingest time rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/IngestTimeRule'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeIngestTimeRuleCompartmentDetails'
description: The compartment id to move the ingest time rule to.
required: true
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}/actions/disableIngestTimeRule:
post:
description: 'Disables the specified ingest time rule.
'
operationId: DisableIngestTimeRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IngestTimeRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disable an ingest time rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-request-operation: GetConfigWorkRequest
x-obmcs-terraform:
actionType: DISABLE
identifier: INGEST_TIME_RULE
x-related-resource: '#/definitions/IngestTimeRule'
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}/actions/enableIngestTimeRule:
post:
description: 'Enables the specified ingest time rule.
'
operationId: EnableIngestTimeRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IngestTimeRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enable an ingest time rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-request-operation: GetConfigWorkRequest
x-obmcs-terraform:
actionType: ENABLE
identifier: INGEST_TIME_RULE
x-related-resource: '#/definitions/IngestTimeRule'
/namespaces/{namespaceName}/labelPriorities:
get:
description: 'Lists the available problem priorities that could be associated with a label.
'
operationId: ListLabelPriorities
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The problem priorities were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LabelPriorityCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get list of priorities
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
/namespaces/{namespaceName}/labelSourceDetails:
get:
description: 'Lists sources using the label, along with configuration details like base field, operator and condition.
'
operationId: ListLabelSourceDetails
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LabelNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/LabelSourceSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The label source details were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LabelSourceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get details of sources using the label
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
/namespaces/{namespaceName}/labelSummary:
get:
description: 'Returns the count of labels.
'
operationId: GetLabelSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The label summary details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LabelSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get total count
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
/namespaces/{namespaceName}/labels:
get:
description: 'Returns a list of labels, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as label name, display name, description and priority.
'
operationId: ListLabels
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LabelNameQueryParam'
- $ref: '#/components/parameters/LabelDisplayTextQueryParam'
- $ref: '#/components/parameters/IsSystemQueryParam'
- $ref: '#/components/parameters/LabelPriorityQueryParam'
- $ref: '#/components/parameters/IsCountPopQueryParam'
- $ref: '#/components/parameters/IsAliasPopQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/LabelSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The labels were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsLabelCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get labels passing specified filter
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
/namespaces/{namespaceName}/labels/actions/basicInfo:
post:
description: 'Lists basic information about a specified set of labels in batch.
'
operationId: BatchGetBasicInfo
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IsIncludeDeletedQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/BasicLabelSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The label details were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsLabelCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get basic information about a specified set of labels
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LabelNames'
description: List of label names to get information on
required: true
/namespaces/{namespaceName}/labels/actions/upsert:
post:
description: 'Creates or updates a label that could be used to tag a log entry. You may optionally designate the label as a problem, and assign it a priority. You may also provide its related terms (aliases). To create a label, specify its display name. A name would be generated for the label. For subsequent calls to update the label, include the name attribute.
'
operationId: UpsertLabel
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The label was successfully created or updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLabel'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Define or update a label.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertLogAnalyticsLabelDetails'
description: Details for the new LogAnalyticsTagDetails.
required: true
/namespaces/{namespaceName}/labels/{labelName}:
delete:
description: 'Deletes label with the specified name.
'
operationId: DeleteLabel
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LabelNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The label was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: delete label
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
get:
description: 'Gets detailed information about the label with the specified name.
'
operationId: GetLabel
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LabelNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The label details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsLabel'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get label with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLabel'
/namespaces/{namespaceName}/logAnalyticsEmBridges:
get:
description: Return a list of log analytics enterprise manager bridges.
operationId: ListLogAnalyticsEmBridges
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeDisplayNameQueryParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeLifecycleStateQueryParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeLifecycleDetailsContainsQueryParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeLastImportStatusQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of LogAnalyticsEmBridge objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEmBridgeCollection'
401:
$ref: '#/components/responses/401'
400:
$ref: '#/components/responses/400'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a list of all log analytics enterprise manager bridges.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEmBridge'
post:
description: Add configuration for enterprise manager bridge. Enterprise manager bridge is used to automatically add selected entities from enterprise manager cloud control. A corresponding OCI bridge configuration is required in enterprise manager.
operationId: CreateLogAnalyticsEmBridge
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log analytics enterprise manager bridge is successfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEmBridge'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Add configuration for enterprise manager bridge.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLogAnalyticsEmBridgeDetails'
description: Details for the enterprise manager bridge.
required: true
/namespaces/{namespaceName}/logAnalyticsEmBridges/emBridgeSummary:
get:
description: Returns log analytics enterprise manager bridges summary report.
operationId: GetLogAnalyticsEmBridgeSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
responses:
200:
description: A report of log analytics enterprise manager bridges summary.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEmBridgeSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a summary report of log analytics enterpries manager bridges in a compartment.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEmBridge'
/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}:
delete:
description: Delete log analytics enterprise manager bridge with the given id.
operationId: DeleteLogAnalyticsEmBridge
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- description: If true, delete entities created by this bridge
in: query
name: isDeleteEntities
schema:
type: boolean
default: false
responses:
204:
description: The log analytics entity was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a log analytics enterprise manager bridge.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEmBridge'
get:
description: Retrieve the log analytics enterprise manager bridge with the given id.
operationId: GetLogAnalyticsEmBridge
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log analytics enterprise manager bridge was successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEmBridge'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieve a log analytics enterprise manager bridge.
tags:
- logAnalytics
put:
description: Update log analytics enterprise manager bridge with the given id.
operationId: UpdateLogAnalyticsEmBridge
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log analytics enterprise manager bridge was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEmBridge'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a log analytics enterprise manager bridge.
tags:
- logAnalytics
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLogAnalyticsEmBridgeDetails'
description: Log analytics enterprise manager information to be updated.
required: true
/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}/actions/changeCompartment:
post:
description: Update the compartment of the log analytics enterprise manager bridge with the given id.
operationId: ChangeLogAnalyticsEmBridgeCompartment
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEmBridgeIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The log analytics enterprise manager bridge's compartment was successfully updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the compartment of a log analytics enterprise manager bridge.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsEmBridge'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeLogAnalyticsEmBridgeCompartmentDetails'
description: Log analytics enterprise manager bridge compartment Id to be updated.
required: true
/namespaces/{namespaceName}/logAnalyticsEntities:
get:
description: Return a list of log analytics entities.
operationId: ListLogAnalyticsEntities
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/NameContainsQueryParam'
- $ref: '#/components/parameters/EntityTypeNameQueryParam'
- $ref: '#/components/parameters/CloudResourceIdQueryParam'
- $ref: '#/components/parameters/EntityLifecycleStateQueryParam'
- $ref: '#/components/parameters/EntityLifecycleDetailsContainsQueryParam'
- $ref: '#/components/parameters/IsManagementAgentIdNullQueryParam'
- $ref: '#/components/parameters/HostNameQueryParam'
- $ref: '#/components/parameters/HostNameContainsQueryParam'
- $ref: '#/components/parameters/SourceIdQueryParam'
- $ref: '#/components/parameters/CreationSourceTypeQueryParam'
- $ref: '#/components/parameters/CreationSourceDetailsQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/EntitiesSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/metadataEqualsQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam'
- $ref: '#/components/parameters/IsShowAssociatedSourcesCountQueryParam'
responses:
200:
description: A collection of LogAnalyticsEntitySummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntityCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a list of all log analytics entities in a compartment.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntity'
post:
description: Create a new log analytics entity.
operationId: CreateLogAnalyticsEntity
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log analytics entity is successfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntity'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a new log analytics entity.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLogAnalyticsEntityDetails'
description: Details for the new log analytics entity.
required: true
/namespaces/{namespaceName}/logAnalyticsEntities/entitySummary:
get:
description: Returns log analytics entities count summary report.
operationId: GetLogAnalyticsEntitiesSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
responses:
200:
description: A report of log analytics entities summary.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntitySummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a summary report of log analytics entities in a compartment.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntity'
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}:
delete:
description: Delete log analytics entity with the given id.
operationId: DeleteLogAnalyticsEntity
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IsForceDeleteQueryParam'
responses:
204:
description: The log analytics entity was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a log analytics entity.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntity'
get:
description: Retrieve the log analytics entity with the given id.
operationId: GetLogAnalyticsEntity
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IsShowAssociatedSourcesCountQueryParam'
responses:
200:
description: The log analytics entity was successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntity'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieve a log analytics entity.
tags:
- logAnalytics
put:
description: Update the log analytics entity with the given id.
operationId: UpdateLogAnalyticsEntity
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log analytics entity was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntity'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a log analytics entity.
tags:
- logAnalytics
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLogAnalyticsEntityDetails'
description: Log analytics entity information to be updated.
required: true
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/addEntityAssociations:
post:
description: Adds association between input source log analytics entity and one or more existing destination entities.
operationId: AddEntityAssociation
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The entity associations were successfully added.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Add associations for log analytics entity.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsEntity'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddEntityAssociationDetails'
description: This parameter specifies the destination entity OCIDs with which associations are to be created.
required: true
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/changeCompartment:
post:
description: Update the compartment of the log analytics entity with the given id.
operationId: ChangeLogAnalyticsEntityCompartment
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The log analytics entity's compartment was successfully updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the compartment of a log analytics entity.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsEntity'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeLogAnalyticsEntityCompartmentDetails'
description: Log analytics entity compartment Id to be updated.
required: true
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/removeEntityAssociations:
post:
description: Delete association between input source log analytics entity and destination entities.
operationId: RemoveEntityAssociations
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The entity associations were successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete associations for log analytics entity.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsEntity'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveEntityAssociationsDetails'
description: This parameter specifies the entity OCIDs with which associations are to be deleted.
required: true
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/entityAssociations:
get:
description: Return a list of log analytics entities associated with input source log analytics entity.
operationId: ListEntityAssociations
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/DirectOrAllAssociationsQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/EntitiesSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A collection of associated entities summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntityCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List a collection of entities associated with input source entity.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntity'
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/entityTopology:
get:
description: Return a log analytics entity topology collection that contains a set of log analytics entities and a set of relationships between those, for the input source entity.
operationId: ListLogAnalyticsEntityTopology
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsEntityIdentifierPathParam'
- $ref: '#/components/parameters/EntityLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/EntitiesSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/metadataEqualsQueryParam'
- $ref: '#/components/parameters/ContextQueryParam'
responses:
200:
description: A log analytics entity topology collection that contains a set of log analytics entities and a set of relationships between those.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntityTopologyCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieve a log analytics entity topology collection that contains a set of log analytics entities and a set of relationships between those, for the input source entity.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntitySummary'
/namespaces/{namespaceName}/logAnalyticsEntityTypes:
get:
description: Return a list of log analytics entity types.
operationId: ListLogAnalyticsEntityTypes
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/GetEntityTypeNameQueryParam'
- $ref: '#/components/parameters/GetEntityTypeNameContainsQueryParam'
- $ref: '#/components/parameters/EntityCloudTypeQueryParam'
- $ref: '#/components/parameters/EntityLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/EntityTypeSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of LogAnalyticsEntityTypeSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntityTypeCollection'
401:
$ref: '#/components/responses/401'
400:
$ref: '#/components/responses/400'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a list of all log analytics entity types.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntityType'
post:
description: Add custom log analytics entity type.
operationId: CreateLogAnalyticsEntityType
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Log analytics entity type successfully added.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Add custom log analytics entity type.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsEntityType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLogAnalyticsEntityTypeDetails'
description: Definition for custom log analytics entity type.
required: true
/namespaces/{namespaceName}/logAnalyticsEntityTypes/{entityTypeName}:
delete:
description: Delete log analytics entity type with the given name.
operationId: DeleteLogAnalyticsEntityType
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/EntityTypeNamePathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The entity type has been successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a log analytics entity type.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntityType'
get:
description: Retrieve the log analytics entity type with the given name.
operationId: GetLogAnalyticsEntityType
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/EntityTypeNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The entity type was successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEntityType'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieve details for log analytics entity type.
tags:
- logAnalytics
put:
description: Update custom log analytics entity type. Out of box entity types cannot be udpated.
operationId: UpdateLogAnalyticsEntityType
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/EntityTypeNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: Successfully updated log analytics entity type.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update custom log analytics entity type.
tags:
- logAnalytics
x-related-resource: '#/definitions/LogAnalyticsEntityType'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLogAnalyticsEntityTypeDetails'
description: Log analytics entity type update details.
required: true
/namespaces/{namespaceName}/logAnalyticsLogGroups:
get:
description: 'Returns a list of log groups in a compartment. You may limit the number of log groups, provide sorting options, and filter the results by specifying a display name.
'
operationId: ListLogAnalyticsLogGroups
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log groups were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLogGroupSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all Log-Analytics groups in a compartment.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLogGroup'
post:
description: 'Creates a new log group in the specified compartment with the input display name. You may also specify optional information such as description, defined tags, and free-form tags.
'
operationId: CreateLogAnalyticsLogGroup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log group was successfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLogGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Log-Analytics group.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLogGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLogAnalyticsLogGroupDetails'
description: Details for the new Log-Analytics group.
required: true
/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}:
delete:
description: 'Deletes the specified log group. The log group cannot be part of an active association or have an active upload.
'
operationId: DeleteLogAnalyticsLogGroup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsLogGroupIdParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The log group was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes an Log-Analytics group.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLogGroup'
get:
description: 'Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.
'
operationId: GetLogAnalyticsLogGroup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsLogGroupIdParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log group details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLogGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves an Log-Analytics group.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
put:
description: 'Updates the specified log group''s display name, description, defined tags, and free-form tags.
'
operationId: UpdateLogAnalyticsLogGroup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsLogGroupIdParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log group was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLogGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an Log-Analytics group.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLogAnalyticsLogGroupDetails'
description: The information to be updated.
required: true
/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}/actions/changeCompartment:
post:
description: 'Moves the specified log group to a different compartment.
'
operationId: ChangeLogAnalyticsLogGroupCompartment
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LogAnalyticsLogGroupIdParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The log group was successfully moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the compartment of an Log-Analytics group.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLogGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeLogAnalyticsLogGroupCompartmentDetails'
description: The information to be updated.
required: true
/namespaces/{namespaceName}/logAnalyticsLogGroupsSummary:
get:
description: 'Returns the count of log groups in a compartment.
'
operationId: GetLogAnalyticsLogGroupsSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log groups count was successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogGroupSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a count of all Log-Analytics groups in a compartment.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLogGroup'
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules:
get:
description: Gets list of collection rules.
operationId: ListLogAnalyticsObjectCollectionRules
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ObjectCollectionRuleNameQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/UploadsPaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/UploadsSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of LogAnalyticsObjectCollectionRuleSummary objects
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsObjectCollectionRuleCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Provides list of Log Analytics Object Collection rules.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsObjectCollectionRule'
post:
description: Creates a rule to collect logs from an object storage bucket.
operationId: CreateLogAnalyticsObjectCollectionRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Successfully created the rule.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsObjectCollectionRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a Log Analytics Object Collection Rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLogAnalyticsObjectCollectionRuleDetails'
description: Details of the rule to be created.
required: true
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}:
delete:
description: '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 Log Analytics Storage.
'
operationId: DeleteLogAnalyticsObjectCollectionRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ObjectCollectionRuleIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: No content.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes Log Analytics Object Collection Rule
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/LogAnalyticsObjectCollectionRule'
get:
description: Gets a configured object storage based collection rule by given id
operationId: GetLogAnalyticsObjectCollectionRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ObjectCollectionRuleIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A LogAnalyticsObjectCollectionRule representation of configured rule for log collection.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsObjectCollectionRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get Log Analytics Object Collection Rule
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsObjectCollectionRule'
put:
description: Updates configuration of the object collection rule for the given id.
operationId: UpdateLogAnalyticsObjectCollectionRule
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ObjectCollectionRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The rule is successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsObjectCollectionRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates Log Analytics Object Collection Rule.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLogAnalyticsObjectCollectionRuleDetails'
description: The rule config to be updated.
required: true
? /namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}/actions/changeCompartment
: post:
description: Move the rule from it's current compartment to the given compartment.
operationId: ChangeLogAnalyticsObjectCollectionRuleCompartment
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ObjectCollectionRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The rule is moved successfully to the given compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Move the rule from it's current compartment to the given compartment.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/LogAnalyticsObjectCollectionRule'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails'
description: The new compartment this Object Collection Rule will be moved to.
required: true
/namespaces/{namespaceName}/lookupSummary:
get:
description: Returns the count of user created and oracle defined lookups.
operationId: GetLookupSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParamOptional'
responses:
200:
description: The lookup summary was successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LookupSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a count of all lookups.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLookup'
/namespaces/{namespaceName}/lookups:
get:
description: 'Returns a list of lookups, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as lookup name, description and type.
'
operationId: ListLookups
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LookupDisplayTextQueryParam'
- $ref: '#/components/parameters/LookupTypeQueryParam'
- $ref: '#/components/parameters/IsSystemQueryParam'
- $ref: '#/components/parameters/LookupOrderByQueryParam'
- $ref: '#/components/parameters/LookupStatusQueryParam'
- $ref: '#/components/parameters/CategoriesQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParamOptional'
- $ref: '#/components/parameters/IsHideSpecialQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The lookups were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLookupCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Obtain a list of lookups.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLookup'
/namespaces/{namespaceName}/lookups/actions/register:
post:
description: 'Creates a lookup with the specified name, type and description.
'
operationId: RegisterLookup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/DescriptionQueryParam'
- $ref: '#/components/parameters/CharEncodingQueryParam'
- $ref: '#/components/parameters/IsHiddenQueryParam'
- $ref: '#/components/parameters/LookupTypeQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParamOptional'
responses:
200:
description: The lookup was successfully created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsLookup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: register lookup
tags:
- logAnalytics
x-example: "POST /20200601/namespaces/<namespaceName>/lookups/actions/register?name=Errors&type=Lookup&compartmentId=<compartment_OCID> HTTP/1.1\nHost: loganalytics.us-phoenix-1.oci.oraclecloud.com\ndate: Tue, 08 Oct 2024 16:08:35 GMT\ncontent-type: application/octet-stream\ncontent-length: 301\nauthorization: <authorization string>\n{\n \"content\": \"<Base64 encoded lookup content>\",\n \"freeformTags\": {\n \"Environment\": \"Production\",\n \"Timezone\": \"PST\"\n },\n \"definedTags\": {\n \"OrgTags\": {\n \"CostCenter\": \"42\"\n }\n }\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: "The lookup content to be created, with or without tags. The following formats are supported as binary data:\n 1. If there are no tags: file containing the lookup content.\n 2. If there are tags: JSON file containing the lookup content and tags.\n"
required: true
/namespaces/{namespaceName}/lookups/{lookupName}:
delete:
description: 'Deletes lookup with the specified name.
'
operationId: DeleteLookup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LookupNamePathParam'
- $ref: '#/components/parameters/IsForceQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete the loookup with specified reference.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-request-operation: GetConfigWorkRequest
x-related-resource: '#/definitions/LogAnalyticsLookup'
get:
description: 'Gets detailed information about the lookup with the specified name.
'
operationId: GetLookup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LookupNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The lookup details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLookup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Obtain the lookup with the specified reference.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLookup'
put:
description: 'Updates the metadata of the specified lookup, such as the lookup description.
'
operationId: UpdateLookup
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LookupNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The lookup was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsLookup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update lookup metadata
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLookup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLookupMetadataDetails'
description: The information required to update a lookup.
required: true
/namespaces/{namespaceName}/lookups/{lookupName}/actions/appendData:
post:
description: 'Appends data to the lookup content. The csv file containing the content to be appended is passed in as binary data in the request.
'
operationId: AppendLookupData
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LookupNamePathParam'
- $ref: '#/components/parameters/IsForceQueryParam'
- $ref: '#/components/parameters/CharEncodingQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Append information to a lookup.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-request-operation: GetConfigWorkRequest
x-related-resource: '#/definitions/LogAnalyticsLookup'
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: The file to append.
required: true
/namespaces/{namespaceName}/lookups/{lookupName}/actions/changeCompartment:
post:
description: 'Moves the specified lookup to a different compartment.
'
operationId: ChangeLookupCompartment
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LookupNamePathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The lookup was successfully moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the compartment of a lookup.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsLookup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeLookupCompartmentDetails'
description: The compartment id to move the lookup to.
required: true
/namespaces/{namespaceName}/lookups/{lookupName}/actions/updateData:
post:
description: 'Updates the lookup content. The csv file containing the content to be updated is passed in as binary data in the request.
'
operationId: UpdateLookupData
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/LookupNamePathParam'
- $ref: '#/components/parameters/IsForceQueryParam'
- $ref: '#/components/parameters/CharEncodingQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the lookup with the specified reference.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-operation: GetConfigWorkRequest
x-related-resource: '#/definitions/LogAnalyticsLookup'
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: The file to use for the lookup update.
required: true
/namespaces/{namespaceName}/parserActions:
get:
description: 'Returns a list of parser actions. You may limit the number of results and provide sorting order.
'
operationId: ListParserActions
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ParserActionsNameQueryParam'
- $ref: '#/components/parameters/ParserActionsDisplayTextQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ParserActionsSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The parser actions were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ParserActionSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List parser actions
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
/namespaces/{namespaceName}/parserFunctions:
get:
description: 'Lists the parser functions defined for the specified parser.
'
operationId: ListParserFunctions
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ParserNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/OrderByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The parsers functions were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsParserFunctionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get pre-process plugin instance
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
/namespaces/{namespaceName}/parserMetaPlugins:
get:
description: 'Lists the parser meta plugins available for defining parser functions.
'
operationId: ListParserMetaPlugins
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/OrderByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The parser meta plugins were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsParserMetaPluginCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get pre-process Meta plugins
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
/namespaces/{namespaceName}/parsers:
get:
description: 'Returns a list of parsers, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as parser name, type, display name and description.
'
operationId: ListParsers
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IsMatchAllQueryParam'
- $ref: '#/components/parameters/SourceTypeQueryParam'
- $ref: '#/components/parameters/ParserNameQueryParam'
- $ref: '#/components/parameters/ParsersDisplayTextQueryParam'
- $ref: '#/components/parameters/ParserTypeQueryParam'
- $ref: '#/components/parameters/CategoriesQueryParam'
- $ref: '#/components/parameters/IsSystemQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ParserSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The parsers were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsParserCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List parsers passing specified filter
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
/namespaces/{namespaceName}/parsers/actions/extractLogFieldPaths:
post:
description: 'Extracts the field paths from the example json or xml content.
'
operationId: ExtractStructuredLogFieldPaths
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ExtractParserTypeQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The field paths were successfully extracted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ExtractLogFieldResults'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: structured log fieldpaths
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsParser'
description: parser definition
required: true
/namespaces/{namespaceName}/parsers/actions/extractLogHeaderPaths:
post:
description: 'Extracts the header paths from the example json or xml content.
'
operationId: ExtractStructuredLogHeaderPaths
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ExtractParserTypeQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The header paths were successfully extracted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ExtractLogHeaderResults'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: structured log header paths
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsParser'
description: parser definition
required: true
/namespaces/{namespaceName}/parsers/actions/test:
post:
description: 'Tests the parser definition against the specified example content to ensure fields are successfully extracted.
'
operationId: TestParser
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScopeQueryParam'
- $ref: '#/components/parameters/RequestOriginModuleQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The parser definition was successfully tested against the example content.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ParserTestResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: test parser
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TestParserPayloadDetails'
description: Details for test payload
required: true
/namespaces/{namespaceName}/parsers/actions/upsert:
post:
description: 'Creates or updates a parser, which defines how fields are extracted from a log entry.
'
operationId: UpsertParser
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The parser was successfully created or updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsParser'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Define or update parser
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertLogAnalyticsParserDetails'
description: Details for the new LoganParserDetails.
required: true
/namespaces/{namespaceName}/parsers/{parserName}:
delete:
description: 'Deletes parser with the specified name.
'
operationId: DeleteParser
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ParserNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The parser was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: delete parser with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
get:
description: 'Gets detailed information about the parser with the specified name.
'
operationId: GetParser
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ParserNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The parser details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsParser'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get parser with fields by Name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
/namespaces/{namespaceName}/parsersSummary:
get:
description: 'Returns the count of parsers.
'
operationId: GetParserSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The parser summary details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ParserSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: summary of parsers
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsParser'
/namespaces/{namespaceName}/preferences:
get:
description: 'Lists the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
'
operationId: GetPreferences
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PreferenceSortByQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The tenant preferences were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsPreferenceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get tenant preferences
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsPreference'
/namespaces/{namespaceName}/preferences/actions/removePreferences:
post:
description: 'Removes the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
'
operationId: RemovePreferences
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The tenant preferences were successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Removes the tenant preferences
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsPreference'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsPreferenceDetails'
description: Details of the tenant preferences to delete.
required: true
/namespaces/{namespaceName}/preferences/actions/updatePreferences:
post:
description: 'Updates the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
'
operationId: UpdatePreferences
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The tenant preferences were successfully updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the tenant preferences
tags:
- logAnalytics
x-example: "Example 1: Update default home page\nPOST /20200601/namespaces/<namespaceName>/preferences/actions/updatePreferences HTTP/1.1\nHost: loganalytics.us-phoenix-1.oci.oraclecloud.com\ndate: Tue, 08 Oct 2024 16:08:35 GMT\ncontent-type: application/json\ncontent-length: 67\nauthorization: <authorization string>\n{\n \"items\": [\n {\n \"name\": \"DEFAULT_HOMEPAGE\",\n \"value\": \"OOBD-appmgmt-host\"\n }\n ]\n}\n\nExample 2: Update collection properties at tenant level\nPOST /20200601/namespaces/<namespaceName>/preferences/actions/updatePreferences HTTP/1.1\nHost: loganalytics.us-phoenix-1.oci.oraclecloud.com\ndate: Tue, 08 Oct 2024 16:08:35 GMT\ncontent-type: application/json\ncontent-length: 131\nauthorization: <authorization string>\n{\n \"items\": [\n {\n \"name\": \"management_agent.os_file.timezone\",\n \"value\": \"UTC\"\n },\n {\n \"name\": \"management_agent.rest_api.keep_status_window\",\n \"value\": \"P9D\"\n }\n ]\n}\n\nExample 3: Update collection properties at agent level (prefix property name with \"agent.<Agent OCID>\")\nPOST /20200601/namespaces/<namespaceName>/preferences/actions/updatePreferences HTTP/1.1\nHost: loganalytics.us-phoenix-1.oci.oraclecloud.com\ndate: Tue, 08 Oct 2024 16:08:35 GMT\ncontent-type: application/json\ncontent-length: 328\nauthorization: <authorization string>\n{\n \"items\": [\n {\n \"name\": \"agent.<Agent OCID>.management_agent.os_file.timezone\",\n \"value\": \"UTC\"\n },\n {\n \"name\": \"agent.<Agent OCID>.management_agent.rest_api.filterdups\",\n \"value\": \"false\"\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsPreference'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsPreferenceDetails'
description: Details of the tenant preferences to update.
required: true
/namespaces/{namespaceName}/propertiesMetadata:
get:
description: 'Returns a list of properties along with their metadata.
'
operationId: ListPropertiesMetadata
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PropertyNameQueryParam'
- $ref: '#/components/parameters/PropertyDisplayTextQueryParam'
- $ref: '#/components/parameters/PropertyLevelQueryParam'
- $ref: '#/components/parameters/PropertyConstraintsQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PropertySortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Properties metadata was successfully retrieved.
headers:
opc-next-page:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PropertyMetadataSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get a list of all properties and their metadata.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsProperty'
/namespaces/{namespaceName}/queryWorkRequests:
get:
description: List active asynchronous queries.
operationId: ListQueryWorkRequests
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- description: Filter based on job execution mode
in: query
name: mode
x-obmcs-top-level-enum: '#/definitions/JobModeFilter'
schema:
type: string
enum:
- ALL
- FOREGROUND
- BACKGROUND
default: ALL
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByTimeStartedExpiresQueryParam'
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/QueryWorkRequestCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Returns details about all active asynchronous queries.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryWorkRequest'
/namespaces/{namespaceName}/queryWorkRequests/{workRequestId}:
delete:
description: Cancel/Remove query job work request.
operationId: CancelQueryWorkRequest
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: No Content
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes/Cancels the work request specified by {workRequestId}.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryWorkRequest'
get:
description: 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.
operationId: GetQueryWorkRequest
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/QueryWorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Returns details about the query work request specified by {workRequestId} including its status and query details.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
/namespaces/{namespaceName}/queryWorkRequests/{workRequestId}/actions/background:
put:
description: 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.
operationId: PutQueryWorkRequestBackground
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/QueryWorkRequest'
304:
description: Not Modified
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Put the work request specified by {workRequestId} into the background execution mode.
tags:
- logAnalytics
x-related-resource: '#/definitions/QueryWorkRequest'
/namespaces/{namespaceName}/rules:
get:
description: 'Returns a list of ingest time rules and scheduled tasks in a compartment. You may limit the number of items returned, provide sorting options, and filter the results.
'
operationId: ListRules
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RuleDisplayNameQueryParam'
- $ref: '#/components/parameters/RuleKindQueryParam'
- $ref: '#/components/parameters/TargetServiceQueryParam'
- $ref: '#/components/parameters/RuleLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Log Analytics rules were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RuleSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all ingest time rules and scheduled tasks in a compartment.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Rule'
/namespaces/{namespaceName}/rulesSummary:
get:
description: 'Returns the count of detection rules in a compartment.
'
operationId: GetRulesSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The detection rules count was successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/RuleSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a count of all detection rules in a compartment.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Rule'
/namespaces/{namespaceName}/scheduledTasks:
get:
description: Lists scheduled tasks.
operationId: ListScheduledTasks
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/TaskTypeQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/TemplateIdQueryParam'
- $ref: '#/components/parameters/SavedSearchIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameContainsQueryParam'
- $ref: '#/components/parameters/TargetServiceQueryParam'
responses:
200:
description: Operation succeeded.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledTaskCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List summary information about scheduled tasks.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
post:
description: Schedule a task as specified and return task info.
operationId: CreateScheduledTask
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Operation succeeded.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledTask'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Schedule a task as specified and return task info including the id.
tags:
- logAnalytics
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduledTaskDetails'
description: Scheduled task to be created.
required: true
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}:
delete:
description: Delete the scheduled task.
operationId: DeleteScheduledTask
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete the scheduled task specified by {scheduledTaskId}.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
get:
description: Get the scheduled task for the specified task identifier.
operationId: GetScheduledTask
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operation succeeded.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledTask'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get the scheduled task specified by {scheduledTaskId}.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
put:
description: Update the scheduled task. Schedules may be updated only for taskType SAVED_SEARCH and PURGE.
operationId: UpdateScheduledTask
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/UpdateScheduledTaskDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: Operation succeeded.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledTask'
304:
description: Not Modified
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the scheduled task specified by {scheduledTaskId}.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/changeCompartment:
post:
description: 'Move the scheduled task into a different compartment within the same tenancy.
'
operationId: ChangeScheduledTaskCompartment
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/ChangeScheduledTaskCompartmentDetailsBodyParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: Operation succeeded.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Move the scheduled task specified by {scheduledTaskId} to a different compartment within the same tenancy.
tags:
- logAnalytics
x-related-resource: '#/definitions/ScheduledTask'
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/clean:
post:
description: 'Clean accumulated acceleration data stored for the accelerated saved search.
The ScheduledTask taskType must be ACCELERATION.
'
operationId: Clean
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Operation succeeded.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
204:
description: Operation succeeded.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Clean accumulated acceleration data stored for the accelerated saved search. Optionally specify the time range; the default is all time.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/pause:
post:
description: 'Pause the scheduled task specified by {scheduledTaskId}.
'
operationId: PauseScheduledTask
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operation succeeded.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledTask'
304:
description: Not Modified
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Pause the scheduled task specified by {scheduledTaskId}.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/resume:
post:
description: 'Resume the scheduled task specified by {scheduledTaskId}.
'
operationId: ResumeScheduledTask
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operation succeeded.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduledTask'
304:
description: Not Modified
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Resume the scheduled task specified by {scheduledTaskId}.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/run:
post:
description: '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.
'
operationId: Run
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Operation succeeded.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
204:
description: Operation succeeded.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Immediately execute (in the foreground) the saved search acceleration task. Optionally specify time range (timeStart and timeEnd). The default is all time.
tags:
- logAnalytics
x-related-resource: '#/definitions/ScheduledTask'
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/verify:
post:
description: 'Verify the accelerated saved search task specified by {scheduledTaskId}.
For internal use only.
Optionally specify whether to return accelerated search results; the default is false.
The ScheduledTask taskType must be ACCELERATION.
'
operationId: Verify
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ScheduledTaskIdPathParam'
- $ref: '#/components/parameters/ShouldIncludeResultsQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Operation succeeded.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyOutput'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Verify the accelerated saved search task specified by {scheduledTaskId}. Optionally specify whether to return accelerated search results; the default is false. For internal use only.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ScheduledTask'
/namespaces/{namespaceName}/search/actions/compareContent:
post:
description: 'Returns the difference between the two input payloads, including intraline differences.
'
operationId: CompareContent
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The intraline difference was successfully computed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CompareContentResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Compares two input payloads and returns which lines are different, as well as the intraline differences.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryDetails'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompareContentDetails'
description: The two payloads to be compared.
required: true
/namespaces/{namespaceName}/search/actions/export:
post:
description: 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.
operationId: ExportQueryResult
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/octet-stream:
schema:
format: binary
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Performs a search and streams the query results once they become available.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryDetails'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportDetails'
description: Query to be exported
required: true
/namespaces/{namespaceName}/search/actions/filter:
post:
description: Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.
operationId: Filter
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FilterOutput'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Adds and/or removes one or more filters from the query string and returns updated query string.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryDetails'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FilterDetails'
description: Query string and filters to add or remove
required: true
/namespaces/{namespaceName}/search/actions/parse:
post:
description: Describe query
operationId: ParseQuery
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
'200':
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ParseQueryOutput'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Parses a query and returns a breakdown of the commands used in the query with specific details about each command.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryDetails'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParseQueryDetails'
description: Query string to be parsed
required: true
/namespaces/{namespaceName}/search/actions/query:
get:
description: '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.
'
operationId: GetQueryResult
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/ResultLimitQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- description: Include columns in response
in: query
name: shouldIncludeColumns
schema:
type: boolean
default: true
- description: Include fields in response
in: query
name: shouldIncludeFields
schema:
type: boolean
default: true
- description: Specifies the format for the returned results.
in: query
name: outputMode
schema:
type: string
enum:
- JSON_ROWS
default: JSON_ROWS
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/QueryAggregation'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'Returns the results for a query that was specified to run asynchronously.
'
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryDetails'
post:
description: '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.
'
operationId: Query
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ResultLimitQueryParam'
responses:
200:
description: Operation succeeded
headers:
location:
description: 'URI to entity or work request created.
'
schema:
type: string
opc-next-page-id:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page-id:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/QueryAggregation'
201:
description: Request created
headers:
location:
description: 'URI to entity or work request created.
'
schema:
type: string
opc-next-page-id:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page-id:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/QueryAggregation'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Execute query
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-get-work-request-operation: GetQueryWorkRequest
x-related-resource: '#/definitions/QueryDetails'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryDetails'
description: Query to be executed.
required: true
/namespaces/{namespaceName}/search/actions/suggest:
post:
description: Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.
operationId: Suggest
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestOutput'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Provides typeahead suggestions for a given queryString.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/QueryDetails'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestDetails'
description: Query string seeking suggestions for.
required: true
/namespaces/{namespaceName}/sourceAssociations:
get:
description: 'Returns the list of entity associations in the input compartment for the specified source.
'
operationId: ListSourceAssociations
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequiredSourceNameQueryParam'
- $ref: '#/components/parameters/EntityIdQueryParam'
- $ref: '#/components/parameters/EntityNameQueryParam'
- $ref: '#/components/parameters/LogAnalyticsAssociationLifeCycleStateQueryParam'
- $ref: '#/components/parameters/IsShowTotalQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SourceAssociationSortByQueryParam'
responses:
200:
description: The associations were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsAssociationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: association summary by source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsAssociation'
/namespaces/{namespaceName}/sourceLabelOperators:
get:
description: 'Lists the supported conditional operators that could be used for matching log field values to generate a label. You may use patterns to specify a condition. If a log entry matches that condition, it is tagged with the corresponding label.
'
operationId: ListSourceLabelOperators
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/OrderByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The label operators were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsLabelOperatorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: list source label operators
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sourceMetaFunctions:
get:
description: 'Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields.
'
operationId: ListSourceMetaFunctions
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/OrderByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The source functions were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsMetaFunctionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get source meta functions
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sourceMetaTypes:
get:
description: 'Lists the types of log sources supported.
'
operationId: ListMetaSourceTypes
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/OrderByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log source types were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsMetaSourceTypeCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get all meta source types
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sourceSummary:
get:
description: 'Returns the count of sources.
'
operationId: GetSourceSummary
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The source summary details were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/SourceSummaryReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: summary of sources
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources:
get:
description: 'Returns a list of sources, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as display name, description and entity type.
'
operationId: ListSources
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceEntityTypeQueryParam'
- $ref: '#/components/parameters/SourceDisplayTextQueryParam'
- $ref: '#/components/parameters/IsSystemQueryParam'
- $ref: '#/components/parameters/SourceLifecycleStateQueryParam'
- $ref: '#/components/parameters/AutoAssocQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SourceSortByQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/ListSourceTypeQueryParam'
- $ref: '#/components/parameters/CategoriesQueryParam'
- $ref: '#/components/parameters/PatternTextQueryParam'
- $ref: '#/components/parameters/IsSimplifiedQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The sources were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsSourceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: source list
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources/actions/upsert:
post:
description: 'Creates or updates a log source. You may also specify parsers, labels, extended fields etc., for the source.
'
operationId: UpsertSource
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CreateLikeSourceIdQueryParam'
- $ref: '#/components/parameters/IsIncrementalQueryParam'
- $ref: '#/components/parameters/IsIgnoreWarningQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The source was successfully created or updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsSource'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Define or update a source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertLogAnalyticsSourceDetails'
description: Details for the new LoganSourceDetails.
required: true
/namespaces/{namespaceName}/sources/actions/validate:
post:
description: 'Checks if the specified input is a valid log source definition.
'
operationId: ValidateSource
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CreateLikeSourceIdQueryParam'
- $ref: '#/components/parameters/IsIncrementalQueryParam'
- $ref: '#/components/parameters/IsIgnoreWarningQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The log source definition was successfully validated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SourceValidateResults'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Pre-define or update a source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertLogAnalyticsSourceDetails'
description: Details for the new LoganSourceDetails.
required: true
/namespaces/{namespaceName}/sources/actions/validateEndpoint:
post:
description: 'Validates the REST endpoint configuration.
'
operationId: ValidateEndpoint
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The REST endpoint configuration was validated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateEndpointResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Validate the REST endpoint configuration.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsEndpoint'
description: Details of the REST endpoint configuration to validate.
required: true
/namespaces/{namespaceName}/sources/actions/validateExtendedFields:
post:
description: 'Checks if the specified input contains valid extended field definitions against the provided example content.
'
operationId: ValidateSourceExtendedFieldDetails
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The extended fields were successfully validated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ExtendedFieldsValidationResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: test extended fields
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsSource'
description: Details for the new LogAnalyticsSource.
required: true
/namespaces/{namespaceName}/sources/actions/validateLabelCondition:
post:
description: 'Validates specified condition for a source label. If both conditionString
and conditionBlocks are specified, they would be validated to ensure they represent
identical conditions. If one of them is input, the response would include the validated
representation of the other structure too. Additionally, if field values
are passed, the condition specification would be evaluated against them.
'
operationId: ValidateLabelCondition
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The source label condition was validated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateLabelConditionResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Validate source label condition
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateLabelConditionDetails'
description: Details of source label condition to validate.
required: true
/namespaces/{namespaceName}/sources/sqlColumnNames:
get:
description: 'Extracts column names from the input SQL query.
'
operationId: GetColumnNames
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SqlQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The column names were successfully retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ColumnNameCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: extract column names from SQL query
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources/{sourceName}:
delete:
description: 'Deletes source with the specified name.
'
operationId: DeleteSource
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The source was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: delete source with specified ID
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
get:
description: 'Gets detailed information about the source with the specified name.
'
operationId: GetSource
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The source details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsSource'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get source with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources/{sourceName}/actions/addEventTypes:
post:
description: 'Add one or more event types to a source. An event type and version can be enabled only on one source.
'
operationId: AddSourceEventTypes
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: no content
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Add source event types
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventTypeDetails'
description: 'Details of event types to be added to the source. The specified event type string could be the fully qualified name or a prefix that matches the event type.
'
required: true
/namespaces/{namespaceName}/sources/{sourceName}/actions/disableAutoAssociation:
post:
description: 'Disables auto association for a log source. In the future, this log source would not be automatically
associated with any entity that becomes eligible for association. In addition, you may also optionally
remove all existing associations for this log source.
'
operationId: DisableAutoAssociation
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disable auto association for a log source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableAutoAssociationDetails'
description: Details required to disable auto association for the log source.
required: true
/namespaces/{namespaceName}/sources/{sourceName}/actions/disableEventTypes:
post:
description: 'Disable one or more event types in a source.
'
operationId: DisableSourceEventTypes
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: no content
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disable source event types
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventTypeDetails'
description: Details of event types to be disabled in the source.
required: true
/namespaces/{namespaceName}/sources/{sourceName}/actions/enableAutoAssociation:
post:
description: 'Enables auto association for a log source. This would initiate immediate association of the source
to any eligible entities it is not already associated with, and would also ensure the log source gets
associated with entities that are added or become eligible in the future.
'
operationId: EnableAutoAssociation
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enable auto association for a log source
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableAutoAssociationDetails'
description: Details required to enable auto association for the log source.
required: true
/namespaces/{namespaceName}/sources/{sourceName}/actions/enableEventTypes:
post:
description: 'Enable one or more event types in a source. An event type and version can be enabled only in one source.
'
operationId: EnableSourceEventTypes
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: no content
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enable source event types
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventTypeDetails'
description: Details of event types to be enabled in the source.
required: true
/namespaces/{namespaceName}/sources/{sourceName}/actions/removeEventTypes:
post:
description: 'Remove one or more event types from a source.
'
operationId: RemoveSourceEventTypes
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: no content
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Remove source event types
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventTypeDetails'
description: Details of event types to be removed from the source.
required: true
/namespaces/{namespaceName}/sources/{sourceName}/associableEntities:
get:
description: 'Lists the entities in the specified compartment which are (in)eligible for association with this source.
'
operationId: ListAssociableEntities
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/EntityAssociationTypeQueryParam'
- $ref: '#/components/parameters/EntitySearchTextQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/AssociableEntitySortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The source event types were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/AssociableEntityCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List the entities which are (in)eligible for association with this source.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources/{sourceName}/autoAssociations:
get:
description: 'Gets information related to auto association for the source with the specified name.
'
operationId: ListAutoAssociations
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/AutoAssociationsSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The auto association details of the source were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/AutoAssociationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get auto association information for the source with the specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources/{sourceName}/eventTypes:
get:
description: 'Lists the event types mapped to the source with the specified name. The event type string could be the fully qualified name or a prefix that matches the event type.
'
operationId: ListSourceEventTypes
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/EventTypeDisplayTextQueryParam'
- $ref: '#/components/parameters/IsSystemQueryParam'
- $ref: '#/components/parameters/IsEnabledQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SourceEventTypeSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The event types mapped to the source were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/EventTypeCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List source event types for source with specified name
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources/{sourceName}/extendedFieldDefinitions:
get:
description: 'Lists the extended field definitions for the source with the specified name.
'
operationId: ListSourceExtendedFieldDefinitions
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SourceExtendedFieldDefinitionSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The extended field definitions were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsSourceExtendedFieldDefinitionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get source extended fields for source with specified Id
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/sources/{sourceName}/patterns:
get:
description: 'Lists the source patterns for the source with the specified name.
'
operationId: ListSourcePatterns
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/IsIncludeQueryParam'
- $ref: '#/components/parameters/SourceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SourcePatternSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The source patterns were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsSourcePatternCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get source patterns for source with specified Id
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsSource'
/namespaces/{namespaceName}/storage:
get:
description: 'This API gets the storage configuration of a tenancy
'
operationId: GetStorage
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Storage'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gets the storage configuration of a tenancy
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
put:
description: 'This API updates the archiving configuration
'
operationId: UpdateStorage
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Storage'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API updates the archiving configuration.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateStorageDetails'
description: This is the archiving configuration
required: true
/namespaces/{namespaceName}/storage/actions/assignEncryptionKey:
post:
description: "This API submits a work request to assign customer encryption key. \n"
operationId: AssignEncryptionKey
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
202:
description: Request Accepted.
headers:
location:
description: 'URI to entity or work request created.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API submits a work request to assign customer encryption key.
tags:
- logAnalytics
x-obmcs-get-work-request-operation: GetStorageWorkRequest
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
x-related-resource: '#/definitions/Storage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignEncryptionKeyDetails'
description: This is the input to assign customer encryption key.
required: true
/namespaces/{namespaceName}/storage/actions/disableArchiving:
post:
description: 'This API disables archiving.
'
operationId: DisableArchiving
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Success'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API disables archiving.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: ARCHIVING_TENANT
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/actions/enableArchiving:
post:
description: 'THis API enables archiving.
'
operationId: EnableArchiving
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Success'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API enables archiving.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: ARCHIVING_TENANT
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/actions/estimatePurgeDataSize:
post:
description: 'This API estimates the size of data to be purged based based on time interval, purge query etc.
'
operationId: EstimatePurgeDataSize
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: The successful response returns the estimated purge data size in bytes.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EstimatePurgeDataSizeResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API estimates the size of data to be purged.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EstimatePurgeDataSizeDetails'
description: This is the input to estimate the size of data to be purged.
required: true
/namespaces/{namespaceName}/storage/actions/estimateRecallDataSize:
post:
description: 'This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.
'
operationId: EstimateRecallDataSize
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EstimateRecallDataSizeResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EstimateRecallDataSizeDetails'
description: This is the input to estimate the size of data to be recalled.
required: true
/namespaces/{namespaceName}/storage/actions/estimateReleaseDataSize:
post:
description: 'This API gives an active storage usage estimate for recalled data to be released and the time range of such data.
'
operationId: EstimateReleaseDataSize
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EstimateReleaseDataSizeResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gives an active storage usage estimate for recalled data to be released and the time range of such data.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EstimateReleaseDataSizeDetails'
description: This is the input to estimate the size of recalled data to be released.
required: true
/namespaces/{namespaceName}/storage/actions/purgeData:
post:
description: '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.
'
operationId: PurgeStorageData
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
202:
description: Request Accepted.
headers:
location:
description: 'URI to entity or work request created.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API submits a work request to purge data.
tags:
- logAnalytics
x-obmcs-get-work-request-operation: GetStorageWorkRequest
x-related-resource: '#/definitions/Storage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PurgeStorageDataDetails'
description: This is the input to purge old data.
required: true
/namespaces/{namespaceName}/storage/actions/recallArchivedData:
post:
description: 'This API submits a work request to recall archived data based on time interval and data type.
'
operationId: RecallArchivedData
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
202:
description: Request Accepted.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'URI to entity or work request created.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RecalledDataInfo'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API submits a work request to recall archived data.
tags:
- logAnalytics
x-obmcs-get-work-request-operation: GetStorageWorkRequest
x-related-resource: '#/definitions/Storage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecallArchivedDataDetails'
description: This is the input to recall archived data.
required: true
/namespaces/{namespaceName}/storage/actions/releaseRecalledData:
post:
description: 'This API submits a work request to release recalled data based on time interval and data type.
'
operationId: ReleaseRecalledData
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
202:
description: Request Accepted.
headers:
location:
description: 'URI to entity or work request created.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API submits a work request to release recalled data.
tags:
- logAnalytics
x-obmcs-get-work-request-operation: GetStorageWorkRequest
x-related-resource: '#/definitions/Storage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReleaseRecalledDataDetails'
description: This is the input to release recalled data
required: true
/namespaces/{namespaceName}/storage/encryptionKeyInfo:
get:
description: This API returns the list of customer owned encryption key info.
operationId: ListEncryptionKeyInfo
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EncryptionKeyInfoCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API returns the list of customer owned encryption key info.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/logSets:
get:
description: 'This API returns a list of log sets.
'
operationId: ListLogSets
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- description: 'If this filter is present, each of the logsets returned must contain the value of this filter.
'
in: query
name: logSetNameContains
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
type: string
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogSetCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API returns a list of log sets.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/logSetsCount:
get:
description: 'This API returns the count of distinct log sets.
'
operationId: GetLogSetsCount
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogSetsCount'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API returns the count of distinct log sets.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/overlappingRecalls:
get:
description: 'This API gets the list of overlapping recalls made in the given timeframe
'
operationId: ListOverlappingRecalls
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RecallSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- description: This is the start of the time range for recalled data
in: query
name: timeDataStarted
x-default-description: 'null'
schema:
type: string
format: date-time
- description: This is the end of the time range for recalled data
in: query
name: timeDataEnded
x-default-description: 'null'
schema:
type: string
format: date-time
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OverlappingRecallCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gets the list of overlapping recalls made in the given timeframe.
tags:
- logAnalytics
x-example: 'Example: Get the overlapping recalls for a given timeframe
GET /namespaces/{namespaceName}/storage/overlappingRecalls?timeDataStarted=2017-09-17T20:57:03.109Z&timeDataEnded=2022-10-17T20:57:03.109Z
Host: loganalytics.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/recallCount:
get:
description: 'This API gets the number of recalls made and the maximum recalls that can be made
'
operationId: GetRecallCount
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RecallCount'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gets the number of recalls made.
tags:
- logAnalytics
x-example: 'Example: Get the number of recalls made and the maximum recalls
GET /namespaces/{namespaceName}/storage/recallCount
Host: loganalytics.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/recalledData:
get:
description: 'This API returns the list of recalled data of a tenancy.
'
operationId: ListRecalledData
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RecallSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- description: This is the start of the time range for recalled data
in: query
name: timeDataStartedGreaterThanOrEqual
x-default-description: 'null'
schema:
type: string
format: date-time
- description: This is the end of the time range for recalled data
in: query
name: timeDataEndedLessThan
x-default-description: 'null'
schema:
type: string
format: date-time
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RecalledDataCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API returns the list of recalled data of a tenancy.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/recalledDataSize:
get:
description: 'This API gets the datasize of recalls for a given timeframe
'
operationId: GetRecalledDataSize
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
- description: This is the start of the time range for recalled data
in: query
name: timeDataStarted
x-default-description: 'null'
schema:
type: string
format: date-time
- description: This is the end of the time range for recalled data
in: query
name: timeDataEnded
x-default-description: 'null'
schema:
type: string
format: date-time
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RecalledDataSize'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gets the datasize of recalls for a given timeframe
tags:
- logAnalytics
x-example: 'Example: Get the recalled data size for the given timeframe
GET /namespaces/{namespaceName}/storage/recalledDataSize?timeDataStarted=2020-09-17T20:57:03.109Z&timeDataEnded=2020-10-17T20:57:03.109Z
Host: loganalytics.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/recalledInfoCollection:
get:
description: 'This API returns the list of recalled data of a tenancy.
'
operationId: ListRecalledInfo
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RecallSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/TimeDataStartedGreaterThanOrEqualQueryParam'
- $ref: '#/components/parameters/TimeDataEndedLessThanQueryParam'
- $ref: '#/components/parameters/LogSetsQueryParam'
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RecalledInfoCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API returns the list of recalled data of a tenancy.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storage/usage:
get:
description: '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.
'
operationId: GetStorageUsage
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StorageUsage'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API gets storage usage information of a tenancy.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storageWorkRequests:
get:
description: 'This API lists storage work requests. Use query parameters to narrow down or sort the result list.
'
operationId: ListStorageWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByTimeAcceptedExpiresQueryParam'
- $ref: '#/components/parameters/NamespaceNamePathParam'
- description: The is the work request type query parameter
in: query
name: operationType
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/StorageOperationType'
schema:
type: string
enum:
- OFFBOARD_TENANCY
- PURGE_STORAGE_DATA
- RECALL_ARCHIVED_STORAGE_DATA
- RELEASE_RECALLED_STORAGE_DATA
- PURGE_ARCHIVAL_DATA
- ARCHIVE_STORAGE_DATA
- CLEANUP_ARCHIVAL_STORAGE_DATA
- ENCRYPT_ACTIVE_DATA
- ENCRYPT_ARCHIVAL_DATA
- ENCRYPT_ALL_DATA
- description: The is the work request status query parameter
in: query
name: status
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
schema:
type: string
enum:
- ACCEPTED
- CANCELED
- FAILED
- IN_PROGRESS
- SUCCEEDED
- description: The is the query parameter of when the processing of work request was started
in: query
name: timeStarted
x-default-description: 'null'
schema:
type: string
format: date-time
- description: The is the query parameter of when the processing of work request was finished
in: query
name: timeFinished
x-default-description: 'null'
schema:
type: string
format: date-time
- description: This is the query parameter of purge policy name
in: query
name: policyName
x-default-description: 'null'
schema:
type: string
- description: This is the query parameter of purge policy ID
in: query
name: policyId
x-default-description: 'null'
schema:
type: string
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StorageWorkRequestCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API lists storage work requests.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storageWorkRequests/{workRequestId}:
get:
description: '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.
'
operationId: GetStorageWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/StorageWorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'The API returns details about the storage work request .
'
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/storageWorkRequests/{workRequestId}/errors:
get:
description: This API returns the list of work request errors if any.
operationId: ListStorageWorkRequestErrors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByErrorsQueryParam'
- $ref: '#/components/parameters/NamespaceNamePathParam'
responses:
200:
description: Operation succeeded
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestErrorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: This API returns the list of work request errors if any.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Storage'
/namespaces/{namespaceName}/supportedCharEncodings:
get:
description: Gets list of character encodings which are supported by on-demand upload.
operationId: ListSupportedCharEncodings
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadsCustomPaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of supported Character Encodings.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-total-items:
description: Total count.
schema:
type: integer
format: int64
content:
application/json:
schema:
$ref: '#/components/schemas/CharEncodingCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get supported character encodings for log files.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
/namespaces/{namespaceName}/supportedTimezones:
get:
description: Gets list of timezones which are supported by on-demand upload.
operationId: ListSupportedTimezones
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadsCustomPaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of supported time zones.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-total-items:
description: Total count.
schema:
type: integer
format: int64
content:
application/json:
schema:
$ref: '#/components/schemas/TimezoneCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get supported timezones
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
/namespaces/{namespaceName}/templates:
get:
description: 'Returns a list of templates, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as template name, type, display name and description.
'
operationId: ListTemplates
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/TemplateTypeQueryParam'
- $ref: '#/components/parameters/TemplateNameQueryParam'
- $ref: '#/components/parameters/TemplateDisplayTextQueryParam'
- $ref: '#/components/parameters/TemplateLifecycleStateQueryParam'
- $ref: '#/components/parameters/FilterQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/TemplateSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The templates were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsTemplateCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List templates passing specified filter
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsTemplate'
/namespaces/{namespaceName}/templates/{templateId}:
get:
description: 'Gets detailed information about the template with the specified ocid.
'
operationId: GetTemplate
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/TemplateIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The template details were successfully retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/LogAnalyticsTemplate'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: get template by ocid
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsTemplate'
/namespaces/{namespaceName}/unprocessedDataBucket:
get:
description: 'This API retrieves details of the configured bucket that stores unprocessed payloads.
'
operationId: GetUnprocessedDataBucket
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Response object containing represenation of object storage bucket for unprocessed data.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessedDataBucket'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieve Unprocessed Data Bucket
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads:
get:
description: 'Gets a list of all On-demand uploads.
To use this and other API operations, you must be authorized in an IAM policy.
'
operationId: ListUploads
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadNameOptionalQueryParam'
- $ref: '#/components/parameters/UploadNameContainsQueryParam'
- $ref: '#/components/parameters/UploadsPaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/UploadsSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/UploadWarningsFilterQueryParam'
responses:
200:
description: A page of UploadSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
opc-total-items:
description: Total count.
schema:
type: integer
format: int64
content:
application/json:
schema:
$ref: '#/components/schemas/UploadCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Uploads
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads/actions/validateFile:
post:
description: Validates a log file to check whether it is eligible to be uploaded or not.
operationId: ValidateFile
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ObjectLocationQueryParam'
- $ref: '#/components/parameters/FileNameQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: File Validation Response
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FileValidationResponse'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Validate File
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads/actions/validateSourceMapping:
post:
description: Validates the source mapping for a given file and provides match status and the parsed representation of log data.
operationId: ValidateSourceMapping
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/ObjectLocationQueryParam'
- $ref: '#/components/parameters/FileNameQueryParam'
- $ref: '#/components/parameters/LogSourceNameQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Response object containing match status and parsed representation of log data
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SourceMappingResponse'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Validate Source Mapping
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads/{uploadReference}:
delete:
description: 'Deletes an Upload by its reference.
It deletes all the logs in storage asscoiated with the upload and the corresponding upload metadata.
'
operationId: DeleteUpload
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadReferencePathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: Upload is deleted.
headers:
opc-deleted-log-count:
description: Deleted log records count.
schema:
type: integer
format: int64
opc-deleted-logfile-count:
description: Deleted log files count.
schema:
type: integer
format: int64
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete Upload
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Upload'
get:
description: Gets an On-Demand Upload info by reference.
operationId: GetUpload
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadReferencePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: An Upload representation of requested upload.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Upload'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get Upload
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads/{uploadReference}/files:
get:
description: Gets list of files in an upload along with its processing state.
operationId: ListUploadFiles
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadReferencePathParam'
- $ref: '#/components/parameters/UploadsPaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FilesSortByQueryParam'
- $ref: '#/components/parameters/SearchStringQueryParam'
- $ref: '#/components/parameters/UploadStatusQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of UploadFileSummary objects
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UploadFileCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Upload Files
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads/{uploadReference}/files/{fileReference}:
delete:
description: '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.
'
operationId: DeleteUploadFile
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadReferencePathParam'
- $ref: '#/components/parameters/UploadFileReferencePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: Upload log file is deleted.
headers:
opc-deleted-log-count:
description: Deleted log records count.
schema:
type: integer
format: int64
opc-deleted-logfile-count:
description: Deleted log files count.
schema:
type: integer
format: int64
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete Upload File
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads/{uploadReference}/warnings:
get:
description: Gets list of warnings in an upload caused by incorrect configuration.
operationId: ListUploadWarnings
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadReferencePathParam'
- $ref: '#/components/parameters/UploadsPaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of UploadWarningSummary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UploadWarningCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List upload warnings
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/uploads/{uploadReference}/warnings/{warningReference}:
delete:
description: 'Suppresses a specific warning inside an upload.
'
operationId: DeleteUploadWarning
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/UploadReferencePathParam'
- $ref: '#/components/parameters/UploadWarningReferencePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: Upload warning is deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete upload warning
tags:
- logAnalytics
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Upload'
/namespaces/{namespaceName}/warnings:
get:
description: 'Returns a list of collection warnings, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as start time, end time, warning type, warning state, source name, source pattern and entity name.
'
operationId: ListWarnings
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WarningStateQueryParam'
- $ref: '#/components/parameters/SourceNameQueryParam'
- $ref: '#/components/parameters/SourcePatternQueryParam'
- $ref: '#/components/parameters/WarningMessageQueryParam'
- $ref: '#/components/parameters/EntityNameQueryParam'
- $ref: '#/components/parameters/EntityTypeOptionalQueryParam'
- $ref: '#/components/parameters/WarningTypeQueryParam'
- $ref: '#/components/parameters/IsNoSourceQueryParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WarningSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The warnings were successfully retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LogAnalyticsWarningCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List and sort warnings based on specified criteria.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsWarning'
/namespaces/{namespaceName}/warnings/actions/suppress:
post:
description: 'Supresses a list of warnings. Any unsuppressed warnings in the input list would be suppressed. Warnings in the input list which are already suppressed will not be modified.
'
operationId: SuppressWarning
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The warnings were successfully supressed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Suppress specified warnings.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsWarning'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WarningReferenceDetails'
description: list of agent warning references to suppress
required: true
/namespaces/{namespaceName}/warnings/actions/unsuppress:
post:
description: 'Unsupresses a list of warnings. Any suppressed warnings in the input list would be unsuppressed. Warnings in the input list which are already unsuppressed will not be modified.
'
operationId: UnsuppressWarning
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The warnings were successfully unsupressed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Unsuppress specified warnings.
tags:
- logAnalytics
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/LogAnalyticsWarning'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WarningReferenceDetails'
description: warnings list
required: true
/namespaces/{namespaceName}/workRequests:
get:
description: 'Lists the work requests in a compartment.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Work Requests
tags:
- logAnalytics
x-related-resource: '#/definitions/WorkRequest'
/namespaces/{namespaceName}/workRequests/{workRequestId}:
get:
description: Gets the status of the work request with the given ID.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The detail of the work request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: GET Work Request Status
tags:
- logAnalytics
x-related-resource: '#/definitions/WorkRequest'
/namespaces/{namespaceName}/workRequests/{workRequestId}/errors:
get:
description: 'Return a (paginated) list of errors for a given work request.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: List of work request errors.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestErrorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request errors
tags:
- logAnalytics
x-related-resource: '#/definitions/WorkRequestError'
/namespaces/{namespaceName}/workRequests/{workRequestId}/logs:
get:
description: 'Return a (paginated) list of logs for a given work request.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/NamespaceNamePathParam'
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: List of work request logs.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestLogCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request logs
tags:
- logAnalytics
x-related-resource: '#/definitions/WorkRequestLog'
components:
schemas:
EstimateRecallDataSizeResult:
description: This is the size and time range of data to be recalled
properties:
coreGroupCount:
description: This is the number of core groups estimated for this recall
format: int32
type: integer
coreGroupCountLimit:
description: This is the max number of core groups that is available for any recall
format: int32
type: integer
isOverlappingWithExistingRecalls:
description: This indicates if the time range of data to be recalled overlaps with existing recalled data
type: boolean
message:
description: This message shows existing recall overlapping details like collection id, purpose
type: string
sizeInBytes:
description: This is the size in bytes
format: int64
type: integer
sizeLimitInBytes:
description: This is the size limit in bytes
format: int64
type: integer
timeDataEnded:
description: 'This is the end of the time range of data to be recalled. timeDataStarted and timeDataEnded delineate
the time range of the archived data to be recalled. They may not be exact the same as the
parameters in the request input (EstimateRecallDataSizeDetails).
'
format: date-time
type: string
timeDataStarted:
description: This is the start of the time range of data to be recalled
format: date-time
type: string
totalBatchSize:
description: This is the total number of batches data will be recalled in
format: int32
type: integer
required:
- sizeInBytes
- timeDataEnded
- timeDataStarted
type: object
LogAnalyticsWarning:
description: LogAnalyticsWarning
properties:
agentId:
description: The unique identifier of the agent associated with the warning
type: string
compartmentId:
description: The entity compartment ID.
type: string
entityId:
description: The unique identifier of the entity associated with the warning
type: string
entityName:
description: The name of the entity associated with the warning
type: string
entityType:
description: The type of the entity associated with the warning
type: string
entityTypeDisplayName:
description: The display name of the entity type associated with the warning
type: string
hostName:
description: The host containing the agent associated with the warning
type: string
isActive:
description: A flag indicating if the warning is currently active
type: boolean
isSuppressed:
description: A flag indicating if the warning is currently suppressed
type: boolean
patternId:
description: The unique identifier of the warning pattern
type: string
patternText:
description: The text of the pattern used by the warning
type: string
ruleDisplayName:
description: The display name of the rule which triggered the warning
type: string
ruleId:
description: The unique identifier of the rule associated with the warning
type: string
severity:
description: The warning severity
format: int32
type: integer
sourceDisplayName:
description: The display name of the source associated with the warning
type: string
sourceId:
description: The unique identifier of the source associated with the warning
type: string
sourceName:
description: The name of the source associated with the warning
type: string
suppressedBy:
description: The user who suppressed the warning, or empty if the warning is not suppressed
type: string
timeCollected:
description: The time at which the warning was most recently collected
format: date-time
type: string
timeOfInitialWarning:
description: The date at which the warning was initially triggered
format: date-time
type: string
timeOfLatestWarning:
description: The most recent date on which the warning was triggered
format: date-time
type: string
typeDisplayName:
description: The display name of the warning type
type: string
typeName:
description: The internal name of the warning
type: string
warningId:
description: The unique identifier of the warning
type: string
warningLevel:
description: The warning level - either pattern, rule, or source.
type: string
warningMessage:
description: 'A description of the warning intended for the consumer of the warning. It will
usually detail the cause of the warning, may suggest a remedy, and can contain any
other relevant information the consumer might find useful
'
type: string
type: object
EventType:
description: The event type.
properties:
eventTypeName:
description: The name of the event type.
type: string
isEnabled:
description: A flag indicating whether or not the event type is enabled.
type: boolean
isSystem:
description: 'A flag indicating whether or not the event type is user defined.
'
type: boolean
specVersion:
description: The version.
type: string
timeUpdated:
description: The last updated time.
format: date-time
type: string
type: object
StepInfo:
description: StepInfo
properties:
inputSequenceCurrentMatch:
description: The current input sequence match.
type: string
regexEngineClassName:
description: The regular expression engine class name.
type: string
stepCount:
description: The step count.
format: int32
type: integer
type: object
LogAnalyticsParserField:
description: LogAnalyticsParserField
properties:
actions:
description: 'List of actions/operations to be performed while fetching or parsing the logs.
'
items:
$ref: '#/components/schemas/ParserAction'
maxItems: 10
type: array
field:
$ref: '#/components/schemas/LogAnalyticsField'
parser:
$ref: '#/components/schemas/LogAnalyticsParser'
parserFieldExpression:
description: the parser field expression.
type: string
parserFieldId:
description: The parser field unique identifier.
format: int64
type: integer
parserFieldIntegratorName:
description: The integrator name.
type: string
parserFieldName:
description: The parser field internal name.
type: string
parserFieldSequence:
description: The parser field sequence.
format: int64
type: integer
parserName:
description: The parser internal name.
type: string
storageFieldName:
description: The storage field name.
type: string
structuredColumnInfo:
description: The structured column information.
type: string
type: object
LogAnalyticsConfigWorkRequestCollection:
description: LogAnalyticsConfigWorkRequestCollection
properties:
items:
description: A list of workrequest responses.
items:
$ref: '#/components/schemas/LogAnalyticsConfigWorkRequestSummary'
type: array
type: object
LogSetCollection:
description: It contains a list of log sets
properties:
items:
description: This is the array of log sets
items:
type: string
type: array
required:
- items
type: object
Filter:
description: 'Query builder filter action to apply edit to queryString.
'
properties:
fieldName:
description: 'Field filter references when inserting filter into the query string. Field must be a valid log analytics out-of-the-box field, virtual field calculated in the query or a user defined field.
'
type: string
operator:
description: 'Operator to apply when editing the query string.
'
enum:
- CLEAR
- REPLACE
- EQUALS
- NOT_EQUALS
- STARTS_WITH
- DOES_NOT_START_WITH
- ENDS_WITH
- DOES_NOT_END_WITH
- CONTAINS
- DOES_NOT_CONTAIN
- IS_LESS_THAN
- IS_LESS_THAN_OR_EQUAL_TO
- IS_GREATER_THAN
- IS_GREATER_THAN_OR_EQUAL_TO
- IS_BETWEEN
- IS_NOT_BETWEEN
- ADD_SUBQUERY
- CLEAR_SUBQUERY
type: string
values:
description: 'Field values that will be inserted into the query string for the specified fieldName. Please note all values should reflect the fields data type otherwise the insert is subject to fail.
'
items:
type: object
type: array
required:
- operator
LogAnalyticsAssociatedEntityCollection:
description: LogAnalytics Associated Entity Collection
properties:
items:
description: A list of entities.
items:
$ref: '#/components/schemas/LogAnalyticsAssociatedEntity'
type: array
type: object
LogAnalyticsPreference:
description: The preference information
properties:
name:
description: The preference name.
type: string
value:
description: The preference value.
type: string
type: object
WarningReferenceDetails:
description: 'A list of LogAnalyticsWarning references. Used as input to APIs which operate on a
list. For example, the suppress warning API accepts a list of warning references
and will suppress all warnings in the input list.
'
properties:
warningReferences:
description: 'A list of LogAnalyticsWarning references. Used as input to APIs which operate on a
list. For example, the suppress warning API accepts a list of warning references
and will suppress all warnings in the input list.
'
items:
type: string
type: array
type: object
ParserActionSummary:
description: 'A parser action summary object.
'
properties:
description:
description: The parser action description.
type: string
displayName:
description: The parser action display name.
type: string
name:
description: The parser action name.
type: string
required:
- name
type: object
LogAnalyticsTemplate:
description: 'A template object.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
content:
description: Base64 encoded template content.
type: string
contentFormat:
description: Content format. For example - XML.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
facets:
description: Facets of the template
items:
$ref: '#/components/schemas/TemplateFacet'
type: array
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
lifecycleState:
description: 'The current state of the template.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/ConfigLifecycleState'
name:
description: The template name.
type: string
parameters:
description: Base64 encoded template parameters.
type: string
parametersFormat:
description: Parameters format. For example - NAME_VALUE_PAIR.
type: string
parametersMetadata:
description: Base64 encoded parameters metadata definition.
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
type:
description: The template type.
type: string
required:
- id
- compartmentId
- timeCreated
- name
- lifecycleState
type: object
EffectivePropertyCollection:
description: A collection of effective properties.
properties:
items:
description: A list of properties and their effective values.
items:
$ref: '#/components/schemas/EffectivePropertySummary'
type: array
type: object
QueryAggregation:
description: 'Query results.
'
properties:
arePartialResults:
description: 'True if query did not complete processing all data.
'
type: boolean
columns:
description: 'Query result columns
'
items:
$ref: '#/components/schemas/AbstractColumn'
type: array
fields:
description: 'Query result fields
'
items:
$ref: '#/components/schemas/AbstractColumn'
type: array
isContentHidden:
description: 'True if the data returned by query is hidden.
'
type: boolean
items:
description: 'Query result data
'
items:
additionalProperties:
description: 'Specific row in the results.
'
type: object
type: object
type: array
partialResultReason:
description: 'Explanation of why results may be partial. Only set if arePartialResults is true.
'
type: string
percentComplete:
description: 'Percentage progress completion of the query.
'
format: int32
maximum: 100
minimum: 0
type: integer
queryExecutionTimeInMs:
description: 'Time ellapsed executing query in milli-seconds.
'
format: int64
type: integer
recalls:
description: 'List of recalls in the query.
'
items:
$ref: '#/components/schemas/RecallDefinition'
minItems: 0
type: array
timeFilter:
$ref: '#/components/schemas/TimeRange'
totalCount:
description: 'Number of rows query retrieved. Up to maxTotalCount limit.
'
format: int32
type: integer
totalGroupCount:
description: 'Number of groups created by query.
'
format: int32
type: integer
totalMatchedCount:
description: 'Number of rows matched by query.
'
format: int64
type: integer
required:
- percentComplete
type: object
LogAnalyticsAssociation:
description: LogAnalyticsAssociation
properties:
agentEntityName:
description: The name of the entity which contains the agent.
type: string
agentId:
description: The agent unique identifier.
type: string
associationProperties:
description: A list of association properties.
items:
$ref: '#/components/schemas/AssociationProperty'
type: array
entityId:
description: The entity unique identifier.
type: string
entityName:
description: The entity name.
type: string
entityTypeDisplayName:
description: The entity type display name.
type: string
entityTypeName:
description: The entity type internal name.
type: string
failureMessage:
description: The failure message.
type: string
host:
description: The host name.
type: string
lifeCycleState:
default: SUCCEEDED
description: 'The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED
or FAILED.
'
enum:
- ACCEPTED
- IN_PROGRESS
- SUCCEEDED
- FAILED
type: string
logGroupCompartment:
description: The log group compartment.
type: string
logGroupId:
description: The log group unique identifier.
type: string
logGroupName:
description: The log group name.
type: string
retryCount:
description: 'The number of times the association will be attempted
before failing.
'
format: int64
type: integer
sourceDisplayName:
description: The source display name.
type: string
sourceName:
description: The source name.
type: string
sourceTypeName:
description: The source type internal name.
type: string
timeLastAttempted:
description: The last attempt date.
format: date-time
type: string
type: object
DependentParser:
description: A parser that depends on or uses the resource such as a field or another parser.
properties:
dependencies:
description: The list of dependencies of the parser.
items:
$ref: '#/components/schemas/Dependency'
type: array
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
parserDisplayName:
description: The parser display name.
type: string
parserId:
description: The parser unique identifier.
format: int64
type: integer
parserName:
description: The parser name.
type: string
parserType:
description: The parser type
enum:
- XML
- JSON
- REGEX
- ODL
- DELIMITED
type: string
type: object
LogAnalyticsLabelCollection:
description: 'A collection of LogAnalytics Labels.
'
properties:
items:
description: An array of log analytics label summaries.
items:
$ref: '#/components/schemas/LogAnalyticsLabelSummary'
type: array
type: object
AutoAssociationState:
description: Auto association state of the source.
properties:
isEnabled:
description: A flag indicating whether or not auto association is enabled.
type: boolean
logGroupId:
description: The unique identifier of the log group to use for auto association.
type: string
type: object
LogAnalyticsEntitySummary:
description: 'Summary of a log analytics entity.
'
properties:
areLogsCollected:
description: 'The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
'
type: boolean
associatedSourcesCount:
description: 'The count of associated log sources for a given log analytics entity.
'
format: int32
type: integer
cloudResourceId:
description: 'The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity
represents a non-cloud resource that the customer may have on their premises.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
creationSource:
$ref: '#/components/schemas/CreationSource'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
entityTypeInternalName:
description: 'Internal name for the log analytics entity type.
'
maxLength: 160
minLength: 1
type: string
entityTypeName:
description: 'Log analytics entity type name.
'
maxLength: 128
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: 'lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The current state of the log analytics entity.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/EntityLifecycleStates'
managementAgentId:
description: 'The OCID of the Management Agent.
'
maxLength: 255
minLength: 1
type: string
metadata:
$ref: '#/components/schemas/LogAnalyticsMetadataCollection'
name:
description: 'Log analytics entity name.
'
maxLength: 255
minLength: 1
type: string
sourceId:
description: 'This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeLastDiscovered:
description: 'The date and time the resource was last discovered, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
timezoneRegion:
description: 'The timezone region of the log analytics entity.
'
format: x-obmcs-time-zone
maxLength: 64
minLength: 1
type: string
required:
- id
- name
- compartmentId
- entityTypeName
- entityTypeInternalName
- timeCreated
- timeUpdated
- lifecycleState
- lifecycleDetails
type: object
ResultColumn:
description: 'Querylanguage result column.
'
properties:
displayName:
description: 'Display name - will be alias if result column is renamed by queryString.
'
type: string
internalName:
description: 'Internal identifier for the column.
'
type: string
valueType:
description: 'Field denoting column data type.
'
enum:
- BOOLEAN
- STRING
- DOUBLE
- FLOAT
- LONG
- INTEGER
- TIMESTAMP
- FACET
- TABLE
type: string
x-obmcs-top-level-enum: '#/definitions/ValueType'
type: object
ParserTestResult:
description: ParserTestResult
properties:
additionalInfo:
additionalProperties:
description: additional properties
type: string
description: Additional information for the test result.
type: object
entries:
description: The test result log entries.
items:
$ref: '#/components/schemas/AbstractParserTestResultLogEntry'
type: array
exampleContent:
description: The example content.
type: string
lines:
description: The test result log lines.
items:
$ref: '#/components/schemas/AbstractParserTestResultLogLine'
type: array
namedCaptureGroups:
description: The named capture groups.
items:
type: string
type: array
violations:
description: The test violations.
items:
$ref: '#/components/schemas/Violation'
maxItems: 10
type: array
type: object
CreateLogAnalyticsEntityDetails:
description: 'Details for new log analytics entity to be added.
'
properties:
cloudResourceId:
description: 'The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity
represents a non-cloud resource that the customer may have on their premises.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
entityTypeName:
description: 'Log analytics entity type name.
'
maxLength: 128
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostname:
description: 'The hostname where the entity represented here is actually present. This would be the output one would get if
they run `echo $HOSTNAME` on Linux or an equivalent OS command. This may be different from
management agents host since logs may be collected remotely.
'
maxLength: 255
minLength: 1
type: string
managementAgentId:
description: 'The OCID of the Management Agent.
'
maxLength: 255
minLength: 1
type: string
metadata:
$ref: '#/components/schemas/LogAnalyticsMetadataDetails'
name:
description: 'Log analytics entity name.
'
maxLength: 255
minLength: 1
type: string
properties:
additionalProperties:
maxLength: 512
minLength: 1
type: string
description: 'The name/value pairs for parameter values to be used in file patterns specified in log sources.
'
type: object
sourceId:
description: 'This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
'
maxLength: 255
minLength: 1
type: string
timeLastDiscovered:
description: 'The date and time the resource was last discovered, in the format defined by RFC3339.
'
format: date-time
type: string
timezoneRegion:
description: 'The timezone region of the log analytics entity.
'
format: x-obmcs-time-zone
maxLength: 64
minLength: 1
type: string
required:
- name
- compartmentId
- entityTypeName
type: object
IngestTimeRuleCondition:
description: The condition(s) to evaluate for an ingest time rule.
discriminator:
propertyName: kind
properties:
kind:
description: Discriminator.
enum:
- FIELD
type: string
required:
- kind
type: object
LogAnalyticsSourceFunction:
description: LogAnalyticsSourceFunction
properties:
arguments:
description: The function argument.
items:
$ref: '#/components/schemas/LogAnalyticsMetaFunctionArgument'
type: array
features:
description: Features of the source function to use for enrichment.
items:
type: string
type: array
function:
$ref: '#/components/schemas/LogAnalyticsMetaFunction'
functionId:
description: The source function unique identifier.
format: int64
type: integer
functionName:
default: LOOKUP
description: The source function name
enum:
- GEOLOCATION
- LOOKUP
type: string
functionReference:
description: The source function unique identifier as a string.
type: string
isEnabled:
description: 'A flag indicating whether or not the source function is enabled.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
lookupColumn:
description: The lookup column.
type: string
lookupColumnPosition:
description: The lookup column position.
format: int64
type: integer
lookupDisplayName:
description: The lookup display name.
type: string
lookupMode:
description: The lookup mode.
format: int64
type: integer
lookupTable:
description: The lookup table.
type: string
order:
description: The source function order.
format: int64
type: integer
sourceId:
description: The source unique identifier.
format: int64
type: integer
sourceReference:
description: The source unique identifier as a string.
type: string
type: object
MatchInfo:
description: MatchInfo
properties:
matchingLogEntryEndIndex:
description: The end index of the matching log entry.
format: int32
type: integer
regexScore:
description: The regular expression score.
format: int32
type: integer
stepCount:
description: The step count.
format: int32
type: integer
type: object
LogAnalyticsEntity:
description: 'Description of a log analytics entity.
'
properties:
areLogsCollected:
description: 'The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
'
type: boolean
associatedSourcesCount:
description: 'The count of associated log sources for a given log analytics entity.
'
format: int32
type: integer
cloudResourceId:
description: 'The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity
represents a non-cloud resource that the customer may have on their premises.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
creationSource:
$ref: '#/components/schemas/CreationSource'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
entityTypeInternalName:
description: 'Internal name for the log analytics entity type.
'
maxLength: 160
minLength: 1
type: string
entityTypeName:
description: 'Log analytics entity type name.
'
maxLength: 128
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostname:
description: 'The hostname where the entity represented here is actually present. This would be the output one would get if
they run `echo $HOSTNAME` on Linux or an equivalent OS command. This may be different from
management agents host since logs may be collected remotely.
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: 'lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The current state of the log analytics entity.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/EntityLifecycleStates'
managementAgentCompartmentId:
description: 'Management agent (management-agents resource kind) compartment OCID
'
maxLength: 255
minLength: 1
type: string
managementAgentDisplayName:
description: 'Management agent (management-agents resource kind) display name
'
maxLength: 255
minLength: 1
type: string
managementAgentId:
description: 'The OCID of the Management Agent.
'
maxLength: 255
minLength: 1
type: string
metadata:
$ref: '#/components/schemas/LogAnalyticsMetadataSummary'
name:
description: 'Log analytics entity name.
'
maxLength: 255
minLength: 1
type: string
properties:
additionalProperties:
maxLength: 512
minLength: 1
type: string
description: 'The name/value pairs for parameter values to be used in file patterns specified in log sources.
'
type: object
sourceId:
description: 'This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeLastDiscovered:
description: 'The date and time the resource was last discovered, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
timezoneRegion:
description: 'The timezone region of the log analytics entity.
'
format: x-obmcs-time-zone
maxLength: 64
minLength: 1
type: string
required:
- id
- name
- compartmentId
- entityTypeName
- entityTypeInternalName
- timeCreated
- timeUpdated
- lifecycleState
- lifecycleDetails
type: object
UnprocessedDataBucket:
description: 'Configuration details of the bucket that stores unprocessed payloads.
'
properties:
bucketName:
description: Name of the Object Storage bucket.
maxLength: 1024
minLength: 1
type: string
isEnabled:
default: true
description: 'Flag that specifies if this configuration is enabled or not.
'
type: boolean
namespace:
description: Object Storage namespace.
maxLength: 1024
minLength: 1
type: string
timeCreated:
description: The time when this record is created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The latest time when this record is updated. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- namespace
- bucketName
SourceSummaryReport:
description: SourceSummaryReport
properties:
autoAssociationSourceCount:
description: The count of sources set to auto-associate.
format: int32
type: integer
nonOobCount:
description: The count of custom (user defined) sources.
format: int32
type: integer
oobCount:
description: The count of built in sources.
format: int32
type: integer
type: object
VariableDefinition:
description: 'Defines a variable used in a macro or the initization section of a query.
'
properties:
defaultValue:
description: 'Default value of the variable is not already set.
'
type: string
description:
description: 'Descripion of the variable to show the user.
'
type: string
mapKeys:
description: 'List of variables if this variable is a map.
'
items:
$ref: '#/components/schemas/VariableDefinition'
minItems: 0
type: array
name:
description: 'Name of the variable preceded by a $.
'
type: string
properties:
description: 'Optional list of properties for the variable.
'
items:
$ref: '#/components/schemas/PropertyDefinition'
minItems: 0
type: array
type:
description: 'Type of the variable to show the user.
'
enum:
- NUMBER
- STRING
- TIMESTAMP
type: string
required:
- name
type: object
ExtractLogFieldResults:
description: log field path values
properties:
paths:
description: The log field path values.
items:
type: string
type: array
type: object
LogAnalyticsParserFilter:
description: LogAnalyticsParserFilter
properties:
agentVersion:
description: The agent version.
type: string
id:
description: The parser filter unique identifier.
type: string
isInUse:
description: 'A flag indicating whether or not the filter is currently being used.
'
format: int64
type: integer
operatingSystem:
description: The operating system.
type: string
parser:
$ref: '#/components/schemas/LogAnalyticsParser'
parserId:
description: The parser unique identifier.
format: int64
type: integer
version:
description: The version.
type: string
type: object
RecallCount:
description: 'This is the recall count statistics for a given tenant
'
properties:
recallCount:
description: This is the total number of recalls made so far
format: int32
type: integer
recallFailed:
description: This is the number of recalls that failed
format: int32
type: integer
recallLimit:
description: This is the maximum number of recalls (including successful and pending recalls) allowed
format: int32
type: integer
recallPending:
description: This is the number of recalls in pending state
format: int32
type: integer
recallSucceeded:
description: This is the number of recalls that succeeded
format: int32
type: integer
required:
- recallCount
- recallSucceeded
- recallPending
- recallFailed
- recallLimit
type: object
x-example: "{\n \"recallCount\": 12,\n \"recallSucceeded\": 7,\n \"recallPending\": 2,\n \"recallFailed\": 3,\n \"recallLimit\": 10\n}\n"
UploadFileSummary:
description: Details of Upload File.
properties:
chunksConsumed:
description: Number of chunks processed.
format: int64
type: number
chunksFail:
description: Number of chunks failed processing.
format: int64
type: number
chunksSuccess:
description: Number of chunks processed successfully.
format: int64
type: number
entityName:
description: Name of the entity associated with the file.
type: string
entityType:
description: Name of the entity type.
type: string
failureDetails:
description: The details about upload processing failure.
type: string
logGroupId:
description: Log group OCID associated with the file.
type: string
logGroupName:
description: Name of the log group associated with the file.
type: string
logNamespace:
description: (Deprecated) Name of the log namespace associated with the file.
type: string
name:
description: Name of the file
type: string
reference:
description: Unique internal identifier to refer upload file.
type: string
sourceName:
description: Name of the log source used for processing this file.
type: string
status:
description: Processing status of the file.
enum:
- IN_PROGRESS
- SUCCESSFUL
- FAILED
type: string
timeStarted:
description: The time when this file processing started.
format: date-time
type: string
totalChunks:
description: Number of estimated chunks for this file. A chunk is a portion of the log file used for the processing.
format: int64
type: number
required:
- reference
- name
type: object
ScheduledTask:
description: 'Log analytics scheduled task resource.
'
discriminator:
propertyName: kind
properties:
action:
$ref: '#/components/schemas/Action'
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data plane resource.
'
type: string
kind:
description: Discriminator.
enum:
- ACCELERATION
- STANDARD
type: string
lifecycleState:
description: The current state of the scheduled task.
enum:
- ACTIVE
- DELETED
type: string
numOccurrences:
description: Number of execution occurrences.
format: int64
type: integer
pauseReason:
description: reason for taskStatus PAUSED.
enum:
- METRIC_EXTRACTION_NOT_VALID
- SAVED_SEARCH_NOT_VALID
- SAVED_SEARCH_NOT_FOUND
- QUERY_STRING_NOT_VALID
- USER_ACTION
- TENANCY_LIFECYCLE
- PURGE_RESOURCE_NOT_FOUND
- LIMIT_EXCEEDED
type: string
schedules:
description: Schedules.
items:
$ref: '#/components/schemas/Schedule'
type: array
taskStatus:
description: Status of the scheduled task.
enum:
- READY
- PAUSED
- COMPLETED
- BLOCKED
type: string
taskType:
description: Task type.
enum:
- SAVED_SEARCH
- ACCELERATION
- PURGE
type: string
x-obmcs-top-level-enum: '#/definitions/TaskType'
timeCreated:
description: 'The date and time the scheduled task was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeOfNextExecution:
description: 'The date and time the scheduled task will execute next,
in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the scheduled task was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
workRequestId:
description: most recent Work Request Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.
type: string
required:
- kind
- id
- displayName
- taskType
- schedules
- action
- compartmentId
- timeCreated
- timeUpdated
- lifecycleState
type: object
UploadWarningCollection:
description: Collection of UploadWarningSummary objects.
properties:
items:
description: list of UploadWarningSummary objects.
items:
$ref: '#/components/schemas/UploadWarningSummary'
type: array
required:
- items
type: object
RegexMatchResult:
description: RegexMatchResult
properties:
matchedLogEntryEndIndex:
description: The matched log entry end index.
format: int32
type: integer
regexScore:
description: The regular expression score.
format: int32
type: integer
regexStepsInfo:
description: The regular expression steps information.
items:
$ref: '#/components/schemas/StepInfo'
type: array
stepCount:
description: The regular expression step count.
format: int32
type: integer
subRegexesMatchInfo:
additionalProperties:
$ref: '#/components/schemas/MatchInfo'
description: The regular expression match information.
type: object
type: object
LogAnalyticsField:
description: Field Details
properties:
ceeAlias:
description: 'The name this field is given in the common event expression standard from mitre.org.
This is used for reference when exporting content conforming to CEE standard
'
type: string
dataType:
description: The field data type.
type: string
description:
description: The field description.
type: string
displayName:
description: The field display name.
type: string
editVersion:
description: The field edit version.
format: int64
type: integer
facetPriority:
description: The facet priority.
format: int64
type: integer
isFacetEligible:
description: 'A flag indicating whether or not the facet is eligible for use.
'
type: boolean
isHighCardinality:
description: 'A flag indicating whether or not the cardinality of the field is high.
'
type: boolean
isKeepDuplicates:
description: 'A flag indicating whether or not duplicates would be retained.
'
type: boolean
isLargeData:
description: 'A flag indicating whether or not the field is a large data field.
'
type: boolean
isMetricKeyEligible:
description: 'A flag indicating whether or not the field is metric key eligible.
'
type: boolean
isMetricValueEligible:
description: 'A flag indicating whether or not the field is metric value eligible.
'
type: boolean
isMultiValued:
description: 'A flag indicating whether or not the field is multi-valued.
'
type: boolean
isPrimary:
description: 'A flag indicating whether or not this is a primary field.
'
type: boolean
isSummarizable:
description: 'A flag indicating whether or not the field can be summarized.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isTableEligible:
description: 'A flag indicating whether or not the field is table eligible.
'
type: boolean
mappedValue:
description: The mapped value.
type: string
name:
description: The field internal name.
type: string
rangeFacetEligible:
description: 'A flag indicating whether or not the field is range facet eligible.
'
format: int64
type: integer
regularExpression:
description: The field default regular expression.
type: string
timeUpdated:
description: The last updated date and time.
format: date-time
type: string
unitType:
description: The field unit type.
type: string
type: object
EncryptionKeyInfoSummary:
description: This is the summary of an encryption key.
properties:
keyId:
description: This is the key OCID of the encryption key (null if Oracle-managed).
type: string
keySource:
description: This is the source of the encryption key.
enum:
- ORACLE_MANAGED
- CUSTOMER_MANAGED
type: string
x-obmcs-top-level-enum: '#/definitions/EncryptionKeySource'
keyType:
description: This is the type of data to be encrypted. It can be either active or archival.
enum:
- ACTIVE_DATA
- ARCHIVAL_DATA
- ALL
type: string
x-obmcs-top-level-enum: '#/definitions/EncryptionKeyType'
required:
- keySource
- keyId
- keyType
type: object
ChangeLookupCompartmentDetails:
description: 'The information required to change the compartment of a lookup.
'
properties:
compartmentId:
description: 'The OCID of the compartment where the log analytics entity should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
UpdateLogAnalyticsEntityDetails:
description: 'Details of log analytics entity to be updated.
'
properties:
cloudResourceId:
description: 'The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity
represents a non-cloud resource that the customer may have on their premises.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostname:
description: 'The hostname where the entity represented here is actually present. This would be the output one would get if
they run `echo $HOSTNAME` on Linux or an equivalent OS command. This may be different from
management agents host since logs may be collected remotely.
'
maxLength: 255
minLength: 1
type: string
managementAgentId:
description: 'The OCID of the Management Agent.
'
maxLength: 255
minLength: 1
type: string
metadata:
$ref: '#/components/schemas/LogAnalyticsMetadataDetails'
name:
description: 'Log analytics entity name.
'
maxLength: 255
minLength: 1
type: string
properties:
additionalProperties:
maxLength: 512
minLength: 1
type: string
description: 'The name/value pairs for parameter values to be used in file patterns specified in log sources.
'
type: object
timeLastDiscovered:
description: 'The date and time the resource was last discovered, in the format defined by RFC3339.
'
format: date-time
type: string
timezoneRegion:
description: 'The timezone region of the log analytics entity.
'
format: x-obmcs-time-zone
maxLength: 64
minLength: 1
type: string
type: object
RecalledDataCollection:
description: This is the list of recalled data
properties:
items:
description: This is the array of recalled data
items:
$ref: '#/components/schemas/RecalledData'
type: array
required:
- items
type: object
LogSetsCount:
description: 'total number of log sets
'
properties:
count:
description: This is the total number of log sets the tenancy has configured.
format: int64
type: integer
required:
- count
type: object
DisableAutoAssociationDetail:
description: The information required to disable log source auto-association.
properties:
deleteExistingAssociations:
description: 'A flag indicating whether or not to delete all the existing associations of the log source.
'
type: boolean
type: object
CompareContentDetails:
description: The two strings to compare.
properties:
content1:
description: The first of two strings to compare.
type: string
content2:
description: The second of two strings to compare.
type: string
type: object
UpdateLogAnalyticsEntityTypeDetails:
description: Log analytics entity type definition to be updated.
properties:
category:
description: 'Log analytics entity type category. Category will be used for grouping and filtering.
'
maxLength: 128
minLength: 1
type: string
properties:
description: A single log analytics entity type property definition.
items:
$ref: '#/components/schemas/EntityTypeProperty'
type: array
type: object
LogAnalyticsFieldUsages:
description: 'Contains information about resources such as parsers and sources that use the field.
'
properties:
dependentParsers:
description: Parsers that depend on or use the field.
items:
$ref: '#/components/schemas/DependentParser'
maxItems: 100
type: array
dependentSources:
description: Sources that depend on or use the field.
items:
$ref: '#/components/schemas/DependentSource'
maxItems: 100
type: array
required:
- dependentParsers
- dependentSources
type: object
LogAnalyticsLabelSummary:
description: LogAnalytics label
properties:
aliases:
description: The alias list.
items:
$ref: '#/components/schemas/LogAnalyticsLabelAlias'
type: array
countUsageInSource:
description: The source usage count for this label.
format: int64
type: integer
description:
description: The label description.
type: string
displayName:
description: The label display name.
type: string
editVersion:
description: The label edit version.
format: int64
type: integer
impact:
description: The label impact.
type: string
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined label. A value of true denotes a built in label.
'
type: boolean
isUserDeleted:
description: 'A flag indicating whether or not the label has been deleted.
'
type: boolean
name:
description: The label name.
type: string
priority:
default: NONE
description: The label priority. Valid values are (NONE, LOW, HIGH). NONE is default.
enum:
- NONE
- LOW
- MEDIUM
- HIGH
type: string
recommendation:
description: The label recommendation.
type: string
suggestType:
description: The type of suggestion for label usage.
format: int64
type: integer
timeUpdated:
description: The last updated date.
format: date-time
type: string
type:
default: INFO
description: The label type. Valid values are (INFO, PROBLEM). INFO is default.
enum:
- INFO
- PROBLEM
type: string
RuleSummaryCollection:
description: A collection of Log Analytics rules.
properties:
items:
description: An array of rule summary objects.
items:
$ref: '#/components/schemas/RuleSummary'
type: array
type: object
TimezoneCollection:
description: List of supported timezones.
properties:
items:
description: List of supported timezones.
items:
type: string
type: array
required:
- items
type: object
ScheduledTaskCollection:
description: Collection of scheduled tasks.
properties:
items:
description: Array of scheduled task summary information.
items:
$ref: '#/components/schemas/ScheduledTaskSummary'
type: array
required:
- items
type: object
RecalledData:
description: This is the information about recalled data
properties:
collectionId:
description: This is the id for the recalled data collection
format: int64
type: integer
createdBy:
description: This is the user who initiated the recall request
type: string
logSets:
description: This is the list of logsets associated with the recall
type: string
notRecalledDataInBytes:
description: This is the size of the archival data not recalled yet within the specified time range
format: int64
type: integer
percentageComplete:
description: This is the current progress percentage for the recalled data
format: int32
type: integer
purpose:
description: This is the purpose of the recall
type: string
queryString:
description: This is the query associated with the recall
type: string
recallCount:
description: 'This is the number of recall operations for this recall. Note one RecalledData can be merged from the results
of several recall operations if the time duration of the results of the recall operations overlap.
'
format: int32
type: integer
status:
description: This is the status of the recall
enum:
- RECALLED
- PENDING
- FAILED
- PARTIAL_RECALLED
type: string
storageUsageInBytes:
description: This is the size in bytes
format: int64
type: integer
timeDataEnded:
description: This is the end of the time range of the related data
format: date-time
type: string
timeDataStarted:
description: This is the start of the time range of the related data
format: date-time
type: string
timeRecalledDataEnded:
description: This is the recalled data end time
format: date-time
type: string
timeRecalledDataStarted:
description: This is the recalled date start time
format: date-time
type: string
timeStarted:
description: This is the time when the first recall operation was started for this RecalledData
format: date-time
type: string
required:
- storageUsageInBytes
- timeDataStarted
- timeDataEnded
- timeStarted
- status
- recallCount
- notRecalledDataInBytes
- purpose
- queryString
- logSets
- createdBy
- collectionId
- timeRecalledDataStarted
- timeRecalledDataEnded
type: object
EntityTypeProperty:
description: 'Properties used in file patterns specified in log sources.
'
properties:
description:
description: 'Description for the log analytics entity type property.
'
maxLength: 400
type: string
name:
description: 'Log analytics entity type property name.
'
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
ExtractLogHeaderResults:
description: log header values
properties:
headerPaths:
description: The log header values.
items:
type: string
type: array
jsonPaths:
description: The log header json paths.
items:
$ref: '#/components/schemas/ExtractLogHeaderDetails'
type: array
xmlPaths:
description: The log field or log header values.
items:
type: string
type: array
type: object
LogAnalyticsMetaFunction:
description: LogAnalyticsMetaFunction
properties:
component:
description: The component.
type: string
description:
description: The description.
type: string
editVersion:
description: The edit version.
format: int64
type: integer
javaClassName:
description: The java class name.
type: string
metaFunctionArgument:
description: An array of meta function arguments.
items:
$ref: '#/components/schemas/LogAnalyticsMetaFunctionArgument'
type: array
metaFunctionId:
description: The meta function unique identifier.
format: int64
type: integer
name:
description: The meta function name.
type: string
type: object
AssociableEntity:
description: Entity details including whether or not it is eligible for association with the source.
properties:
agentId:
description: The OCID of the Management Agent.
type: string
eligibilityStatus:
description: 'This field indicates whether the entity is (in)eligible to be associated with this source.
'
enum:
- ELIGIBLE
- INELIGIBLE
type: string
entityId:
description: The entity OCID.
type: string
entityName:
description: The name of the entity.
type: string
entityTypeDisplayName:
description: The display name of the entity type.
type: string
entityTypeName:
description: The type name of the entity.
type: string
host:
description: The entity host.
type: string
ineligibilityDetails:
description: The reason the entity is not eligible for association.
type: string
type: object
QueryDetails:
description: 'Input arguments for running a log anlaytics query. If the request is set to run in asynchronous mode
then shouldIncludeColumns and shouldIncludeFields can be overwritten when retrieving the results.
'
properties:
asyncMode:
default: FOREGROUND
description: Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).
enum:
- FOREGROUND
- BACKGROUND
type: string
x-obmcs-top-level-enum: '#/definitions/JobMode'
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
compartmentIdInSubtree:
default: false
description: 'Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
'
type: boolean
maxTotalCount:
default: 500
description: 'Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).
'
format: int32
maximum: 2001
minimum: 1
type: integer
queryString:
description: Query to perform. Must conform to log analytics querylanguage syntax. Syntax errors will be returned if present.
example: '* | stats count by ''Log Source'''
type: string
queryTimeoutInSeconds:
default: 120
description: Amount of time, in seconds, allowed for a query to execute. If this time expires before the query is complete, any partial results will be returned.
format: int32
maximum: 300
minimum: 5
type: integer
savedSearchId:
description: 'Saved search OCID for this query if known.
'
type: string
scopeFilters:
description: 'List of filters to be applied when the query executes. More than one filter per field is not permitted.
'
items:
$ref: '#/components/schemas/ScopeFilter'
maxItems: 7
minItems: 0
type: array
shouldIncludeColumns:
default: true
description: Include columns in response
type: boolean
shouldIncludeFields:
default: true
description: Include fields in response
type: boolean
shouldIncludeTotalCount:
default: false
description: Include the total number of results from the query. Note, this value will always be equal to or less than maxTotalCount.
type: boolean
shouldRunAsync:
default: false
description: 'Option to run the query asynchronously. This will lead to a LogAnalyticsQueryJobWorkRequest being submitted and the {workRequestId} will be returned to use for fetching the results.
'
type: boolean
shouldUseAcceleration:
default: true
description: 'Controls if query should ignore pre-calculated results if available and only use raw data. If set and no acceleration data is found it will fallback to raw data.
'
type: boolean
subSystem:
description: 'Default subsystem to qualify fields with in the queryString if not specified.
'
enum:
- LOG
type: string
x-obmcs-top-level-enum: '#/definitions/SubSystemName'
timeFilter:
$ref: '#/components/schemas/TimeRange'
variables:
description: 'List of variables to be prepended to the query string.
'
items:
type: string
minItems: 0
type: array
required:
- compartmentId
- queryString
- subSystem
type: object
LogAnalyticsSourceMetadataField:
description: LogAnalyticsSourceMetadataField
properties:
fieldName:
description: The field internal name.
type: string
isEnabled:
description: 'A flag indicating whether or not the source metadata field is enabled.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
key:
description: The key.
type: string
sourceName:
description: The source internal name.
type: string
type: object
LogAnalyticsEntityTopologyLink:
description: 'Log Analytics entity relationship link used in hierarchical representation of entity relationships topology.
'
properties:
contexts:
description: Array of log analytics entity relationship context.
items:
type: string
maxItems: 10
type: array
destinationEntityId:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
sourceEntityId:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
timeLastDiscovered:
description: 'The date and time the resource was last discovered, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- sourceEntityId
- destinationEntityId
type: object
Indexes:
description: Indexes
properties:
endIndex:
description: The end index.
format: int32
type: integer
startIndex:
description: The start index.
format: int32
type: integer
type: object
QueryWorkRequestCollection:
description: 'Collection of query work requests.
'
properties:
items:
description: 'List of work requests.
'
items:
$ref: '#/components/schemas/QueryWorkRequestSummary'
minItems: 0
type: array
required:
- items
type: object
DisableAutoAssociationDetails:
description: The information required to disable log source auto-association.
properties:
items:
description: A list of information required to disable auto association on a source.
items:
$ref: '#/components/schemas/DisableAutoAssociationDetail'
type: array
type: object
LogAnalyticsSourceMetric:
description: LogAnalyticsSourceMetric
properties:
entityType:
description: The entity type.
type: string
isMetricSourceEnabled:
description: 'A flag specifying whether or not the metric source is enabled.
'
type: boolean
metricName:
description: The metric name.
type: string
sourceName:
description: The source internal name.
type: string
type: object
FieldSummaryReport:
description: FieldSummaryReport
properties:
nonOobCount:
description: The count of custom (user defined) fields.
format: int32
type: integer
oobCount:
description: The count of built in fields.
format: int32
type: integer
usageDetails:
description: Field usage details
items:
$ref: '#/components/schemas/UsageStatusItem'
type: array
type: object
ExportContent:
description: The content to export.
properties:
fieldNames:
description: The field names.
items:
type: string
type: array
parserNames:
description: The parser names.
items:
type: string
type: array
sourceNames:
description: The source names.
items:
type: string
type: array
type: object
Action:
description: Action for scheduled task.
discriminator:
propertyName: type
properties:
type:
description: Action type discriminator.
enum:
- STREAM
- PURGE
type: string
required:
- type
type: object
IngestTimeRuleSummaryCollection:
description: A collection of Log Analytics ingest time rules.
properties:
items:
description: An array of ingest time rule summary objects.
items:
$ref: '#/components/schemas/IngestTimeRuleSummary'
type: array
type: object
EstimateReleaseDataSizeDetails:
description: 'This is the input used to estimate the size of data to be released
'
properties:
collectionId:
description: 'This is the id for the recalled data collection to be released.
If specified, only this collection will be released
'
format: int64
type: integer
timeDataEnded:
description: This is the end of the time range for the data to be released
format: date-time
type: string
timeDataStarted:
description: This is the start of the time range for the data to be released
format: date-time
type: string
required:
- timeDataStarted
- timeDataEnded
type: object
EfdRegexResult:
description: EfdRegexResult
properties:
baseFieldName:
description: The base field name.
type: string
id:
description: the unique identifier.
format: int64
type: integer
isValidRegexSyntax:
description: 'A flag indicating whether or not the regular expression is valid.
'
type: boolean
matchResult:
$ref: '#/components/schemas/RegexMatchResult'
parsedFieldCount:
description: The parsed field count.
format: int32
type: integer
parsedFields:
additionalProperties:
type: string
description: The parsed fields.
type: object
regex:
description: The regular expression.
type: string
status:
description: The status.
type: string
statusDescription:
description: The Status description.
type: string
violations:
description: The list of violations (if any).
items:
$ref: '#/components/schemas/Violation'
type: array
type: object
UpsertLogAnalyticsAssociationDetails:
description: 'The required information to update or create a list of associations.
'
properties:
compartmentId:
description: The compartment ID
type: string
items:
description: 'The information required to create or update an association.
'
items:
$ref: '#/components/schemas/UpsertLogAnalyticsAssociation'
type: array
type: object
AssociationProperty:
description: A property represented as a name-value pair.
properties:
name:
description: The name of the association property.
type: string
patterns:
description: A list of pattern level overrides for this property.
items:
$ref: '#/components/schemas/PatternOverride'
type: array
value:
description: The value of the association property.
type: string
required:
- name
type: object
ConditionBlock:
description: 'A condition block. This could represent a single condition, or have nested condition blocks under it.
To form a single condition, specify the fieldName, labelConditionOperator and labelConditionValue(s).
To form nested conditions, specify the conditions in conditionBlocks, and how to join them in conditionBlocksOperator.
'
properties:
conditionBlocks:
description: 'Condition blocks to evaluate within this condition block. Specify this for nested conditions.
'
items:
$ref: '#/components/schemas/ConditionBlock'
type: array
conditionBlocksOperator:
description: 'Operator using which the conditionBlocks should be joined. Specify this for nested conditions.
'
enum:
- AND
- OR
- NOT_AND
- NOT_OR
type: string
fieldName:
description: 'The name of the field the condition is based on. Specify this if this condition block represents a single condition.
'
type: string
labelConditionOperator:
description: 'The condition operator. Specify this if this condition block represents a single condition.
'
type: string
labelConditionValue:
description: 'The condition value. Specify this if this condition block represents a single condition.
'
type: string
labelConditionValues:
description: 'A list of condition values. Specify this if this condition block represents a single condition.
'
items:
type: string
type: array
type: object
EncryptionKeyInfoCollection:
description: This is a list of encryption key info.
properties:
items:
description: 'This is an array of encryption key info. There are at most 2 items in the list.
'
items:
$ref: '#/components/schemas/EncryptionKeyInfoSummary'
type: array
required:
- items
type: object
EnableAutoAssociationDetail:
description: The information required to enable log source auto-association.
properties:
logGroupId:
description: 'The unique identifier of the log group to use when auto-associating the log source to
eligible entities.
'
type: string
type: object
StorageWorkRequest:
description: 'This shows the storage work request details.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
compartmentIdInSubtree:
description: If true, purge child compartments data, only applicable to purge request
type: boolean
dataType:
description: Thie is the type of data to be purged
enum:
- LOG
- LOOKUP
type: string
x-obmcs-top-level-enum: '#/definitions/StorageDataType'
id:
description: 'This is the OCID of the storage work Request.
'
type: string
isRecallNewDataOnly:
description: This is the flag to indicate if only new data has to be recalled in this work request
type: boolean
isUseRecommendedDataSet:
description: This indicates if user checked system recommended time range
type: boolean
keyId:
description: This is the key ID for encryption key.
type: string
keyType:
description: 'The type of customer encryption key. It can be archival, active or all.
'
enum:
- ACTIVE_DATA
- ARCHIVAL_DATA
- ALL
type: string
x-obmcs-top-level-enum: '#/definitions/EncryptionKeyType'
logSets:
description: This is a list of logsets associated with this work request
type: string
operationDetails:
description: This provides more detailed info about the work request if applicable
type: string
operationType:
description: 'This is the type of the work request.
'
enum:
- OFFBOARD_TENANCY
- PURGE_STORAGE_DATA
- RECALL_ARCHIVED_STORAGE_DATA
- RELEASE_RECALLED_STORAGE_DATA
- PURGE_ARCHIVAL_DATA
- ARCHIVE_STORAGE_DATA
- CLEANUP_ARCHIVAL_STORAGE_DATA
- ENCRYPT_ACTIVE_DATA
- ENCRYPT_ARCHIVAL_DATA
- ENCRYPT_ALL_DATA
type: string
x-obmcs-top-level-enum: '#/definitions/StorageOperationType'
percentComplete:
description: 'Percentage progress completion of the work request.
'
format: int32
maximum: 100
minimum: 0
type: integer
policyId:
description: This is the purge policy ID if applicable
type: string
policyName:
description: This is the policy name if applicable (e.g. purge policy)
type: string
purgeQueryString:
description: This is the solr query used to filter data for purge, '*' means all
type: string
purpose:
description: This is the purpose of the operation associated with this work request
type: string
query:
description: This is the query string applied on the operation associated with this work request
type: string
status:
description: 'This is the work request status.
'
enum:
- ACCEPTED
- CANCELED
- FAILED
- IN_PROGRESS
- SUCCEEDED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
statusDetails:
description: This provides more detailed status if applicable
type: string
storageUsageInBytes:
description: This is the data usage in bytes if applicable
format: int64
type: integer
timeAccepted:
description: 'When the work request was accepted. Should match timeStarted in all cases.
'
format: date-time
type: string
timeDataEnded:
description: This is the end of the time interval
format: date-time
type: string
timeDataStarted:
description: This is the start of the time interval
format: date-time
type: string
timeExpires:
description: When the work request will expire.
format: date-time
type: string
timeFinished:
description: When the work request finished execution.
format: date-time
type: string
timeStarted:
description: When the work request started.
format: date-time
type: string
required:
- id
- operationType
- status
type: object
CompareContentResult:
description: The intraline diff result.
properties:
lineComparisonResults:
description: An array of line comparison results.
items:
$ref: '#/components/schemas/CompareLineResult'
type: array
type: object
OverlappingRecallSummary:
description: This is the information about overlapping recall requests
properties:
collectionId:
description: This is the id of the associated recalled data collection
format: int64
type: integer
createdBy:
description: This is the user who initiated the recall request
type: string
logSets:
description: This is the list of logsets associated with this recall
type: string
purpose:
description: This is the purpose of the recall
type: string
queryString:
description: This is the query associated with the recall
type: string
recallId:
description: This is the id for the recall request
format: int64
type: integer
status:
description: This is the status of the recall
enum:
- RECALLED
- PENDING
- FAILED
- PARTIAL_RECALLED
type: string
x-obmcs-top-level-enum: '#/definitions/RecallStatus'
timeDataEnded:
description: This is the end of the time range of the archival data
format: date-time
type: string
timeDataStarted:
description: This is the start of the time range of the archival data
format: date-time
type: string
timeStarted:
description: This is the time when the recall operation was started for this recall request
format: date-time
type: string
required:
- timeDataStarted
- timeDataEnded
- timeStarted
- status
- purpose
- queryString
- logSets
- createdBy
- collectionId
- recallId
type: object
LogAnalyticsLookupFields:
description: LogAnalyticsLookupFields
properties:
commonFieldName:
description: The common field name.
type: string
defaultMatchValue:
description: The default match value.
type: string
displayName:
description: The display name.
type: string
isCommonField:
description: 'A flag indicating whether or not the field is a common field.
'
type: boolean
matchOperator:
description: The match operator.
type: string
name:
description: The field name.
type: string
position:
description: The position.
format: int64
type: integer
type: object
AbstractField:
description: 'Generic field defining all attributes common to all querylanguage fields.
'
discriminator:
propertyName: name
properties:
alias:
description: 'Alias of field if renamed by queryStrng.
'
type: string
displayName:
description: 'Field display name - will be alias if field is renamed by queryStrng.
'
type: string
filterQueryString:
description: 'Query used to derive this field if specified.
'
type: string
internalName:
description: 'Internal identifier for the field.
'
type: string
isDeclared:
description: 'Field denoting if this is a declaration of the field in the queryString.
'
type: boolean
isDuration:
description: 'Identifies if this field format is a duration.
'
type: boolean
isGroupable:
description: 'Identifies if this field can be used as a grouping field in any grouping command.
'
type: boolean
name:
description: 'Field type classification.
'
enum:
- FIELD
- FIELDS
- FUNCTION
- SORT
type: string
originalDisplayNames:
description: 'Same as displayName unless field renamed in which case this will hold the original display names for the field
across all renames.
'
items:
type: string
type: array
unitType:
description: 'Field denoting field unit type.
'
type: string
valueType:
description: 'Field denoting field data type.
'
enum:
- BOOLEAN
- STRING
- DOUBLE
- FLOAT
- LONG
- INTEGER
- TIMESTAMP
- FACET
- TABLE
type: string
x-obmcs-top-level-enum: '#/definitions/ValueType'
required:
- name
type: object
WorkRequestSummary:
description: 'High level summary of control plane job work request.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
id:
description: 'Unique OCID identifier to reference this query job work Request.
'
type: string
percentComplete:
description: 'Percentage progress completion of the query.
'
format: int32
maximum: 100
minimum: 0
type: integer
status:
description: 'Work request status.
'
enum:
- ACCEPTED
- CANCELED
- FAILED
- IN_PROGRESS
- SUCCEEDED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
timeAccepted:
description: 'When the work request was accepted. Should match timeStarted in all cases.
'
format: date-time
type: string
timeFinished:
description: When the work request finished execution.
format: date-time
type: string
timeStarted:
description: When the work request started.
format: date-time
type: string
required:
- id
- timeStarted
type: object
ExtractLogHeaderDetails:
description: log header values
properties:
headerValues:
description: The log header values.
items:
type: string
type: array
logKey:
description: The log key.
type: string
type: object
RecallArchivedDataDetails:
description: 'This is the input used to recall archived data
'
properties:
collectionId:
description: 'This is the id for the recalled data collection to be used only for recall new data.
If specified, only this collection will be eligible for IsRecallNewDataOnly
'
format: int64
type: integer
compartmentId:
description: This is the compartment OCID for permission checking
type: string
dataType:
description: This is the type of the log data to be recalled
enum:
- LOG
- LOOKUP
type: string
x-obmcs-top-level-enum: '#/definitions/StorageDataType'
isRecallNewDataOnly:
default: false
description: This indicates if only new data has to be recalled in this recall request
type: boolean
isUseRecommendedDataSet:
default: true
description: This indicates if user checked system recommended time range
type: boolean
logSets:
description: This is a list of comma-separated log sets that recalled data belongs to.
type: string
purpose:
description: This is the purpose of the recall
type: string
query:
description: This is the query that identifies the recalled data.
type: string
timeDataEnded:
description: This is the end of the time interval
format: date-time
type: string
timeDataStarted:
description: This is the start of the time interval
format: date-time
type: string
required:
- compartmentId
- timeDataEnded
- timeDataStarted
type: object
QueryWorkRequest:
description: 'Job details outlining parameters specified when job was submitted.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
displayQueryString:
description: 'Display version of the user speciified queryString.
'
type: string
id:
description: 'Unique OCID identifier to reference this query job work Request with.
'
type: string
internalQueryString:
description: 'Internal version of the user specified queryString.
'
type: string
mode:
description: Current execution mode for the job.
enum:
- FOREGROUND
- BACKGROUND
type: string
x-obmcs-top-level-enum: '#/definitions/JobMode'
operationType:
description: 'Asynchronous action name.
'
enum:
- EXECUTE_QUERY_JOB
- EXECUTE_PURGE_JOB
type: string
x-obmcs-top-level-enum: '#/definitions/QueryOperationType'
percentComplete:
description: 'Percentage progress completion of the query.
'
format: int32
maximum: 100
minimum: 0
type: integer
scopeFilters:
description: 'List of filters applied when the query executed.
'
items:
$ref: '#/components/schemas/ScopeFilter'
maxItems: 7
minItems: 0
type: array
status:
description: 'Work request status.
'
enum:
- ACCEPTED
- CANCELED
- FAILED
- IN_PROGRESS
- SUCCEEDED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
subSystem:
description: 'Default subsystem to qualify fields with in the queryString if not specified.
'
enum:
- LOG
type: string
x-obmcs-top-level-enum: '#/definitions/SubSystemName'
timeAccepted:
description: 'When the work request was accepted. Should match timeStarted in all cases.
'
format: date-time
type: string
timeBackgroundAt:
description: When the job was put in to the background.
format: date-time
type: string
timeExpires:
description: When the job will expire.
format: date-time
type: string
timeFilter:
$ref: '#/components/schemas/TimeRange'
timeFinished:
description: When the job finished execution.
format: date-time
type: string
timeStarted:
description: When the job was started.
format: date-time
type: string
required:
- id
- compartmentId
- timeStarted
- mode
- subSystem
- displayQueryString
- internalQueryString
type: object
LogAnalyticsParameter:
description: LogAnalyticsParameter
properties:
defaultValue:
description: The default value of the parameter.
type: string
description:
description: The parameter description.
type: string
isActive:
description: 'A flag indicating whether or not the parameter is active.
'
type: boolean
name:
description: The parameter name.
type: string
sourceId:
description: The source unique identifier.
format: int64
type: integer
type: object
UpsertLogAnalyticsAssociation:
description: UpsertLogAnalyticsAssociation
properties:
agentId:
description: The agent unique identifier.
type: string
associationProperties:
description: A list of association properties.
items:
$ref: '#/components/schemas/AssociationProperty'
type: array
entityId:
description: The entity unique identifier.
type: string
entityName:
description: The entity name.
type: string
entityTypeName:
description: The entity type internal name.
type: string
host:
description: The host name.
type: string
logGroupId:
description: The log group unique identifier.
type: string
sourceName:
description: The source name.
type: string
sourceTypeName:
description: The source type internal name.
type: string
type: object
LogAnalyticsSourceExtendedFieldDefinitionCollection:
description: LogAnalyticsSourceExtendedFieldDefinitionCollection
properties:
items:
description: An array of extended field definitions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceExtendedFieldDefinition'
type: array
type: object
VerifyOutput:
description: Verify acceleration output.
properties:
columns:
description: Acceleration result columns, included if requested (shouldIncludeResults).
items:
$ref: '#/components/schemas/ResultColumn'
type: array
responseTimeInMs:
description: Response time in ms.
format: int64
type: integer
results:
description: Acceleration result values, included if requested (shouldIncludeResults).
items:
additionalProperties:
type: object
type: object
type: array
scheduledTaskId:
description: Acceleration task identifier.
type: string
totalCount:
description: Total count.
format: int32
type: integer
totalMatchedCount:
description: Total match count.
format: int64
type: integer
required:
- scheduledTaskId
- responseTimeInMs
- totalMatchedCount
- totalCount
type: object
LogAnalyticsMetaFunctionCollection:
description: LogAnalyticsMetaFunctionCollection
properties:
items:
description: An array of meta functions.
items:
$ref: '#/components/schemas/LogAnalyticsMetaFunction'
type: array
type: object
LogAnalyticsSourceExtendedFieldDefinition:
description: LogAnalyticsSourceExtendedFieldDefinition
properties:
baseFieldLogText:
description: The base field log text.
type: string
baseFieldName:
description: The base field internal name.
type: string
conditionBlock:
$ref: '#/components/schemas/GenericConditionBlock'
conditionDataType:
description: The conditional data type.
type: string
conditionField:
description: The conditional field.
type: string
conditionOperator:
description: The conditional operator.
type: string
conditionString:
description: 'String representation of the extended field condition. This supports specifying multiple condition blocks at various nested levels.
'
type: string
conditionValue:
description: The conditional value.
type: string
convertedRegularExpression:
description: The converted regular expression.
type: string
displayRegularExpression:
description: The regular expression.
type: string
extendedFieldDefinitionId:
description: The extended field definition unique identifier.
format: int64
type: integer
extendedFields:
description: An array of extended fields.
items:
$ref: '#/components/schemas/LogAnalyticsExtendedField'
type: array
field:
$ref: '#/components/schemas/LogAnalyticsField'
isEnabled:
description: 'A flag indicating whether or not the extended definition is enabled.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
regularExpression:
description: The regular expression.
type: string
sourceId:
description: The source unique identifier.
format: int64
type: integer
timeUpdated:
description: The last updated date.
format: date-time
type: string
type: object
PurgeStorageDataDetails:
description: 'This is the input used to purge data
'
properties:
compartmentId:
description: This is the compartment OCID under which the data will be purged and required permission will be checked
type: string
compartmentIdInSubtree:
default: true
description: If true, purge child compartments data
type: boolean
dataType:
description: This is the type of the log data to be purged
enum:
- LOG
- LOOKUP
type: string
x-obmcs-top-level-enum: '#/definitions/StorageDataType'
purgeQueryString:
description: This is the solr query used to filter data, '*' means all
type: string
timeDataEnded:
description: This is the end of the purge time interval
format: date-time
type: string
required:
- compartmentId
- timeDataEnded
type: object
LogAnalyticsSourceLabelCondition:
description: LogAnalyticsSourceLabelCondition
properties:
blockConditionField:
description: The block condition field.
type: string
blockConditionOperator:
description: The block condition operator.
type: string
blockConditionValue:
description: The block condition value.
type: string
conditionBlock:
$ref: '#/components/schemas/ConditionBlock'
conditionString:
description: 'String representation of the label condition. This supports specifying multiple condition blocks at various nested levels.
'
type: string
contentExample:
description: The content example.
type: string
fieldName:
description: The internal field name.
type: string
isEnabled:
description: 'A flag indicating whether or not the condition is enabled.
'
type: boolean
isInlineLabelExistingInDatabase:
description: 'A flag indicating whether or not the inline label exists in the database.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isVisible:
description: 'A flag indicating whether or not the label condition is visible.
'
type: boolean
labelConditionId:
description: The unique identifier of the condition.
format: int64
type: integer
labelConditionOperator:
description: The condition operator.
type: string
labelConditionValue:
description: The condition value.
type: string
labelConditionValues:
description: A list of condition values.
items:
type: string
type: array
labelDisplayName:
description: The label display name.
type: string
labelName:
description: The label name.
type: string
message:
description: The message.
type: string
sourceId:
description: The unique identifier of the source.
format: int64
type: integer
storageField:
description: The label storage field.
type: string
type: object
LogAnalyticsMetaSourceType:
description: LogAnalyticsMetaSourceType
properties:
builtInParserName:
description: The built in parser name.
type: string
description:
description: The source type description.
type: string
displayName:
description: The source type display name.
type: string
entityDisplayName:
description: The entity display name.
type: string
entityName:
description: The entity internal name.
type: string
maximumExcludePattern:
description: The maximum exclude pattern.
format: int64
type: integer
maximumIncludePattern:
description: The maximum include pattern.
format: int64
type: integer
name:
description: The source type name.
type: string
type: object
LogAnalyticsParserCollection:
description: LogAnalyticsParserCollection
properties:
items:
description: An array of parsers.
items:
$ref: '#/components/schemas/LogAnalyticsParserSummary'
type: array
type: object
ParserTestResultFieldValue:
description: 'A parser test result field value object.
'
properties:
fieldName:
description: The field name.
type: string
parserName:
description: The sub parser name.
type: string
position:
description: The field position.
format: int64
type: integer
subParserResult:
$ref: '#/components/schemas/ParserTestResult'
value:
description: The field value.
type: string
type: object
LogAnalyticsLogGroupSummaryCollection:
description: A collection of Log-Analytics log groups.
properties:
items:
description: An array of log group summary objects.
items:
$ref: '#/components/schemas/LogAnalyticsLogGroupSummary'
type: array
type: object
ParseQueryDetails:
description: 'Input information to submit parse query request.
'
properties:
queryString:
description: Query to parse.
type: string
subSystem:
description: 'Default subsystem to qualify fields with in the queryString if not specified.
'
enum:
- LOG
type: string
x-obmcs-top-level-enum: '#/definitions/SubSystemName'
required:
- queryString
- subSystem
type: object
Success:
description: Success Information.
properties:
message:
description: A human-readable success string.
type: string
required:
- message
type: object
CreationSource:
description: 'Details for auto-created entity.
'
properties:
details:
description: 'This will provide additional details for source of auto-creation. For example, if entity is auto-created
by enterprise manager bridge, this field provides additional detail on enterprise manager that contributed
to the entity auto-creation.
'
type: string
type:
description: Source that auto-created the entity.
enum:
- EM_BRIDGE
- BULK_DISCOVERY
- SERVICE_CONNECTOR_HUB
- DISCOVERY
- LOGGING_ANALYTICS
- NONE
type: string
x-obmcs-top-level-enum: '#/definitions/CreationSourceType'
type: object
LogAnalyticsPatternFilter:
description: LogAnalyticsPatternFilter
properties:
agentVersion:
description: The agent version.
type: string
isInUse:
description: 'A flag indicating whether or not the pattern filter is currently
in use.
'
type: boolean
operatingSystem:
description: The operating system.
type: string
pattern:
$ref: '#/components/schemas/LogAnalyticsSourcePattern'
patternId:
description: The pattern unique identifier.
format: int64
type: integer
source:
$ref: '#/components/schemas/LogAnalyticsSource'
sourceId:
description: The source unique identifier.
format: int64
type: integer
version:
description: The pattern filter version.
type: string
type: object
LogAnalyticsCategory:
description: A category into which resources can be placed.
properties:
description:
description: The category description.
type: string
displayName:
description: The category display name.
type: string
isSystem:
description: 'The system flag. A value of false denotes a user-created
category. A value of true denotes an Oracle-defined category.
'
type: boolean
name:
description: The unique name that identifies the category.
type: string
type:
description: The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".
type: string
type: object
LogAnalyticsParserSummary:
description: LogAnalyticsParserSummary
properties:
content:
description: The content.
type: string
description:
description: The parser description.
type: string
displayName:
description: The parser display name.
type: string
editVersion:
description: The parser edit version.
format: int64
type: integer
encoding:
description: The encoding.
type: string
exampleContent:
description: The example content.
type: string
fieldDelimiter:
description: The parser field delimiter.
type: string
fieldMaps:
description: The parser fields.
items:
$ref: '#/components/schemas/LogAnalyticsParserField'
type: array
fieldQualifier:
description: The parser field qualifier.
type: string
footerContent:
description: The footer regular expression.
type: string
headerContent:
description: The header content.
type: string
isDefault:
description: 'A flag indicating if this is a default parser.
'
type: boolean
isHidden:
description: 'A flag indicating if the parser is hidden or not.
'
type: boolean
isNamespaceAware:
description: 'A flag indicating whether the XML parser should consider the namespace(s) while processing the log data.
'
type: boolean
isParserWrittenOnce:
description: 'A flag indicating whether or not the parser is write once.
'
type: boolean
isPositionAware:
default: false
description: 'A flag indicating whether the parser is positionally aware.
'
type: boolean
isSingleLineContent:
description: 'A flag indicating if this is a single line content parser.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isUserDeleted:
description: 'A flag indicating whether or not the parser has been deleted.
'
type: boolean
language:
description: The language.
type: string
logTypeTestRequestVersion:
description: The log type test request version.
format: int32
type: integer
mappedParsers:
description: The mapped parser list.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
name:
description: The parser name.
type: string
parserFilter:
$ref: '#/components/schemas/LogAnalyticsParserFilter'
parserFunctions:
description: The parser function list.
items:
$ref: '#/components/schemas/LogAnalyticsParserFunction'
type: array
parserIgnorelineCharacters:
description: The line characters for the parser to ignore.
type: string
parserSequence:
description: The parser sequence.
format: int32
type: integer
parserTimezone:
description: The time zone.
type: string
shouldTokenizeOriginalText:
description: 'A flag indicating whether or not to tokenize the original text.
'
type: boolean
sources:
description: The list of sources using this parser.
items:
$ref: '#/components/schemas/LogAnalyticsSource'
type: array
sourcesCount:
description: The number of sources using this parser.
format: int64
type: integer
timeUpdated:
description: The last updated date.
format: date-time
type: string
type:
default: REGEX
description: The parser type. Default value is REGEX.
enum:
- XML
- JSON
- REGEX
- ODL
- DELIMITED
type: string
type: object
AutoLookups:
description: AutoLookups
properties:
canonicalLink:
description: The canonical link.
type: string
totalCount:
description: The total count.
format: int64
type: integer
type: object
WorkRequest:
description: A description of workrequest status
properties:
compartmentId:
description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to
the same compartment as the resource the work request affects. If the work request affects multiple resources,
and those resources are not in the same compartment, it is up to the service team to pick the primary
resource whose compartment should be used
'
type: string
id:
description: The id of the work request.
type: string
operationType:
description: Type of the work request
enum:
- CREATE_LOG_ANALYTICS
- DELETE_LOG_ANALYTICS
type: string
x-obmcs-top-level-enum: '#/definitions/LogAnalyticsOperationTypes'
percentComplete:
description: Percentage of the request completed.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: Status of current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
section 14.29.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
LabelNames:
description: LabelName
properties:
labelNames:
description: An array of label names.
items:
type: string
type: array
type: object
SourceValidateDetails:
description: source validation details
properties:
key:
description: The key.
type: string
value:
description: The value.
type: string
type: object
DependentSource:
description: A source that depends on or uses the resource such as a field or a parser
properties:
dependencies:
description: The list of dependencies defined by the source.
items:
$ref: '#/components/schemas/Dependency'
type: array
entityTypes:
description: The entity types.
items:
$ref: '#/components/schemas/LogAnalyticsSourceEntityType'
type: array
isAutoAssociationEnabled:
description: 'A flag indicating whether or not the source is marked for auto association.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
sourceDisplayName:
description: The source display name.
type: string
sourceId:
description: The source unique identifier.
format: int64
type: integer
sourceName:
description: The source name.
type: string
sourceType:
description: The source type.
type: string
type: object
PropertyMetadataSummary:
description: Summary of property metadata details.
properties:
defaultValue:
description: The default property value.
type: string
description:
description: The property description.
type: string
displayName:
description: The property display name.
type: string
levels:
description: A list of levels at which the property could be defined.
items:
$ref: '#/components/schemas/Level'
type: array
name:
description: The property name.
type: string
type: object
UpdateLookupMetadataDetails:
description: UpdateLookupMetadataDetails
properties:
categories:
description: 'An array of categories to assign to the lookup. Specifying the name attribute for each category would suffice.
Oracle-defined category assignments cannot be removed.
'
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
defaultMatchValue:
description: The default match value.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: The lookup description.
type: string
fields:
description: The lookup fields.
items:
$ref: '#/components/schemas/LogAnalyticsLookupFields'
type: array
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
maxMatches:
description: The maximum number of matches.
format: int64
type: integer
type: object
LogAnalyticsLabelDefinition:
description: LogAnalyticsLabelDefinition
properties:
editVersion:
description: The edit version.
format: int64
type: integer
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
labelName:
description: The label name.
type: string
sourceId:
description: The source unique identifier.
format: int64
type: integer
type: object
UiParserTestMetadata:
description: UiParserTestMetadata
properties:
lastModifiedTime:
description: The last modified time.
type: string
logFileName:
description: The log file name.
type: string
timeZone:
description: The time zone.
format: date-time
type: string
type: object
LogGroupSummaryReport:
description: A LogAnalytics Log Group summary report.
properties:
count:
description: The log group count.
format: int32
type: integer
type: object
ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails:
description: 'New compartment details.
'
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the rule have to be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
ParserAction:
description: 'A parser action. Typically refers to an operation to be performed while fetching or parsing the logs. Example: Unzip.
'
properties:
name:
description: Parser action name.
type: string
order:
description: Parser action order.
type: integer
type: object
WorkRequestResource:
description: A resource created or operated on by a work request.
properties:
actionType:
description: 'The way in which this resource is affected by the work tracked in the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
type: string
x-obmcs-top-level-enum: '#/definitions/ActionTypes'
entityType:
description: The resource type the work request affects.
type: string
entityUri:
description: The URI path that the user can do a GET on to access the resource metadata
type: string
identifier:
description: The identifier of the resource the work request affects.
type: string
required:
- actionType
- entityType
- identifier
NamedCaptureValue:
description: 'Named capture value.
'
properties:
subSequence:
description: The subSequence.
type: string
subSequenceEndIndex:
description: The subSequence end index.
format: int32
type: integer
subSequenceStartIndex:
description: The subSequence start index.
format: int32
type: integer
type: object
LogAnalyticsMetadataCollection:
description: A collection of entity metadata information.
properties:
items:
description: An array of entity metadata.
items:
$ref: '#/components/schemas/LogAnalyticsMetadata'
type: array
type: object
LogAnalyticsEntityType:
description: 'Description of log analytics entity type.
'
properties:
category:
description: 'Log analytics entity type category. Category will be used for grouping and filtering.
'
maxLength: 128
minLength: 1
type: string
cloudType:
description: 'Log analytics entity type group. That can be CLOUD (OCI) or NON_CLOUD otherwise.
'
enum:
- CLOUD
- NON_CLOUD
- ALL
type: string
x-obmcs-top-level-enum: '#/definitions/EntityCloudType'
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
internalName:
description: 'Internal name for the log analytics entity type.
'
maxLength: 160
minLength: 1
type: string
lifecycleState:
description: 'The current lifecycle state of the log analytics entity.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/EntityLifecycleStates'
managementAgentEligibilityStatus:
description: 'This field indicates whether logs for entities of this type can be collected using a management agent.
'
enum:
- ELIGIBLE
- INELIGIBLE
- UNKNOWN
type: string
name:
description: 'Log analytics entity type name.
'
maxLength: 128
minLength: 1
type: string
properties:
description: 'The parameters used in file patterns specified in log sources for this log analytics entity type.
'
items:
$ref: '#/components/schemas/EntityTypeProperty'
type: array
timeCreated:
description: 'Time the log analytics entity type was created. An RFC3339 formatted datetime string.
'
format: date-time
type: string
timeUpdated:
description: 'Time the log analytics entity type was updated. An RFC3339 formatted datetime string.
'
format: date-time
type: string
required:
- name
- internalName
- category
- cloudType
- timeCreated
- timeUpdated
- lifecycleState
type: object
LogAnalyticsParser:
description: LogAnalyticsParser
properties:
categories:
description: 'An array of categories assigned to this parser.
The isSystem flag denotes if each category assignment is user-created or Oracle-defined.
'
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
content:
description: The content.
type: string
dependentParsers:
description: A list of sub parsers used by this parser.
items:
$ref: '#/components/schemas/DependentParser'
maxItems: 100
type: array
dependentSources:
description: A list of sources that depend on the parser, either directly or indirectly.
items:
$ref: '#/components/schemas/DependentSource'
maxItems: 100
type: array
description:
description: The parser description.
type: string
displayName:
description: The parser display name.
type: string
editVersion:
description: The parser edit version.
format: int64
type: integer
encoding:
description: The encoding.
type: string
exampleContent:
description: The example content.
type: string
fieldDelimiter:
description: The parser field delimiter.
type: string
fieldMaps:
description: The parser fields.
items:
$ref: '#/components/schemas/LogAnalyticsParserField'
type: array
fieldQualifier:
description: The parser field qualifier.
type: string
footerContent:
description: The footer regular expression.
type: string
headerContent:
description: The header content.
type: string
isDefault:
description: 'A flag indicating if this is a default parser.
'
type: boolean
isHidden:
description: A flag indicating if the parser is hidden or not.
type: boolean
isNamespaceAware:
description: 'A flag indicating whether the XML parser should consider the namespace(s) while processing the log data.
'
type: boolean
isParserWrittenOnce:
description: 'A flag indicating whether or not the parser is write once.
'
type: boolean
isPositionAware:
default: false
description: 'A flag indicating whether the parser is positionally aware.
'
type: boolean
isSingleLineContent:
description: 'A flag indicating if this is a single line content parser.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isUserDeleted:
description: 'A flag indicating whether or not the parser has been deleted.
'
type: boolean
language:
description: The language.
type: string
logTypeTestRequestVersion:
description: The log type test request .
format: int32
type: integer
mappedParsers:
description: The mapped parser list.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
name:
description: The parser name.
type: string
parserFilter:
$ref: '#/components/schemas/LogAnalyticsParserFilter'
parserFunctions:
description: The parser function list.
items:
$ref: '#/components/schemas/LogAnalyticsParserFunction'
type: array
parserIgnorelineCharacters:
description: The line characters for the parser to ignore.
type: string
parserSequence:
description: The parser sequence.
format: int32
type: integer
parserTimezone:
description: The time zone.
type: string
shouldTokenizeOriginalText:
description: 'A flag indicating whether or not to tokenize the original text.
'
type: boolean
sources:
description: The list of sources using this parser.
items:
$ref: '#/components/schemas/LogAnalyticsSource'
type: array
sourcesCount:
description: The number of sources using this parser
format: int64
type: integer
timeUpdated:
description: The last updated date.
format: date-time
type: string
type:
default: REGEX
description: The parser type. Default value is REGEX.
enum:
- XML
- JSON
- REGEX
- ODL
- DELIMITED
type: string
type: object
UpdateScheduledTaskDetails:
description: 'The details for updating a schedule task.
'
discriminator:
propertyName: kind
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
kind:
description: Discriminator.
enum:
- ACCELERATION
- STANDARD
type: string
schedules:
description: 'Schedules may be updated for task types SAVED_SEARCH and PURGE.
Note there may only be a single schedule for SAVED_SEARCH and PURGE scheduled tasks.
'
items:
$ref: '#/components/schemas/Schedule'
type: array
required:
- kind
type: object
LabelPriority:
description: 'The label priority.
'
properties:
priority:
default: NONE
description: The label priority. Default value is NONE.
enum:
- NONE
- LOW
- MEDIUM
- HIGH
type: string
type: object
WorkRequestError:
description: An error encountered while executing a work request.
properties:
code:
description: 'A machine-usable code for the error that occured. Error codes are listed on
(https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)
'
type: string
message:
description: A human readable description of the issue encountered.
type: string
timestamp:
description: The time the error occured. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- code
- message
- timestamp
ParserSummaryReport:
description: ParserSummaryReport
properties:
nonOobCount:
description: The count of custom (user defined) parsers.
format: int32
type: integer
oobCount:
description: The count of built in parsers.
format: int32
type: integer
type: object
LogAnalyticsEmBridgeSummary:
description: 'Enterprise manager bridge summary.
'
properties:
bucketName:
description: Object store bucket name where enterprise manager harvested entities will be uploaded.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A description for log analytics enterprise manager bridge.
'
maxLength: 1024
minLength: 1
type: string
displayName:
description: 'Log analytics enterprise manager bridge display name.
'
maxLength: 128
minLength: 1
type: string
emEntitiesCompartmentId:
description: 'Compartment for entities created from enterprise manager.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The enterprise manager bridge OCID.
'
maxLength: 255
minLength: 1
type: string
lastImportProcessingDetails:
description: 'Processing status details of enterprise manager upload. This provides additional details
for failed status
'
type: string
lastImportProcessingStatus:
description: 'The status from last processing status of enterprise manager upload.
'
enum:
- NOT_STARTED
- SUCCESS
- IN_PROGRESS
- FAILED
- PARTIAL_SUCCESS
type: string
x-obmcs-top-level-enum: '#/definitions/EmBridgeLatestImportProcessingStatus'
lifecycleDetails:
description: 'lifecycleDetails has additional information regarding substeps such as verifying connection to object store.
'
type: string
lifecycleState:
description: 'The current state of the enterprise manager bridge.
'
enum:
- CREATING
- ACTIVE
- DELETED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/EmBridgeLifecycleStates'
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeEmDataLastExtracted:
description: 'The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339
'
format: date-time
type: string
timeImportLastProcessed:
description: 'The last time of enterprise manager upload was processed. This is in the format defined by RFC3339
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- emEntitiesCompartmentId
- bucketName
- timeCreated
- timeUpdated
- lifecycleState
- lastImportProcessingStatus
type: object
EstimatePurgeDataSizeResult:
description: 'purge data size in bytes
'
properties:
purgeDataSizeInBytes:
description: This is the size of data to be purged in bytes
format: int64
type: integer
required:
- purgeDataSizeInBytes
type: object
LogAnalyticsLabelAlias:
description: Label alias mapping view
properties:
alias:
description: The alias.
type: string
aliasDisplayName:
description: The alias display name.
type: string
displayName:
description: The label display name.
type: string
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
name:
description: The label name.
type: string
priority:
default: NONE
description: The label priority. Default value is NONE.
enum:
- NONE
- LOW
- MEDIUM
- HIGH
type: string
type: object
LogAnalyticsLogGroupSummary:
description: 'Summary of a Log-Analytics log group.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- id
- compartmentId
type: object
LogAnalyticsMetadataDetails:
description: Details of Entity Metadata.
properties:
items:
description: An array of entity metadata details.
items:
$ref: '#/components/schemas/LogAnalyticsMetadata'
type: array
type: object
PatternOverride:
description: Details of pattern level override for a property.
properties:
effectiveLevel:
description: The effective level of the property value.
type: string
id:
description: The pattern id.
type: string
value:
description: The value of the property.
type: string
required:
- id
- value
type: object
UploadSummary:
description: Summary of the Upload.
properties:
name:
description: The name of the upload container.
type: string
reference:
description: Unique internal identifier to refer the upload container.
type: string
timeCreated:
description: The time when this upload container is created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeEarliestLogEntry:
description: This time represents the earliest time of the log entry in this container. An RFC3339 formatted datetime string.
format: date-time
type: string
timeLatestLogEntry:
description: This time represents the latest time of the log entry in this container. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The latest time when this upload container is modified. An RFC3339 formatted datetime string.
format: date-time
type: string
warningsCount:
description: Number of warnings associated to the upload.
type: integer
required:
- reference
- name
- timeCreated
type: object
LabelSourceCollection:
description: 'LogAnalytics Label Source Collection
'
properties:
items:
description: An array labels.
items:
$ref: '#/components/schemas/LabelSourceSummary'
type: array
type: object
UpdateStorageDetails:
description: This is the input to update storage configuration of a tenancy in Log Analytics application
properties:
archivingConfiguration:
$ref: '#/components/schemas/ArchivingConfiguration'
required:
- archivingConfiguration
type: object
LogAnalyticsParserMetaPluginParameter:
description: LogAnalyticsParserMetaPluginParameter
properties:
description:
description: The parameter description.
type: string
isMandatory:
description: 'A flag indicating whether or not the parameter is mandatory.
'
type: boolean
isRepeatable:
description: 'A flag indicating whether or not the parameter is repeatable.
'
type: boolean
name:
description: The parameter internal name.
type: string
pluginName:
description: The plugin internal name.
type: string
type:
description: The parameter type.
type: string
type: object
Dependency:
description: 'Details of a dependency an object or feature defines on another. For
example, a source may depend on a parser either directly or indirectly.
'
properties:
referenceDisplayName:
description: The display name of the dependency object
type: string
referenceId:
description: The unique identifier of the reference, if available.
format: int64
type: integer
referenceName:
description: The name of the dependency object
type: string
referenceType:
description: The type of reference that defines the dependency.
type: string
type:
description: The dependency type.
type: string
type: object
RuleSummary:
description: 'A generic rule summary object - represents an ingest time rule or a scheduled task.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: The ingest time rule or scheduled task display name.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
isEnabled:
description: A flag indicating whether or not the ingest time rule or scheduled task is enabled.
type: boolean
kind:
description: 'The kind of rule - either an ingest time rule or a scheduled task.
'
enum:
- INGEST_TIME
- SAVED_SEARCH
type: string
x-obmcs-top-level-enum: '#/definitions/RuleKind'
lastExecutionStatus:
description: The most recent task execution status.
enum:
- FAILED
- SUCCEEDED
type: string
lifecycleState:
description: 'The current state of the Log Analytics rule.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/ConfigLifecycleState'
targetService:
description: The target service.
type: string
taskStatus:
description: The task status of the rule.
enum:
- READY
- PAUSED
- COMPLETED
- BLOCKED
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeLastExecuted:
description: The date and time the scheduled task last executed, in the format defined by RFC3339.
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
- kind
type: object
LogAnalyticsFieldCollection:
description: LogAnalytics Field Collection
properties:
items:
description: An array of fields.
items:
$ref: '#/components/schemas/LogAnalyticsFieldSummary'
type: array
type: object
UploadFileCollection:
description: Collection of UploadFileSummary objects.
properties:
items:
description: List of UploadFileSummary objects.
items:
$ref: '#/components/schemas/UploadFileSummary'
type: array
required:
- items
type: object
DeleteLogAnalyticsAssociationDetails:
description: 'The information required to delete a list of associations.
'
properties:
compartmentId:
description: The compartment ID
type: string
items:
description: 'The information required to delete an association.
'
items:
$ref: '#/components/schemas/DeleteLogAnalyticsAssociation'
type: array
type: object
LogAnalyticsMetric:
description: LogAnalyticsMetric
properties:
aggregationField:
description: The aggregation field.
type: string
bucketMetadata:
description: The bucket metadata.
type: string
clockPeriod:
description: The clock period.
format: x-obmcs-duration
type: string
description:
description: The metric description.
type: string
displayName:
description: The metric display name.
type: string
editVersion:
description: The metric edit version.
format: int64
type: integer
entityType:
description: The entity type.
type: string
fieldName:
description: The field name.
type: string
fieldValues:
description: The field values.
items:
type: string
type: array
groupingField:
description: The grouping fields.
type: string
isEnabled:
description: 'A flag indicating whether or not the metric is enabled.
'
type: boolean
isMetricSourceEnabled:
description: 'A flag specifying whether or not the metric source is enabled.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isUserCustomized:
description: 'A flag specifying whether or not this is a custom (user defined) metric.
'
type: boolean
metricReference:
description: The metric unique identifier.
format: int64
type: integer
metricType:
default: COUNT
description: 'The metric type, specifying the type of aggregation to perform. Default value
is COUNT.
'
enum:
- COUNT
- SUM
- AVERAGE
- COUNT_DISTRIBUTION
- SUM_DISTRIBUTION
- AVERAGE_DISTRIBUTION
type: string
name:
description: The metric name.
type: string
operator:
default: CONTAINS_IGNORE_CASE
description: The metric operator.
enum:
- CONTAINS_IGNORE_CASE
- IN_IGNORE_CASE
- EQUAL_IGNORE_CASE
- NOT_NULL
type: string
sources:
description: The metric sources.
items:
$ref: '#/components/schemas/LogAnalyticsSource'
type: array
timeUpdated:
description: The last updated date.
format: date-time
type: string
unitType:
description: The unit type.
type: string
type: object
LogAnalyticsMetadata:
description: Entity metadata information.
properties:
name:
description: The metadata name.
type: string
type:
description: The metadata type.
type: string
value:
description: The metadata value.
type: string
type: object
LogAnalyticsPreferenceCollection:
description: A collection of preference information.
properties:
items:
description: An array of tenant preferences.
items:
$ref: '#/components/schemas/LogAnalyticsPreference'
type: array
type: object
UpsertLogAnalyticsSourceDetails:
description: UpsertLogAnalyticsSourceDetails
properties:
categories:
description: 'An array of categories to assign to the source. Specifying the name attribute for each category would suffice.
Oracle-defined category assignments cannot be removed.
'
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
dataFilterDefinitions:
description: An array of data filter definitions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceDataFilter'
type: array
databaseCredential:
description: The database credential name.
type: string
description:
description: The source description.
type: string
displayName:
description: The source display name.
type: string
editVersion:
description: The source edit version.
format: int64
type: integer
endpoints:
description: An array of REST API endpoints for log collection.
items:
$ref: '#/components/schemas/LogAnalyticsEndpoint'
type: array
entityTypes:
description: An array of entity types.
items:
$ref: '#/components/schemas/LogAnalyticsSourceEntityType'
type: array
extendedFieldDefinitions:
description: An array of extended field definitions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceExtendedFieldDefinition'
type: array
functions:
description: An array of source functions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceFunction'
type: array
isForCloud:
description: 'A flag indicating whether or not this is a cloud source.
'
type: boolean
isSecureContent:
description: 'A flag indicating whether or not the source content is secure.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isTimezoneOverride:
description: 'A flag indicating whether or not the source has a time zone override.
'
type: boolean
labelConditions:
description: An array of source label conditions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceLabelCondition'
type: array
labelDefinitions:
description: An array of labels.
items:
$ref: '#/components/schemas/LogAnalyticsLabelDefinition'
type: array
labels:
description: An array of labels.
items:
$ref: '#/components/schemas/LogAnalyticsLabelView'
type: array
metadataFields:
description: An array of source metadata fields.
items:
$ref: '#/components/schemas/LogAnalyticsSourceMetadataField'
type: array
metricDefinitions:
description: An array of metric definitions.
items:
$ref: '#/components/schemas/LogAnalyticsMetric'
type: array
metrics:
description: An array of metrics.
items:
$ref: '#/components/schemas/LogAnalyticsSourceMetric'
type: array
name:
description: The source internal name.
type: string
oobParsers:
description: An array of built in source parsers.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
parameters:
description: An array of parameters.
items:
$ref: '#/components/schemas/LogAnalyticsParameter'
type: array
parsers:
description: An array of parser.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
patterns:
description: An array of patterns.
items:
$ref: '#/components/schemas/LogAnalyticsSourcePattern'
type: array
ruleId:
description: The rule unique identifier.
format: int64
type: integer
sourceId:
description: The source unique identifier.
format: int64
type: integer
sourceProperties:
description: A list of source properties.
items:
$ref: '#/components/schemas/LogAnalyticsProperty'
type: array
typeName:
description: The source type internal name.
type: string
userParsers:
description: An array of custom parsers.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
warningConfig:
description: The source warning configuration.
format: int64
type: integer
type: object
OverlappingRecallCollection:
description: This is the list of overlapping recall requests
properties:
items:
description: This is the array of overlapping recall requests
items:
$ref: '#/components/schemas/OverlappingRecallSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"timeDataStarted\": \"2018-03-01T03:23:45.000Z\",\n \"timeDataEnded\": \"2018-03-15T17:53:26.000Z\",\n \"status\": \"RECALLED\",\n \"timeStarted\": \"2018-12-03T21:14:54.000Z\",\n \"purpose\": \"Investigate issue A\",\n \"queryString\": \"queryString\",\n \"logSets\": \"logset1,logset2\",\n \"createdBy\": \"string\",\n \"collectionId\": \"1234567890871263818\",\n \"recallId\": \"8234567890871263818\"\n },\n {\n \"timeDataStarted\": \"2019-03-01T03:23:45.000Z\",\n \"timeDataEnded\": \"2019-03-15T17:53:26.000Z\",\n \"status\": \"PENDING\",\n \"timeStarted\": \"2019-12-03T21:14:54.000Z\",\n \"purpose\": \"Recall for a query\",\n \"queryString\": \"queryString\",\n \"logSets\": \"logset1,logset2\",\n \"createdBy\": \"string\",\n \"collectionId\": \"-3234567890871263818\",\n \"recallId\": \"-875567890871263818\"\n }\n ]\n}\n"
LogAnalyticsTemplateSummary:
description: 'Summary of a template object.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
facets:
description: Facets of the template
items:
$ref: '#/components/schemas/TemplateFacet'
type: array
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
lifecycleState:
description: 'The current state of the template.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/ConfigLifecycleState'
name:
description: The template name.
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
type:
description: The template type.
type: string
required:
- id
- compartmentId
- timeCreated
- name
- lifecycleState
type: object
LogAnalyticsMetaSourceTypeCollection:
description: Source Meta Type List
properties:
items:
description: An array of meta source types.
items:
$ref: '#/components/schemas/LogAnalyticsMetaSourceType'
type: array
type: object
CreateIngestTimeRuleDetails:
description: 'The information required to create an ingest time rule.
'
properties:
actions:
description: 'The action(s) to be performed if the ingest time rule condition(s) are satisfied.
'
items:
$ref: '#/components/schemas/IngestTimeRuleAction'
type: array
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
conditions:
$ref: '#/components/schemas/IngestTimeRuleCondition'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: The ingest time rule display name.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
required:
- compartmentId
- displayName
- conditions
- actions
type: object
AddEntityAssociationDetails:
description: 'Information about the associations to be added between a source log analytics entity and other existing destination entities.
'
properties:
associationEntities:
description: 'Destination entities OCIDs with which associations are to be added.
'
items:
type: string
type: array
required:
- associationEntities
type: object
Namespace:
description: This is the namespace details of a tenancy in Log Analytics application
properties:
compartmentId:
description: The is the tenancy ID
type: string
isArchivingEnabled:
default: false
description: This indicates if old data can be archived for a tenancy
type: boolean
isDataEverIngested:
default: false
description: This indicates if data has ever been ingested for the tenancy in Log Analytics
type: boolean
isLogSetEnabled:
default: false
description: This indicates if the log set feature is enabled for the tenancy
type: boolean
isOnboarded:
description: This indicates if the tenancy is onboarded to Log Analytics
type: boolean
lifecycleState:
description: The current state of the compartment.
enum:
- ACTIVE
- INACTIVE
type: string
namespaceName:
description: This is the namespace name of a tenancy
type: string
required:
- namespaceName
- compartmentId
- isOnboarded
type: object
LabelPriorityCollection:
description: Label Priority Info List
properties:
items:
description: An array of label priorities.
items:
$ref: '#/components/schemas/LabelPriority'
type: array
type: object
AbstractParserTestResultLogEntry:
description: AbstractParserTestResultLogEntry
properties:
action:
description: The parser action.
type: string
extraInfoAttributes:
additionalProperties:
description: Additional properties on informational attributes.
type: string
description: Extra information attributes.
type: object
fieldMap:
additionalProperties:
description: Additional properties on the field map.
type: string
description: The field map.
type: object
fieldMapping:
description: Additional properties on the field map.
items:
$ref: '#/components/schemas/ParserTestResultFieldValue'
maxItems: 300
type: array
fieldNameValueMap:
additionalProperties:
description: Additional properties on the field name value map.
type: string
description: The field name value map.
type: object
fieldPositionValueMap:
additionalProperties:
description: Additional properties on the field position value map.
type: string
description: The field position value map.
type: object
fields:
additionalProperties:
description: Additional properties of the parser fields.
type: string
description: The parser fields.
type: object
functionNames:
description: The parser function names.
items:
type: string
maxItems: 3
type: array
logEntry:
description: The log entry.
type: string
loglines:
description: Test result log lines.
items:
$ref: '#/components/schemas/AbstractParserTestResultLogLine'
maxItems: 10
type: array
matchResult:
$ref: '#/components/schemas/RegexMatchResult'
matchStatus:
description: The match status.
type: string
matchStatusDescription:
description: The match status description.
type: string
metadata:
description: Additional properties on the field map if sub parser with actions defined.
items:
$ref: '#/components/schemas/ParserTestResultFieldValue'
maxItems: 300
type: array
textMatchInfo:
$ref: '#/components/schemas/AbstractParserTestResultLogLine'
timestampEndIndex:
description: "In case of regex parser, if there is any timestamp identified in the log entry, \nthis value signifies the index in the log entry at which timestamp ends.\n"
format: int32
type: integer
timestampEpochMillisec:
description: The timestamp epoch in milliseconds.
format: int64
type: integer
timestampStartIndex:
description: "In case of regex parser, if there is any timestamp identified in the log entry, \nthis value signifies the index in the log entry from which timestamp starts.\n"
format: int32
type: integer
timestampZone:
description: The timezone corresponding to the timestamp detected in the log entry (e.g. GMT).
type: string
type: object
SuggestOutput:
description: 'Typeahead results
'
properties:
commands:
description: 'Context specific list of querylanguage commands if input is seeking command suggestions.
'
items:
type: string
type: array
examples:
description: 'Context specific list of querylanguage querystring examples if input is seeking queryString example suggestions.
'
items:
type: string
type: array
fieldValues:
description: 'Context specific list of field values if input is seeking field value suggestions.
'
items:
type: string
type: array
fields:
description: 'Context specific list of querylanguage fields / columns if input is seeking field / column suggestions.
'
items:
type: string
type: array
options:
description: 'Context specific list of querylanguage command options if input is seeking command option suggestions.
'
items:
type: string
type: array
position:
description: 'Character position suggestion should be placed in queryString provided as input.
'
format: int32
type: integer
terms:
description: 'Context specific list of terms / phrases if input is seeking terms / phrase suggestions.
'
items:
type: string
type: array
required:
- position
type: object
LogAnalyticsMetadataSummary:
description: Details of entity metadata information.
properties:
items:
description: An array of entity metadata.
items:
$ref: '#/components/schemas/LogAnalyticsMetadata'
type: array
type: object
EstimateReleaseDataSizeResult:
description: This is the size and time range of data to be released
properties:
sizeInBytes:
description: This is the size in bytes
format: int64
type: integer
timeDataEnded:
description: 'This is the end of the time range of data to be released. timeDataStarted and timeDataEnded delineate
the time range of the recalled data to be released. They may not be exact the same as the
parameters in the request input (EstimateReleaseDataSizeDetails).
'
format: date-time
type: string
timeDataStarted:
description: This is the start of the time range of data to be released
format: date-time
type: string
required:
- sizeInBytes
- timeDataEnded
- timeDataStarted
type: object
LogAnalyticsEntityCollection:
description: 'Collection of log analytics entities.
'
properties:
items:
description: Array of log analytics entity summary.
items:
$ref: '#/components/schemas/LogAnalyticsEntitySummary'
type: array
required:
- items
type: object
LogAnalyticsParserFunctionCollection:
description: LogAnalyticsParserFunctionCollection
properties:
items:
description: An array of parser function.
items:
$ref: '#/components/schemas/LogAnalyticsParserFunction'
type: array
type: object
ExportDetails:
description: 'Input arguments for running a query synchronosly and streaming the results as soon as they become available.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
compartmentIdInSubtree:
default: false
description: 'Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
'
type: boolean
maxTotalCount:
description: "Maximum number of results retrieved from data source is determined by the specific query used and the maxTotalCount input field.\nIf the export results can be streamed, the maximum will be 1,000,000. \nIf the results cannot be streamed, the maximum limit is 500 for queries that include the link command\nand 10,000 for the queries that do not include the link command. \n\nQueries that include certain commands such as head, tail or stats cannot be streamed and are subject to a maximum of 10,000 results.\nQueries that include the sort command cannot be streamed unless the sort fields are restricted to id and/or time.\nThe maximum number of results retrieved is the lesser of the maxTotalCount input provided and the applicable limit described above.\n"
example: 500
format: int32
type: integer
outputFormat:
default: CSV
description: Specifies the format for the returned results.
enum:
- CSV
- JSON
- PARQUET
example: CSV
type: string
queryString:
description: Query to perform.
example: '* | stats count by ''Log Source'''
type: string
queryTimeoutInSeconds:
default: 120
description: Amount of time, in seconds, allowed for a query to execute. If this time expires before the query is complete, any partial results will be returned.
format: int32
maximum: 300
minimum: 5
type: integer
scopeFilters:
description: 'List of filters to be applied when the query executes. More than one filter per field is not permitted.
'
items:
$ref: '#/components/schemas/ScopeFilter'
maxItems: 7
minItems: 0
type: array
shouldIncludeColumns:
default: true
description: Include columns in response
type: boolean
shouldLocalize:
default: true
description: Localize results, including header columns, List-Of-Values and timestamp values.
type: boolean
shouldUseAcceleration:
default: true
description: 'Controls if query should ignore pre-calculated results if available and only use raw data.
'
type: boolean
subSystem:
description: 'Default subsystem to qualify fields with in the queryString if not specified.
'
enum:
- LOG
type: string
x-obmcs-top-level-enum: '#/definitions/SubSystemName'
timeFilter:
$ref: '#/components/schemas/TimeRange'
required:
- compartmentId
- queryString
- subSystem
type: object
LogAnalyticsEntityTopologySummary:
description: 'Log Analytics Entity topology that contains a set of log analytics entities and a set of relationships between those.
'
properties:
links:
$ref: '#/components/schemas/LogAnalyticsEntityTopologyLinkCollection'
nodes:
$ref: '#/components/schemas/LogAnalyticsEntityCollection'
required:
- nodes
- links
type: object
UploadFileStatus:
description: Upload File Status
properties:
fileName:
description: Name of the file.
type: string
isValid:
description: Is Valid flag.
type: boolean
type: object
ChangeIngestTimeRuleCompartmentDetails:
description: 'The information required to change the compartment of an ingest time rule.
'
properties:
compartmentId:
description: 'The OCID of the compartment where the log analytics entity should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
AutoAssociationCollection:
description: Auto association details of the source.
properties:
items:
description: Auto association details of the source.
items:
$ref: '#/components/schemas/AutoAssociationState'
type: array
type: object
PropertyOverride:
description: 'Property overrides at the scope of objects.
For example, if you want to use logSourceName as ''xyz'' for all objects that conatins string ''abc/'' then
define matchType as ''contains'', matchValue as ''abc/'', propertyName as ''logSourceName'' and propertyValue as ''xyz''.
'
properties:
matchType:
description: 'Match Type. Accepted values are: contains.
'
maxLength: 50
minLength: 1
type: string
matchValue:
description: Match Value.
maxLength: 1024
minLength: 1
type: string
propertyName:
description: 'Property to override. Accepted values are: logSourceName, charEncoding.
'
maxLength: 50
minLength: 1
type: string
propertyValue:
description: Value of the property.
maxLength: 255
minLength: 1
type: string
type: object
AbstractParserTestResultLogLine:
description: AbstractParserTestResultLogLine
properties:
findEndIndex:
description: The find end index.
format: int32
type: integer
findStartIndex:
description: The find start index.
format: int32
type: integer
grpNameValueMap:
additionalProperties:
$ref: '#/components/schemas/NamedCaptureValue'
description: The group name value map.
type: object
originalLogLine:
description: The original log line.
type: string
preProcessedLogLine:
description: The pre-processed log line.
type: string
replaceEndIndex:
description: The replace end index.
format: int32
type: integer
replaceStartIndex:
description: The replace start index.
format: int32
type: integer
replaceString:
description: The replacement string.
type: string
type: object
CreateLogAnalyticsEmBridgeDetails:
description: Details for a new enterprise manager bridge to be added.
properties:
bucketName:
description: Object store bucket name where enterprise manager harvested entities will be uploaded.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A description for log analytics enterprise manager bridge.
'
maxLength: 1024
minLength: 1
type: string
displayName:
description: 'Log analytics enterprise manager bridge display name.
'
maxLength: 128
minLength: 1
type: string
emEntitiesCompartmentId:
description: 'Compartment for entities created from enterprise manager.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
required:
- displayName
- compartmentId
- emEntitiesCompartmentId
- bucketName
type: object
UpdateLogAnalyticsEmBridgeDetails:
description: Log analytics entity type definition to be updated.
properties:
bucketName:
description: Object store bucket name where enterprise manager harvested entities will be uploaded.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A description for log analytics enterprise manager bridge.
'
maxLength: 1024
minLength: 1
type: string
displayName:
description: 'Log analytics enterprise manager bridge display name.
'
maxLength: 128
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type: object
ErrorDetails:
description: Error Information.
properties:
code:
description: A short error code that defines the error, meant for programmatic parsing.
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
AssociableEntityCollection:
description: The collection of entities that are eligible or ineligible to be associated to the source.
properties:
items:
description: An array of entities.
items:
$ref: '#/components/schemas/AssociableEntity'
type: array
type: object
LabelSummaryReport:
description: LabelSummaryReport
properties:
nonOobCount:
description: The count of custom (user defined) labels.
format: int32
type: integer
oobCount:
description: The count of built in labels.
format: int32
type: integer
type: object
Storage:
description: This is the storage configuration and status of a tenancy in Log Analytics application
properties:
archivingConfiguration:
$ref: '#/components/schemas/ArchivingConfiguration'
isArchivingEnabled:
default: false
description: This indicates if old data can be archived for a tenancy
type: boolean
required:
- isArchivingEnabled
- archivingConfiguration
type: object
RecalledDataSize:
description: 'This is the recall related data size for the given timeframe
'
properties:
notRecalledDataInBytes:
description: This is the size of the archival data not recalled yet
format: int64
type: integer
recalledDataInBytes:
description: This is the size of the recalled data
format: int64
type: integer
timeDataEnded:
description: This is the end of the time range of the archival data
format: date-time
type: string
timeDataStarted:
description: This is the start of the time range of the archival data
format: date-time
type: string
required:
- timeDataStarted
- timeDataEnded
- recalledDataInBytes
- notRecalledDataInBytes
type: object
x-example: "{\n \"timeDataStarted\": \"2018-01-01T03:23:45.000Z\",\n \"timeDataEnded\": \"2018-06-15T17:53:26.000Z\",\n \"recalledDataInBytes\": 953265025,\n \"notRecalledDataInBytes\": 12345678\n}\n"
ParseQueryOutput:
description: 'Returns a parser agnostic breakdown of a query string for client query string introspection.
'
properties:
columns:
description: 'List of columns returned by the specified query string as result output.
'
items:
$ref: '#/components/schemas/AbstractColumn'
type: array
commands:
description: 'List of querylanguage command descriptors, describing the specfied query string.
'
items:
$ref: '#/components/schemas/AbstractCommandDescriptor'
minItems: 1
type: array
displayQueryString:
description: 'Display string formatted by query builder of user specified query string.
'
type: string
internalQueryString:
description: 'Internal string formatted by query builder of user specified query string.
'
type: string
properties:
description: 'Optional list of properties for the query.
'
items:
$ref: '#/components/schemas/PropertyDefinition'
minItems: 0
type: array
responseTimeInMs:
description: 'Operation response time.
'
format: int64
type: integer
timeFilter:
$ref: '#/components/schemas/TimeRange'
variables:
description: 'Optional list of variables for the query.
'
items:
$ref: '#/components/schemas/VariableDefinition'
minItems: 0
type: array
required:
- displayQueryString
- internalQueryString
type: object
RemoveEntityAssociationsDetails:
description: 'Information about the associations to be deleted between source entity and other existing destination entities.
'
properties:
associationEntities:
description: 'Destination entities OCIDs with which associations are to be deleted
'
items:
type: string
type: array
required:
- associationEntities
type: object
ValidateEndpointResult:
description: The result of the endpoint configuration validation
properties:
status:
description: The validation status.
type: string
statusDescription:
description: The validation status description.
type: string
validationResults:
description: Validation results for each specified endpoint.
items:
$ref: '#/components/schemas/EndpointResult'
type: array
required:
- status
type: object
RecalledInfoCollection:
description: This is the list of recalled data for log explorer
properties:
items:
description: This is the array of recalled data
items:
$ref: '#/components/schemas/RecalledInfo'
type: array
required:
- items
type: object
LogAnalyticsResourceCategoryCollection:
description: A collection of resources and their category assignments.
properties:
categories:
description: 'An array of categories. The array contents include detailed information about
the distinct set of categories assigned to all the listed resources under items.
'
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
items:
description: A list of resources and their category assignments
items:
$ref: '#/components/schemas/LogAnalyticsResourceCategory'
type: array
type: object
UpsertLogAnalyticsFieldDetails:
description: Upsert LogAnalytics Field Details
properties:
dataType:
description: The data type.
type: string
description:
description: The field description.
type: string
displayName:
description: The field display name.
type: string
isKeepDuplicates:
description: 'A flag indicating whether duplicates should be retained while processing multi-valued fields.
'
type: boolean
isMultiValued:
description: 'A flag indicating whether or not the field is multi-valued.
'
type: boolean
name:
description: The field internal name.
type: string
type: object
LogAnalyticsEntityTopologyLinkCollection:
description: 'Collection of log analytics entity relationship links.
'
properties:
items:
description: Array of log analytics entity relationship links.
items:
$ref: '#/components/schemas/LogAnalyticsEntityTopologyLink'
type: array
required:
- items
type: object
FileValidationResponse:
description: Response object containing details about file upload eligibility.
properties:
files:
description: List of files inside the given archive file and their corresponding status information.
items:
$ref: '#/components/schemas/UploadFileStatus'
type: array
inputFile:
description: Input File Name.
type: string
objectLocation:
description: Object Location where file content is available.
type: string
required:
- inputFile
- objectLocation
type: object
ArchivingConfiguration:
description: This is the configuration for data archiving in object storage
properties:
activeStorageDuration:
description: 'This is the duration data in active storage before data is archived, as described in
https://en.wikipedia.org/wiki/ISO_8601#Durations.
The largest supported unit is D, e.g. P365D (not P1Y) or P14D (not P2W).
'
type: string
archivalStorageDuration:
description: 'This is the duration before archived data is deleted from object storage, as described in
https://en.wikipedia.org/wiki/ISO_8601#Durations
The largest supported unit is D, e.g. P365D (not P1Y) or P14D (not P2W).
'
type: string
timeOldestActiveBucketEnded:
description: end time of the oldest active CoreGroup
format: date-time
type: string
type: object
NamespaceSummary:
allOf:
- $ref: '#/components/schemas/Namespace'
description: The is the namespace summary of a tenancy in Log Analytics application
LogAnalyticsSourceSummary:
description: LogAnalyticsSourceSummary
properties:
associationCount:
description: The association count.
format: int32
type: integer
associationEntity:
description: The association entity.
items:
$ref: '#/components/schemas/LogAnalyticsAssociation'
type: array
dataFilterDefinitions:
description: The data filter definition.
items:
$ref: '#/components/schemas/LogAnalyticsSourceDataFilter'
type: array
databaseCredential:
description: The database credential.
type: string
description:
description: The source description.
type: string
displayName:
description: The source display name.
type: string
editVersion:
description: The source edit version.
format: int64
type: integer
endpoints:
description: An array of REST API endpoints for log collection.
items:
$ref: '#/components/schemas/LogAnalyticsEndpoint'
type: array
entityTypes:
description: The entity types.
items:
$ref: '#/components/schemas/LogAnalyticsSourceEntityType'
type: array
extendedFieldDefinitions:
description: The extended field definition.
items:
$ref: '#/components/schemas/LogAnalyticsSourceExtendedFieldDefinition'
type: array
functions:
description: The source functions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceFunction'
type: array
isAutoAssociationEnabled:
description: 'A flag indicating whether or not the source is marked for auto-association.
'
type: boolean
isAutoAssociationOverride:
description: 'A flag indicating whether or not the auto-association state should be overridden.
'
type: boolean
isForCloud:
description: 'A flag indicating whether or not this is a cloud source.
'
type: boolean
isSecureContent:
description: 'A flag indicating whether or not the source content is secure.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isTimezoneOverride:
description: 'A flag indicating whether or not the source has a time zone override.
'
type: boolean
labelConditions:
description: The label alert conditions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceLabelCondition'
type: array
labelDefinitions:
description: The label definitions.
items:
$ref: '#/components/schemas/LogAnalyticsLabelDefinition'
type: array
labels:
description: The labels associated with this source.
items:
$ref: '#/components/schemas/LogAnalyticsLabelView'
type: array
lifecycleState:
description: 'The current state of the Log Analytics source.
'
type: string
x-obmcs-enumref: '#/definitions/LogAnalyticsSource/lifecycleState'
metadataFields:
description: The source metadata fields.
items:
$ref: '#/components/schemas/LogAnalyticsSourceMetadataField'
type: array
metricDefinitions:
description: The metric definitions.
items:
$ref: '#/components/schemas/LogAnalyticsMetric'
type: array
metrics:
description: The metric source map.
items:
$ref: '#/components/schemas/LogAnalyticsSourceMetric'
type: array
name:
description: The source internal name.
type: string
oobParsers:
description: The built in source parser.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
parameters:
description: The parameter.
items:
$ref: '#/components/schemas/LogAnalyticsParameter'
type: array
parsers:
description: The list of parsers associated with this source.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
patternCount:
description: The pattern count.
format: int32
type: integer
patterns:
description: The source patterns.
items:
$ref: '#/components/schemas/LogAnalyticsSourcePattern'
type: array
ruleId:
description: The rule unique identifier.
format: int64
type: integer
sourceId:
description: The source unique identifier.
format: int64
type: integer
sourceProperties:
description: A list of source properties.
items:
$ref: '#/components/schemas/LogAnalyticsProperty'
type: array
timeUpdated:
description: The last updated date.
format: date-time
type: string
typeDisplayName:
description: The source type name.
type: string
typeName:
description: The source type internal name.
type: string
userParsers:
description: An array of custom parsers.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
warningConfig:
description: The source warning configuration.
format: int64
type: integer
type: object
LogAnalyticsObjectCollectionRule:
description: 'The configuration details of an Object Storage based collection rule.
'
properties:
charEncoding:
description: 'An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing.
It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters,
and very few alphabets.
For e.g. this applies when configuring VCN Flow Logs.
'
type: string
collectionType:
default: LIVE
description: 'The type of log collection.
'
enum:
- LIVE
- HISTORIC
- HISTORIC_LIVE
type: string
x-obmcs-top-level-enum: '#/definitions/ObjectCollectionRuleCollectionTypes'
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A string that describes the details of the rule. It does not have to be unique, and can be changed.
Avoid entering confidential information.
'
maxLength: 400
minLength: 0
type: string
entityId:
description: Log Analytics entity OCID to associate the processed logs with.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule.
maxLength: 255
minLength: 1
type: string
isEnabled:
default: true
description: 'Whether or not this rule is currently enabled.
'
type: boolean
isForceHistoricCollection:
description: 'Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
'
type: boolean
lastCollectedObject:
description: 'Last Collected Object for the rule
'
type: string
lifecycleDetails:
description: A detailed status of the life cycle state.
type: string
lifecycleState:
description: 'The current state of the rule.
'
enum:
- ACTIVE
- DELETED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/ObjectCollectionRuleLifecycleStates'
logGroupId:
description: Log Analytics Log group OCID to associate the processed logs with.
type: string
logSet:
description: "The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data \nand this feature has to be enabled for a given tenancy prior to its usage.\nWhen logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically \nusing logSetKey and logSetExtRegex.\n"
maxLength: 128
minLength: 1
type: string
logSetExtRegex:
description: 'The regex to be applied against given logSetKey. Regex has to be in string escaped format.
'
maxLength: 255
minLength: 1
type: string
logSetKey:
default: OBJECT_PATH
description: 'An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
'
enum:
- OBJECT_PATH
type: string
x-obmcs-top-level-enum: '#/definitions/LogSetKeyTypes'
logSourceName:
description: Name of the Log Analytics Source to use for the processing.
type: string
logType:
description: 'Type of files/objects in this object collection rule.
'
enum:
- LOG
- LOG_EVENTS
type: string
x-obmcs-top-level-enum: '#/definitions/LogTypes'
name:
description: A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
maxLength: 255
minLength: 1
type: string
objectNameFilters:
description: 'When the filters are provided, only the objects matching the filters are picked up for processing.
The matchType supported is exact match and accommodates wildcard "*".
For more information on filters, see [Event Filters](https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm).
'
items:
maxLength: 1024
minLength: 1
type: string
type: array
osBucketName:
description: Name of the Object Storage bucket.
type: string
osNamespace:
description: Object Storage namespace.
type: string
overrides:
additionalProperties:
items:
$ref: '#/components/schemas/PropertyOverride'
type: array
description: 'Use this to override some property values which are defined at bucket level to the scope of object.
Supported propeties for override are: logSourceName, charEncoding, entityId.
Supported matchType for override are "contains".
'
type: object
pollSince:
default: CURRENT_TIME
description: 'The oldest time of the file in the bucket to consider for collection.
Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string.
Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
'
type: string
pollTill:
default: 'null'
description: 'The newest time of the file in the bucket to consider for collection.
Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string.
Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error.
'
type: string
streamCursorTime:
description: "The time from which to consume the objects, if streamCursorType is AT_TIME. \n"
format: date-time
type: string
streamCursorType:
description: "Cursor type used to fetch messages from stream.\nWhen the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. \nOtherwise, the behaviour is to consume from the oldest available message in the stream. \nWhen the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. \nWhen the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. \nWhen the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. \nFor more information on cursor types, see [Stream Consumer Groups](https://docs.oracle.com/en-us/iaas/Content/Streaming/Tasks/using_consumer_groups.htm).\n"
enum:
- DEFAULT
- TRIM_HORIZON
- LATEST
- AT_TIME
type: string
x-obmcs-top-level-enum: '#/definitions/StreamCursorTypes'
streamId:
description: 'A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: The time when this rule was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time when this rule was last updated. An RFC3339 formatted datetime string.
format: date-time
type: string
timezone:
description: "Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. \nWhen this property is not specified, the timezone of the entity specified is used. \nIf the entity is also not specified or do not have a valid timezone then UTC is used.\n"
format: x-obmcs-time-zone
maxLength: 50
minLength: 1
type: string
required:
- id
- name
- compartmentId
- osNamespace
- osBucketName
- logGroupId
- logSourceName
- collectionType
- pollSince
- timeCreated
- timeUpdated
- lifecycleState
- isEnabled
type: object
ReleaseRecalledDataDetails:
description: 'This is the input used to release recalled data
'
properties:
collectionId:
description: 'This is the id for the recalled data collection to be released.
If specified, only this collection will be released
'
format: int64
type: integer
compartmentId:
description: This is the compartment OCID for permission checking
type: string
dataType:
description: This is the type of the recalled data to be released
enum:
- LOG
- LOOKUP
type: string
x-obmcs-top-level-enum: '#/definitions/StorageDataType'
timeDataEnded:
description: This is the end of the time interval
format: date-time
type: string
timeDataStarted:
description: This is the start of the time interval
format: date-time
type: string
required:
- compartmentId
- timeDataEnded
- timeDataStarted
type: object
LogAnalyticsSourceDataFilter:
description: LogAnalyticsSourceDataFilter
properties:
dataFilterId:
description: The filter unique identifier.
format: int64
type: integer
description:
description: The filter description.
type: string
displayName:
description: The filter display name.
type: string
editVersion:
description: The filter edit version.
format: int64
type: integer
fieldName:
description: The field internal name.
type: string
filterType:
default: MASK
description: The filter type.
enum:
- MASK
- HASH_MASK
- DROP_LOG_ENTRY
- DROP_STRING
type: string
hashType:
description: The hash type.
format: int32
type: integer
isEnabled:
description: 'A flag indicating whether or not the filter is enabled.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
matchRegularExpression:
description: The regular expression for matching.
type: string
order:
description: The filter order.
format: int64
type: integer
path:
description: The filter path.
type: string
replacementString:
description: The replacement string.
type: string
sourceId:
description: The source unique identifier.
format: int64
type: integer
type: object
LogAnalyticsPreferenceDetails:
description: Preference information used to update preference settings.
properties:
items:
description: An array of tenant preference details.
items:
$ref: '#/components/schemas/LogAnalyticsPreference'
type: array
type: object
StorageWorkRequestSummary:
allOf:
- $ref: '#/components/schemas/StorageWorkRequest'
description: 'This is the summary of a storage work request.
'
LogAnalyticsCategoryCollection:
description: A collection of categories.
properties:
items:
description: An array of categories.
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
type: object
StatusSummary:
description: StatusSummary
properties:
chunksProcessed:
description: The number of chunks processed.
format: int64
type: integer
failureDetails:
description: The failure details, if any.
type: string
filename:
description: The filename.
type: string
status:
description: The status.
type: string
totalChunks:
description: The total number of chunks.
format: int64
type: integer
type: object
UploadCollection:
description: Collection of UploadSummary objects.
properties:
items:
description: List of UploadSummary objects.
items:
$ref: '#/components/schemas/UploadSummary'
type: array
required:
- items
type: object
TemplateFacet:
description: 'A facet of a template that may help in searching or filtering.
'
properties:
name:
description: The facet name.
type: string
value:
description: The facet value.
type: string
required:
- name
- value
type: object
FieldValue:
description: 'Field value representing and entry in a list-of-values field.
'
properties:
displayValue:
description: 'Display representation of the field value.
'
type: string
internalValue:
description: 'Internal representation of the field value.
'
type: object
isDeleted:
description: 'Denotes if this list-of-values value has been marked as deleted.
'
type: boolean
type: object
Level:
description: An object used to represent a level at which a property or resource or constraint is defined.
properties:
constraints:
description: 'A string representation of constraints that apply at this level.
For example, a property defined at SOURCE level could further be applicable only for SOURCE_TYPE:database_sql.
'
type: string
name:
description: The level name.
type: string
required:
- name
type: object
LogAnalyticsObjectCollectionRuleSummary:
description: 'The summary of an Object Storage based collection rule.
'
properties:
collectionType:
default: LIVE
description: 'The type of log collection.
'
enum:
- LIVE
- HISTORIC
- HISTORIC_LIVE
type: string
x-obmcs-top-level-enum: '#/definitions/ObjectCollectionRuleCollectionTypes'
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.
Avoid entering confidential information.
'
maxLength: 400
minLength: 0
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule.
maxLength: 255
minLength: 1
type: string
isEnabled:
default: true
description: 'Whether or not this rule is currently enabled.
'
type: boolean
lifecycleDetails:
description: A detailed status of the life cycle state.
type: string
lifecycleState:
description: 'The current state of the rule.
'
enum:
- ACTIVE
- DELETED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/ObjectCollectionRuleLifecycleStates'
logType:
description: 'Type of files/objects in this object collection rule.
'
enum:
- LOG
- LOG_EVENTS
type: string
x-obmcs-top-level-enum: '#/definitions/LogTypes'
name:
description: A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
maxLength: 255
minLength: 1
type: string
objectNameFilters:
description: 'When the filters are provided, only the objects matching the filters are picked up for processing.
The matchType supported is exact match and accommodates wildcard "*".
For more information on filters, see [Event Filters](https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm).
'
items:
maxLength: 1024
minLength: 1
type: string
type: array
osBucketName:
description: Name of the Object Storage bucket.
type: string
osNamespace:
description: Object Storage namespace.
type: string
streamId:
description: 'A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: The time when this rule was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time when this rule was last updated. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- id
- name
- compartmentId
- osNamespace
- osBucketName
- collectionType
- timeCreated
- timeUpdated
- lifecycleState
- isEnabled
type: object
QueryWorkRequestSummary:
description: 'High level summary of query job work request.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
id:
description: 'Unique OCID identifier to reference this query job work Request with.
'
type: string
mode:
description: Current execution mode for the job.
enum:
- FOREGROUND
- BACKGROUND
type: string
x-obmcs-top-level-enum: '#/definitions/JobMode'
operationType:
description: 'Asynchronous action name.
'
enum:
- EXECUTE_QUERY_JOB
- EXECUTE_PURGE_JOB
type: string
x-obmcs-top-level-enum: '#/definitions/QueryOperationType'
percentComplete:
description: 'Percentage progress completion of the query.
'
format: int32
maximum: 100
minimum: 0
type: integer
status:
description: 'Work request status.
'
enum:
- ACCEPTED
- CANCELED
- FAILED
- IN_PROGRESS
- SUCCEEDED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
timeAccepted:
description: 'When the work request was accepted. Should match timeStarted in all cases.
'
format: date-time
type: string
timeExpires:
description: When the work request will expire.
format: date-time
type: string
timeFinished:
description: When the work request finished execution.
format: date-time
type: string
timeStarted:
description: When the work request started.
format: date-time
type: string
required:
- id
- timeStarted
- mode
type: object
CreateLogAnalyticsEntityTypeDetails:
description: Details for new log analytics entity type to be added.
properties:
category:
description: 'Log analytics entity type category. Category will be used for grouping and filtering.
'
maxLength: 128
minLength: 1
type: string
name:
description: 'Log analytics entity type name.
'
maxLength: 128
minLength: 1
type: string
properties:
description: Log analytics entity type property definition.
items:
$ref: '#/components/schemas/EntityTypeProperty'
type: array
required:
- name
type: object
ScopeFilter:
description: 'Scope filter to reduce the scope of the query.
'
properties:
fieldName:
description: 'Field must be a valid log analytics out-of-the-box field.
'
type: string
values:
description: 'Field values that will be used to filter the query scope. Please note all values should reflect the fields data type otherwise the query is subject to fail.
'
items:
type: object
maxItems: 1000
minItems: 1
type: array
required:
- fieldName
- values
LogAnalyticsMetaFunctionArgument:
description: LogAnalyticsMetaFunctionArgument
properties:
argumentDataType:
description: The argument data type.
type: string
argumentDescription:
description: The argument description.
type: string
argumentDisplayName:
description: The argument display name.
type: string
argumentExample:
description: The argument example.
type: string
argumentId:
description: The argument unique identifier.
format: int64
type: integer
argumentLookupColumn:
description: The lookup column.
type: string
argumentLookupColumnPosition:
description: The lookup column position.
format: int64
type: integer
argumentName:
description: The argument name.
type: string
argumentOrder:
description: The argument order.
format: int64
type: integer
argumentReference:
description: The argument unique identifier as a string.
type: string
argumentService:
description: The argument service.
type: string
argumentType:
description: The argument type.
format: int64
type: integer
argumentValue:
description: The argument value.
type: string
isOverrideOutputFields:
description: The override output fields.
type: boolean
type: object
LogAnalyticsImportCustomChangeList:
description: LogAnalyticsImportCustomChangeList
properties:
conflictFieldDisplayNames:
description: A list of field display names with conflicts.
items:
type: string
type: array
conflictParserNames:
description: A list of parser names with conflicts.
items:
type: string
type: array
conflictSourceNames:
description: A list of source names with conflicts.
items:
type: string
type: array
createdFieldDisplayNames:
description: An array of created field display names.
items:
type: string
type: array
createdParserNames:
description: An array of created parser names.
items:
type: string
type: array
createdSourceNames:
description: An array of created source names.
items:
type: string
type: array
updatedFieldDisplayNames:
description: An array of updated field display names.
items:
type: string
type: array
updatedParserNames:
description: An array of updated parser names.
items:
type: string
type: array
updatedSourceNames:
description: An array of updated source names.
items:
type: string
type: array
type: object
LogAnalyticsEntityTypeSummary:
description: 'Summary of a log analytics entity type.
'
properties:
category:
description: 'Log analytics entity type category. Category will be used for grouping and filtering.
'
maxLength: 128
minLength: 1
type: string
cloudType:
description: 'Log analytics entity type group. This can be CLOUD (OCI) or NON_CLOUD otherwise.
'
enum:
- CLOUD
- NON_CLOUD
- ALL
type: string
x-obmcs-top-level-enum: '#/definitions/EntityCloudType'
internalName:
description: 'Internal name for the log analytics entity type.
'
maxLength: 160
minLength: 1
type: string
lifecycleState:
description: 'The current lifecycle state of the log analytics entity type.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/EntityLifecycleStates'
managementAgentEligibilityStatus:
description: 'This field indicates whether logs for entities of this type can be collected using a management agent.
'
enum:
- ELIGIBLE
- INELIGIBLE
- UNKNOWN
type: string
name:
description: 'Log analytics entity type name.
'
maxLength: 128
minLength: 1
type: string
timeCreated:
description: 'Time the log analytics entity type was created. An RFC3339 formatted datetime string.
'
format: date-time
type: string
timeUpdated:
description: 'Time the log analytics entity type was updated. An RFC3339 formatted datetime string.
'
format: date-time
type: string
required:
- name
- internalName
- category
- cloudType
- timeCreated
- timeUpdated
- lifecycleState
type: object
WorkRequestLog:
description: This is a log message from the execution of a work request.
properties:
message:
description: This is a human-readable log message.
type: string
timestamp:
description: This is the time the log message was written. An RFC3339 formatted datetime string
format: date-time
type: string
required:
- message
- timestamp
RuleSummaryReport:
description: A summary count of detection rules.
properties:
ingestTimeRulesCount:
description: The count of ingest time rules.
format: int32
type: integer
savedSearchRulesCount:
description: The count of saved search rules.
format: int32
type: integer
totalCount:
description: The total count of detection rules.
format: int32
type: integer
required:
- totalCount
- ingestTimeRulesCount
- savedSearchRulesCount
type: object
CreateScheduledTaskDetails:
description: 'Details for creating a scheduled task.
'
discriminator:
propertyName: kind
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
kind:
description: Discriminator.
enum:
- ACCELERATION
- STANDARD
type: string
required:
- kind
- compartmentId
type: object
LogAnalyticsLookup:
description: LogAnalyticsLookup
properties:
activeEditVersion:
description: The active edit version.
format: int64
type: integer
canonicalLink:
description: The canonical link.
type: string
categories:
description: 'An array of categories assigned to this lookup.
The isSystem flag denotes if each category assignment is user-created or Oracle-defined.
'
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: The lookup description.
type: string
editVersion:
description: The edit version.
format: int64
type: integer
fields:
description: The lookup fields.
items:
$ref: '#/components/schemas/LookupField'
type: array
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
isBuiltIn:
description: 'A flag indicating if the lookup is custom (user-defined) or
built in.
'
format: int64
type: integer
isHidden:
description: 'A flag indicating if the lookup is hidden or not. A hidden lookup will
not be returned in list operations by default.
'
type: boolean
lookupDisplayName:
description: The lookup display name.
type: string
lookupReference:
description: The lookup reference as an integer.
format: int64
type: integer
lookupReferenceString:
description: The lookup reference as a string.
type: string
name:
description: The lookup name.
type: string
referringSources:
$ref: '#/components/schemas/AutoLookups'
statusSummary:
$ref: '#/components/schemas/StatusSummary'
timeUpdated:
description: The last updated date.
format: date-time
type: string
type:
default: Lookup
description: The lookup type. Valid values are Lookup, Dictionary or Module.
enum:
- Lookup
- Dictionary
- Module
type: string
type: object
LogAnalyticsSourceCollection:
description: LogAnalyticsSourceCollection
properties:
items:
description: An array of sources.
items:
$ref: '#/components/schemas/LogAnalyticsSourceSummary'
type: array
type: object
StorageWorkRequestCollection:
description: 'This is a list of work request summaries.
'
properties:
items:
description: 'This is an array of work request summaries.
'
items:
$ref: '#/components/schemas/StorageWorkRequestSummary'
type: array
required:
- items
type: object
LogAnalyticsConfigWorkRequestSummary:
description: LogAnalyticsConfigWorkRequestSummary
properties:
compartmentId:
description: The compartment unique identifier.
type: string
id:
description: The workrequest unique identifier.
type: string
lifecycleState:
description: 'The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED
or FAILED.
'
enum:
- ACCEPTED
- IN_PROGRESS
- SUCCEEDED
- FAILED
type: string
operationType:
description: The operation type
enum:
- CREATE_ASSOCIATIONS
- DELETE_ASSOCIATIONS
- APPEND_LOOKUP_DATA
- UPDATE_LOOKUP_DATA
- DELETE_LOOKUP
- ENABLE_INGEST_TIME_RULE
- DISABLE_INGEST_TIME_RULE
type: string
percentComplete:
description: The completion percentage.
format: int64
type: integer
timeAccepted:
description: The time at which the work request was accepted.
format: date-time
type: string
timeFinished:
description: The time at which the work request finished.
format: date-time
type: string
type: object
UsageStatusItem:
description: UsageStatusItem
properties:
currentUsage:
description: The current usage of the field.
format: int64
type: integer
dataType:
description: The field data type.
type: string
isKeepDuplicates:
description: 'A flag indicating whether duplicates should be retained while processing multi-valued fields.
'
type: boolean
isMultiValued:
description: 'A flag indicating whether or not the field is multi-valued.
'
type: boolean
maxAvailable:
description: The maximum availability of the field.
format: int32
type: integer
type: object
LogAnalyticsLogGroup:
description: 'Summary of an Log-Analytics log group.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- displayName
- compartmentId
type: object
LookupSummaryReport:
description: Summary report of lookups in the tenancy.
properties:
oracleDefinedCount:
description: The number of oracle defined lookups.
format: int32
type: integer
totalCount:
description: The total number of lookups.
format: int32
type: integer
userCreatedCount:
description: The number of user created lookups.
format: int32
type: integer
type: object
EndpointResult:
description: The validation status of a specified endpoint.
properties:
endpointName:
description: The endpoint name.
type: string
logEndpoints:
description: The resolved log endpoints based on the specified list endpoint response.
items:
type: string
type: array
status:
description: The endpoint validation status.
type: string
url:
description: The endpoint URL.
type: string
violations:
description: The list of violations (if any).
items:
$ref: '#/components/schemas/Violation'
type: array
type: object
LogAnalyticsConfigWorkRequest:
description: LogAnalyticsConfigWorkRequest
properties:
compartmentId:
description: The compartment unique identifier.
type: string
id:
description: The workrequest unique identifier.
type: string
lifecycleState:
description: 'The lifecycle status. Valid values are ACCEPTED, IN_PROGRESS, SUCCEEDED
or FAILED
'
enum:
- ACCEPTED
- IN_PROGRESS
- SUCCEEDED
- FAILED
type: string
operationType:
description: The operation type
enum:
- CREATE_ASSOCIATIONS
- DELETE_ASSOCIATIONS
- APPEND_LOOKUP_DATA
- UPDATE_LOOKUP_DATA
- DELETE_LOOKUP
- ENABLE_INGEST_TIME_RULE
- DISABLE_INGEST_TIME_RULE
type: string
payload:
description: The list of config work request responses.
items:
$ref: '#/components/schemas/LogAnalyticsConfigWorkRequestPayload'
type: array
percentComplete:
description: The completion percentage.
format: int64
type: integer
timeAccepted:
description: The time at which the work request was accepted.
format: date-time
type: string
timeFinished:
description: The time at which the work request was finished.
format: date-time
type: string
timeStarted:
description: The time at which the work request was started.
format: date-time
type: string
type: object
SourceMappingResponse:
description: Response object containing match status and parsed representation of log data.
properties:
parsedResponse:
description: Parsed representation of the log file.
items:
$ref: '#/components/schemas/ParsedContent'
type: array
required:
- parsedResponse
type: object
LogAnalyticsObjectCollectionRuleCollection:
description: Collection of LogAnalyticsObjectCollectionRuleSummary objects.
properties:
items:
description: List of LogAnalyticsObjectCollectionRuleSummary objects.
items:
$ref: '#/components/schemas/LogAnalyticsObjectCollectionRuleSummary'
type: array
required:
- items
type: object
AssignEncryptionKeyDetails:
description: "This is the input used to assign customer encryption key. \n"
properties:
keyId:
description: This is the key OCID for encryption key.
type: string
keyType:
description: This is the type of data to be encrypted. It can be either active or archival.
enum:
- ACTIVE_DATA
- ARCHIVAL_DATA
- ALL
type: string
x-obmcs-top-level-enum: '#/definitions/EncryptionKeyType'
required:
- keyId
- keyType
type: object
ValidateLabelConditionResult:
description: The result of the label condition validation
properties:
conditionBlock:
$ref: '#/components/schemas/ConditionBlock'
conditionString:
description: String representation of the validated label condition.
type: string
evaluationResult:
description: 'The result of evaluating the condition blocks against the specified field values. Either true or false.
'
type: boolean
fieldValues:
description: Field values against which the label condition was evaluated.
items:
$ref: '#/components/schemas/LogAnalyticsProperty'
type: array
status:
description: The validation status.
type: string
statusDescription:
description: The validation status description.
type: string
required:
- conditionString
- conditionBlock
- status
type: object
ExtendedFieldsValidationResult:
description: ExtendedFieldsValidationResult
properties:
items:
description: The regular expression evaluation result of an extended field definition.
items:
$ref: '#/components/schemas/EfdRegexResult'
type: array
type: object
FilterDetails:
description: 'Query builder edit request details.
'
properties:
filters:
description: 'List of edit operations to be applied in the specified order to the specified queryString.
'
items:
$ref: '#/components/schemas/Filter'
type: array
queryString:
description: Query to apply edits to.
type: string
subSystem:
description: 'Default subsystem to qualify fields with in the queryString if not specified.
'
enum:
- LOG
type: string
x-obmcs-top-level-enum: '#/definitions/SubSystemName'
required:
- queryString
- subSystem
type: object
Upload:
description: 'Upload is a container that can be used to put all the relevant and related on-demand upload based log files together.
'
properties:
name:
description: The name of the upload container.
type: string
reference:
description: Unique internal identifier to refer the upload container.
type: string
timeCreated:
description: The time when this upload container is created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeEarliestLogEntry:
description: This time represents the earliest time of the log entry in this container. An RFC3339 formatted datetime string.
format: date-time
type: string
timeLatestLogEntry:
description: This time represents the latest time of the log entry in this container. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The latest time when this upload container is modified. An RFC3339 formatted datetime string.
format: date-time
type: string
warningsCount:
description: Number of warnings associated to the upload.
type: integer
required:
- reference
- name
- timeCreated
type: object
LogAnalyticsSourceEntityType:
description: LogAnalyticsSourceEntityType
properties:
entityType:
description: The entity type.
type: string
entityTypeCategory:
description: The type category.
type: string
entityTypeDisplayName:
description: The entity type display name.
type: string
sourceId:
description: The source unique identifier.
format: int64
type: integer
type: object
StorageUsage:
description: This is the storage usage information of a tenancy in Log Analytics application
properties:
activeDataSizeInBytes:
description: This is the number of bytes of active data (non-archived)
format: int64
type: integer
archivedDataSizeInBytes:
description: This is the number of bytes of archived data in object storage
format: int64
type: integer
recalledArchivedDataSizeInBytes:
description: This is the number of bytes of recalled data from archived in object store
format: int64
type: integer
required:
- activeDataSizeInBytes
- archivedDataSizeInBytes
- recalledArchivedDataSizeInBytes
type: object
LogAnalyticsEntityTopologyCollection:
description: 'Collection of log analytics entity topologies.
'
properties:
items:
description: Array of log analytics entity topologies.
items:
$ref: '#/components/schemas/LogAnalyticsEntityTopologySummary'
type: array
required:
- items
type: object
LogAnalyticsSourcePatternCollection:
description: LogAnalyticsSourcePatternCollection
properties:
items:
description: An array of source patterns.
items:
$ref: '#/components/schemas/LogAnalyticsSourcePattern'
type: array
type: object
ColumnName:
description: Column Names from a SQL Query
properties:
name:
description: The column name from a SQL query.
type: string
type: object
LogAnalyticsParserMetaPlugin:
description: LogAnalyticsParserMetaPlugin
properties:
description:
description: The plugin description.
type: string
displayName:
description: The plugin display name.
type: string
metaPluginParameters:
description: An array of plugin parameters.
items:
$ref: '#/components/schemas/LogAnalyticsParserMetaPluginParameter'
type: array
name:
description: The plugin internal name.
type: string
type: object
LogAnalyticsExtendedField:
description: LogAnalyticsExtendedField
properties:
extendedFieldDefinition:
$ref: '#/components/schemas/LogAnalyticsSourceExtendedFieldDefinition'
extendedFieldDefinitionId:
description: The extended field unique identifier.
format: int64
type: integer
extendedFieldId:
description: The extended field unique identifier.
format: int64
type: integer
field:
$ref: '#/components/schemas/LogAnalyticsField'
fieldDisplayName:
description: The field internal display name.
type: string
fieldName:
description: The field internal name
type: string
savedRegularExpressionName:
description: The saved regular expression name.
type: string
type: object
FilterOutput:
description: 'Query builder api response object containing updated querystring''s
'
properties:
displayQueryString:
description: 'Modified user visible query string.
'
type: string
internalQueryString:
description: 'Modified localization agnostic query string.
'
type: string
responseTimeInMs:
description: 'Operation response time.
'
format: int64
type: integer
required:
- displayQueryString
- internalQueryString
type: object
LogAnalyticsLabelOperator:
description: LogAnalyticsLabelOperator
properties:
displayName:
description: The operator display name.
type: string
name:
description: The operator internal name.
type: string
type: object
LogAnalyticsLabelView:
description: LogAnalyticsLabelView
properties:
aliases:
description: An array of label aliases.
items:
$ref: '#/components/schemas/LogAnalyticsLabelAlias'
type: array
countUsageInAlertRule:
description: The label alert rule usage count.
format: int64
type: integer
countUsageInSource:
description: The label source usage count.
format: int64
type: integer
description:
description: The label description.
type: string
displayName:
description: The label display name.
type: string
editVersion:
description: The label edit version.
format: int64
type: integer
id:
description: The label unique identifier.
type: object
impact:
description: The label impact.
type: string
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isUserDeleted:
description: 'A flag indicating whether or not the label has been deleted.
'
type: boolean
name:
description: The label name.
type: string
priority:
default: NONE
description: The label priority. Default value is NONE.
enum:
- NONE
- LOW
- MEDIUM
- HIGH
type: string
recommendation:
description: The label recommendation.
type: string
suggestType:
description: The label suggestion type.
format: int64
type: integer
type:
description: The label type.
format: int64
type: integer
type: object
GenericConditionBlock:
description: 'A condition block. This could represent a single condition, or have nested condition blocks under it.
To form a single condition, specify the name, operator and value(s).
To form nested conditions, specify the conditions in conditionBlocks, and how to join them in conditionBlocksOperator.
'
properties:
conditionBlocksOperator:
description: 'Operator using which the conditionBlocks should be joined. Specify this for nested conditions.
'
enum:
- AND
- OR
- NOT_AND
- NOT_OR
type: string
genericConditionBlocks:
description: 'Condition blocks to evaluate within this condition block. Specify this for nested conditions.
'
items:
$ref: '#/components/schemas/GenericConditionBlock'
maxItems: 20
type: array
name:
description: 'The name of the field the condition is based on. Specify this if this condition block represents a single condition.
'
type: string
operator:
description: 'The condition operator. Specify this if this condition block represents a single condition.
'
type: string
value:
description: 'The condition value. Specify this if this condition block represents a single condition.
'
type: string
values:
description: 'A list of condition values. Specify this if this condition block represents a single condition.
'
items:
type: string
maxItems: 100
minItems: 0
type: array
type: object
Schedule:
description: Schedule for scheduled task.
discriminator:
propertyName: type
properties:
misfirePolicy:
default: RETRY_INDEFINITELY
description: Schedule misfire retry policy.
enum:
- RETRY_ONCE
- RETRY_INDEFINITELY
- SKIP
type: string
queryOffsetSecs:
default: 0
description: Number of seconds to offset the query time window by to accommodate capture late arriving data. For example, a schedule run at 12:00 with a 10 minute interval and queryOffsetSecs=120 will use the query time window of 11:48-11:58 rather than 11:50-12:00 without queryOffsetSecs.
format: int32
type: integer
timeEnd:
description: 'End time for the schedule, even if the schedule would otherwise have remaining executions.
'
format: date-time
type: string
timeOfFirstExecution:
description: 'The date and time the scheduled task should execute first time after create or update;
thereafter the task will execute as specified in the schedule.
'
format: date-time
type: string
type:
default: AUTO
description: Schedule type discriminator.
enum:
- FIXED_FREQUENCY
- CRON
- AUTO
type: string
required:
- type
type: object
ParsedContent:
description: Parsed representation of the log file.
properties:
fieldDisplayNames:
description: List of field display names.
items:
type: string
type: array
fieldNames:
description: List of field names.
items:
type: string
type: array
logContent:
description: Sample log entries picked up from the given file for validation.
type: string
matchStatus:
description: Match Status.
type: string
parsedFieldValues:
description: Parsed field values.
items:
$ref: '#/components/schemas/ParsedField'
type: array
sampleSize:
description: Sample Size taken for validation.
type: integer
type: object
LogAnalyticsImportCustomContent:
description: LogAnalyticsImportCustomContent
properties:
changeList:
$ref: '#/components/schemas/LogAnalyticsImportCustomChangeList'
contentName:
description: The content name.
type: string
fieldNames:
description: The field names.
items:
type: string
type: array
parserNames:
description: The parser names.
items:
type: string
type: array
sourceNames:
description: The source names.
items:
type: string
type: array
type: object
IngestTimeRuleSummary:
description: 'Summary of an ingest time rule.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
conditionKind:
description: 'The ingest time rule condition kind.
'
enum:
- FIELD
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: The ingest time rule display name.
type: string
fieldName:
description: The ingest time rule condition field name.
type: string
fieldValue:
description: The ingest time rule condition field value.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
isEnabled:
description: A flag indicating whether or not the ingest time rule is enabled.
type: boolean
lifecycleState:
description: 'The current state of the ingest time rule.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/ConfigLifecycleState'
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
type: object
LogAnalyticsAssociatedEntity:
description: LogAnalyticsAssociatedEntity
properties:
associationCount:
description: The association count for the entity.
format: int64
type: integer
entityId:
description: The entity unique identifier.
type: string
entityName:
description: The entity name.
type: string
entityType:
description: The entity type.
type: string
entityTypeDisplayName:
description: The entity type display name.
type: string
onHost:
description: The host associated with the entity.
type: string
type: object
UpsertLogAnalyticsParserDetails:
description: UpsertLogAnalyticsParserDetails
properties:
categories:
description: 'An array of categories to assign to the parser. Specifying the name attribute for each category would suffice.
Oracle-defined category assignments cannot be removed.
'
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
content:
description: The content.
type: string
description:
description: The parser description.
type: string
displayName:
description: The parser display name.
type: string
editVersion:
description: The parser edit version.
format: int64
type: integer
encoding:
description: The encoding.
type: string
exampleContent:
description: Example content.
type: string
fieldDelimiter:
description: The parser field delimiter.
type: string
fieldMaps:
description: The parser fields.
items:
$ref: '#/components/schemas/LogAnalyticsParserField'
type: array
fieldQualifier:
description: The parser field qualifier.
type: string
footerContent:
description: The footer regular expression.
type: string
headerContent:
description: The header content.
type: string
isDefault:
description: 'A flag indicating if this is a default parser.
'
type: boolean
isNamespaceAware:
description: 'A flag indicating whether the XML parser should consider the namespace(s) while processing the log data.
'
type: boolean
isParserWrittenOnce:
description: 'A flag indicating whether or not the parser is write once.
'
type: boolean
isPositionAware:
default: false
description: 'A flag indicating whether the parser is positionally aware.
'
type: boolean
isSingleLineContent:
description: 'A flag indicating if this is a single line content parser.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
language:
description: The language.
type: string
logTypeTestRequestVersion:
description: The log type test request version.
format: int32
type: integer
name:
description: The parser internal name.
type: string
parserFunctions:
description: The parser function list.
items:
$ref: '#/components/schemas/LogAnalyticsParserFunction'
type: array
parserIgnorelineCharacters:
description: The line characters for the parser to ignore.
type: string
parserSequence:
description: The parser sequence.
format: int32
type: integer
parserTimezone:
description: The time zone.
type: string
shouldTokenizeOriginalText:
description: 'A flag indicating whether or not to tokenize the original text.
'
type: boolean
type:
default: REGEX
description: The parser type. Default value is REGEX.
enum:
- XML
- JSON
- REGEX
- ODL
- DELIMITED
type: string
type: object
AbstractCommandDescriptor:
description: 'Generic command descriptor defining all attributes common to all querylanguage commands for parse output.
'
discriminator:
propertyName: name
properties:
category:
description: 'querylanguage command designation for example; reporting vs filtering
'
type: string
declaredFields:
description: 'Fields declared in command fragment from user specified query string.
'
items:
$ref: '#/components/schemas/AbstractField'
type: array
displayQueryString:
description: 'Command fragment display string from user specified query string formatted by query builder.
'
type: string
internalQueryString:
description: 'Command fragment internal string from user specified query string formatted by query builder.
'
type: string
isHidden:
description: 'Field denoting if this is a hidden command that is not shown in the query string.
'
type: boolean
name:
description: 'Name of querylanguage command
'
enum:
- COMMAND
- SEARCH
- STATS
- GEO_STATS
- TIME_STATS
- SORT
- FIELDS
- ADD_FIELDS
- LINK
- LINK_DETAILS
- CLUSTER
- CLUSTER_DETAILS
- CLUSTER_SPLIT
- EVAL
- EXTRACT
- JSON_EXTRACT
- XML_EXTRACT
- EVENT_STATS
- BUCKET
- CLASSIFY
- TOP
- BOTTOM
- HEAD
- TAIL
- FIELD_SUMMARY
- REGEX
- RENAME
- TIME_COMPARE
- WHERE
- CLUSTER_COMPARE
- DELETE
- CREATETABLE
- SEQUENCE
- UPDATETABLE
- DELTA
- DISTINCT
- SEARCH_LOOKUP
- LOOKUP
- DEMO_MODE
- MACRO
- MODULE
- MULTI_SEARCH
- HIGHLIGHT
- HIGHLIGHT_ROWS
- HIGHLIGHT_GROUPS
- CREATE_VIEW
- MAP
- NLP
- COMPARE
- ADD_INSIGHTS
- ANOMALY
- DEDUP
- TIME_CLUSTER
- FREQUENT
- RARE
- OUTLIER
type: string
referencedFields:
description: 'Fields referenced in command fragment from user specified query string.
'
items:
$ref: '#/components/schemas/AbstractField'
type: array
required:
- name
- displayQueryString
- internalQueryString
type: object
EffectivePropertySummary:
description: A property and its effective value details.
properties:
effectiveLevel:
description: The level from which the effective value was determined.
type: string
name:
description: The property name.
type: string
patterns:
description: A list of pattern level override values for the property.
items:
$ref: '#/components/schemas/PatternOverride'
type: array
value:
description: 'The effective value of the property. This is determined by considering the value set at the most effective level.
'
type: string
required:
- name
type: object
LogAnalyticsResourceCategory:
description: A resource and its category.
properties:
categoryName:
description: The category name to which this resource belongs.
type: string
compartmentId:
description: Compartment ID of the resource
type: string
isSystem:
description: 'The system flag. A value of false denotes a user-created category assignment.
A value of true denotes an Oracle-defined category assignment.
'
type: boolean
resourceDisplayName:
description: The resource display name.
type: string
resourceId:
description: The unique identifier of the resource, usually a name or ocid.
type: string
resourceType:
description: The resource type.
type: string
type: object
WorkRequestLogCollection:
description: 'This is a list of logs for the work request.
'
properties:
items:
description: 'This is an array of logs for the work request.
'
items:
$ref: '#/components/schemas/WorkRequestLog'
type: array
required:
- items
type: object
UpsertLogAnalyticsLabelDetails:
description: Upsert LogAnalytics Label Details
properties:
aliases:
description: The alias list.
items:
$ref: '#/components/schemas/LogAnalyticsLabelAlias'
type: array
description:
description: The label description.
type: string
displayName:
description: The label display name.
type: string
editVersion:
description: The edit version.
format: int64
type: integer
impact:
description: The label impact.
type: string
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined label. A value of true denotes a built in label.
'
type: boolean
name:
description: The label name.
type: string
priority:
default: NONE
description: The label priority. Valid values are (NONE, LOW, HIGH). NONE is default.
enum:
- NONE
- LOW
- MEDIUM
- HIGH
type: string
recommendation:
description: The label recommendation.
type: string
suggestType:
description: suggest type
format: int64
type: integer
type:
default: INFO
description: The label type. Valid values are (INFO, PROBLEM). INFO is default.
enum:
- INFO
- PROBLEM
type: string
type: object
LogAnalyticsLabel:
description: LogAnalytics label
properties:
aliases:
description: An array of label aliases.
items:
$ref: '#/components/schemas/LogAnalyticsLabelAlias'
type: array
countUsageInSource:
description: The source usage count for this label.
format: int64
type: integer
description:
description: The label description.
type: string
displayName:
description: The label display name.
type: string
editVersion:
description: The label edit version.
format: int64
type: integer
impact:
description: The label impact.
type: string
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined label. A value of true denotes a built in label.
'
type: boolean
isUserDeleted:
description: 'A flag indicating whether or not the label has been deleted.
'
type: boolean
name:
description: The label name.
type: string
priority:
default: NONE
description: The label priority. Valid values are (NONE, LOW, HIGH). NONE is default.
enum:
- NONE
- LOW
- MEDIUM
- HIGH
type: string
recommendation:
description: The label recommendation.
type: string
suggestType:
description: The type of suggestion for label usage.
format: int64
type: integer
timeUpdated:
description: The last updated date.
format: date-time
type: string
type:
default: INFO
description: The label type. Valid values are (INFO, PROBLEM). INFO is default.
enum:
- INFO
- PROBLEM
type: string
LogAnalyticsProperty:
description: A property represented as a name-value pair.
properties:
name:
description: The property name.
type: string
value:
description: The property value.
type: string
required:
- name
type: object
x-example: "Specify a string collection property:\n{\n \"name\": \"management_agent.os_file.timezone\",\n \"value\": \"GMT\"\n}\n\nSpecify an integer collection property:\n{\n \"name\": \"management_agent.database_sql.max_oldDays\",\n \"value\": \"20\"\n}\n\nSpecify a boolean collection property:\n{\n \"name\": \"management_agent.rest_api.filterdups\",\n \"value\": \"true\"\n}\n\nSpecify a time duration collection property (ISO 8601 format):\n{\n \"name\": \"management_agent.rest_api.historical_data\",\n \"value\": \"P30D\"\n}\n\nSpecify a JSON collection property (value is the stringified json):\n{\n \"name\": \"management_agent.os_file.logentry_metadata\",\n \"value\": \"{\\\"System ID\\\":[\\\"a52ic029trl\\\"],\\\"Users\\\":[\\\"jdensair\\\",\\\"gaberlon\\\"]}\"\n}\n"
RecalledDataInfo:
description: This is the synchronous result of a recall of archived data
properties:
collectionName:
description: This is the parent name of the list of overlapping recalls
type: string
purpose:
description: This is the recall name made for a specific purpose
type: string
required:
- collectionName
type: object
LookupField:
description: LookupField
properties:
commonFieldName:
description: The common field name.
type: string
defaultMatchValue:
description: The default match value.
type: string
displayName:
description: The field display name.
type: string
isCommonField:
description: 'A flag indicating whether or not the lookup field is a common field.
'
type: boolean
matchOperator:
description: The match operator.
type: string
name:
description: The field name.
type: string
position:
description: THe field position.
format: int64
type: integer
type: object
LogAnalyticsEmBridgeSummaryReport:
description: 'Log-Analytics EM Bridge counts summary.
'
properties:
activeEmBridgeCount:
description: 'Total number of ACTIVE enterprise manager bridges.
'
format: int32
type: integer
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
creatingEmBridgeCount:
description: 'Number of enterprise manager bridges in CREATING state.
'
format: int32
type: integer
deletedEmBridgeCount:
description: 'Number of enterprise manager bridges in DELETED state.
'
format: int32
type: integer
needsAttentionEmBridgeCount:
description: 'Number of enterprise manager bridges in NEEDS_ATTENTION state.
'
format: int32
type: integer
totalEmBridgeCount:
description: 'Total number of enterprise manager bridges.
'
format: int32
type: integer
required:
- compartmentId
- activeEmBridgeCount
- creatingEmBridgeCount
- needsAttentionEmBridgeCount
- deletedEmBridgeCount
- totalEmBridgeCount
type: object
EstimateRecallDataSizeDetails:
description: 'This is the input used to estimate the size of data to be recalled
'
properties:
collectionId:
description: 'This is the existing recalled data collection ID, to be used only for recalling new data.
If specified, the recall new data will be estimated only for this collection
'
format: int64
type: integer
isRecallNewDataOnly:
default: false
description: This indicates if only new data has to be recalled in the timeframe
type: boolean
logSets:
description: This is the list of logsets to be accounted for in the recalled data
type: string
timeDataEnded:
description: This is the end of the time range for the data to be recalled
format: date-time
type: string
timeDataStarted:
description: This is the start of the time range for the data to be recalled
format: date-time
type: string
required:
- timeDataStarted
- timeDataEnded
type: object
LogAnalyticsEntitySummaryReport:
description: 'Log-Analytics entity counts summary.
'
properties:
activeEntitiesCount:
description: 'Total number of ACTIVE entities
'
format: int32
type: integer
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
entitiesWithHasLogsCollectedCount:
description: 'Entities with log collection enabled
'
format: int32
type: integer
entitiesWithManagementAgentCount:
description: 'Entities with management agent
'
format: int32
type: integer
required:
- compartmentId
- activeEntitiesCount
- entitiesWithHasLogsCollectedCount
- entitiesWithManagementAgentCount
type: object
RecallDefinition:
description: 'Defines a recall in a query.
'
properties:
id:
description: 'Id of the recall.
'
type: string
name:
description: 'Name of the recall.
'
type: string
ChangeLogAnalyticsEmBridgeCompartmentDetails:
description: 'Log analytics enterprise manager bridge compartment to be updated.
'
properties:
compartmentId:
description: 'The OCID of the compartment where the log analytics entity should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
ChangeLogAnalyticsEntityCompartmentDetails:
description: 'Log analytics entity compartment to be updated.
'
properties:
compartmentId:
description: 'The OCID of the compartment where the log analytics entity should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
IngestTimeRuleAction:
description: The action to be performed if the ingest time rule condition(s) are satisfied.
discriminator:
propertyName: type
properties:
type:
description: Discriminator.
enum:
- METRIC_EXTRACTION
type: string
required:
- type
type: object
LogAnalyticsWarningCollection:
description: A collection of warnings.
properties:
items:
description: A collection of LogAnalyticsWarnings
items:
$ref: '#/components/schemas/LogAnalyticsWarning'
type: array
type: object
LogAnalyticsLookupCollection:
description: LogAnalytics Lookup Collection
properties:
items:
description: list of fields
items:
$ref: '#/components/schemas/LogAnalyticsLookup'
type: array
type: object
DeleteLogAnalyticsAssociation:
description: DeleteLogAnalyticsAssociation
properties:
agentId:
description: The agent unique identifier.
type: string
entityId:
description: The entity unique identifier.
type: string
entityTypeName:
description: The entity type internal name.
type: string
host:
description: The host name.
type: string
logGroupId:
description: The log group unique identifier.
type: string
sourceName:
description: The source name.
type: string
sourceTypeName:
description: The source type internal name.
type: string
type: object
EventTypeDetails:
description: The collection of event types and corresponding versions mapped to the source.
properties:
items:
description: An array of event type specifications.
items:
$ref: '#/components/schemas/EventType'
type: array
type: object
LogAnalyticsEntityTypeCollection:
description: 'Collection of log analytics entities.
'
properties:
items:
description: Array of log analytics entity type summary.
items:
$ref: '#/components/schemas/LogAnalyticsEntityTypeSummary'
type: array
required:
- items
type: object
ColumnNameCollection:
description: Column Name Collection
properties:
items:
description: A list of SQL query column names.
items:
$ref: '#/components/schemas/ColumnName'
type: array
type: object
CreateLogAnalyticsLogGroupDetails:
description: 'Information about a new log group.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
required:
- displayName
- compartmentId
type: object
LogAnalyticsParserFunctionParameter:
description: LogAnalyticsParserFunctionParameter
properties:
parserFunctionId:
description: The parser function unique identifier.
format: int64
type: integer
parserFunctionParameterId:
description: The parameter unique identifier.
format: int64
type: integer
parserFunctionParameterName:
description: The internal name
type: string
parserMetaPluginParameter:
$ref: '#/components/schemas/LogAnalyticsParserMetaPluginParameter'
parserMetaPluginParameterName:
description: The parameter internal name.
type: string
parserMetaPluginParameterValue:
description: The parameter value.
type: string
parserName:
description: The parser internal name.
type: string
type: object
LogAnalyticsSource:
description: LogAnalyticsSource
properties:
associationCount:
description: The association count.
format: int32
type: integer
associationEntity:
description: The association entities.
items:
$ref: '#/components/schemas/LogAnalyticsAssociation'
type: array
categories:
description: 'An array of categories assigned to this source.
The isSystem flag denotes if each category assignment is user-created or Oracle-defined.
'
items:
$ref: '#/components/schemas/LogAnalyticsCategory'
type: array
dataFilterDefinitions:
description: The data filter definitions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceDataFilter'
type: array
databaseCredential:
description: The database credential.
type: string
description:
description: The source description.
type: string
displayName:
description: The source display name.
type: string
editVersion:
description: The source edit version.
format: int64
type: integer
endpoints:
description: An array of REST API endpoints for log collection.
items:
$ref: '#/components/schemas/LogAnalyticsEndpoint'
type: array
entityTypes:
description: The entity types.
items:
$ref: '#/components/schemas/LogAnalyticsSourceEntityType'
type: array
eventTypes:
description: An array of event types.
items:
$ref: '#/components/schemas/EventType'
type: array
extendedFieldDefinitions:
description: The extended field definitions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceExtendedFieldDefinition'
type: array
functions:
description: The source functions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceFunction'
type: array
isAutoAssociationEnabled:
description: 'A flag indicating whether or not the source is marked for auto-association.
'
type: boolean
isAutoAssociationOverride:
description: 'A flag indicating whether or not the auto-association state should be overridden.
'
type: boolean
isForCloud:
description: 'A flag indicating whether or not this is a cloud source.
'
type: boolean
isSecureContent:
description: 'A flag indicating whether or not the source content is secure.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
isTimezoneOverride:
description: 'A flag indicating whether or not the source has a time zone override.
'
type: boolean
labelConditions:
description: The label alert conditions.
items:
$ref: '#/components/schemas/LogAnalyticsSourceLabelCondition'
type: array
labelDefinitions:
description: The labels used by the source.
items:
$ref: '#/components/schemas/LogAnalyticsLabelDefinition'
type: array
labels:
description: The labels associated with the source.
items:
$ref: '#/components/schemas/LogAnalyticsLabelView'
type: array
lifecycleState:
default: ACTIVE
description: 'The current state of the Log Analytics source.
'
enum:
- ACTIVE
- DELETED
type: string
metadataFields:
description: The source metadata fields.
items:
$ref: '#/components/schemas/LogAnalyticsSourceMetadataField'
type: array
metricDefinitions:
description: The metric definitions.
items:
$ref: '#/components/schemas/LogAnalyticsMetric'
type: array
metrics:
description: The metric source map.
items:
$ref: '#/components/schemas/LogAnalyticsSourceMetric'
type: array
name:
description: The source internal name.
type: string
oobParsers:
description: The built in parsers associated with source.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
parameters:
description: The source parameters.
items:
$ref: '#/components/schemas/LogAnalyticsParameter'
type: array
parsers:
description: The list of parsers used by the source.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
patternCount:
description: The pattern count.
format: int32
type: integer
patterns:
description: The source patterns.
items:
$ref: '#/components/schemas/LogAnalyticsSourcePattern'
type: array
ruleId:
description: The rule unique identifier.
format: int64
type: integer
sourceId:
description: The source unique identifier.
format: int64
type: integer
sourceProperties:
description: A list of source properties.
items:
$ref: '#/components/schemas/LogAnalyticsProperty'
type: array
timeUpdated:
description: The last updated date.
format: date-time
type: string
typeDisplayName:
description: The source type name.
type: string
typeName:
description: The source type internal name.
type: string
userParsers:
description: An array of custom parsers.
items:
$ref: '#/components/schemas/LogAnalyticsParser'
type: array
warningConfig:
description: The source warning configuration.
format: int64
type: integer
type: object
AssociationSummaryReport:
description: AssociationSummaryReport
properties:
associationCount:
description: The association count.
format: int32
type: integer
type: object
CharEncodingCollection:
description: List of supported character encodings.
properties:
items:
description: List of supported character encodings.
items:
type: string
type: array
required:
- items
type: object
PropertyMetadataSummaryCollection:
description: A collection of property metadata objects.
properties:
items:
description: An array of properties along with their metadata summary.
items:
$ref: '#/components/schemas/PropertyMetadataSummary'
type: array
type: object
WorkRequestCollection:
description: 'Collection of control plane work requests.
'
properties:
items:
description: 'List of work requests.
'
items:
$ref: '#/components/schemas/WorkRequestSummary'
minItems: 0
type: array
required:
- items
type: object
LogAnalyticsAssociationCollection:
description: A collection of associations.
properties:
items:
description: An array of associations.
items:
$ref: '#/components/schemas/LogAnalyticsAssociation'
type: array
type: object
LogAnalyticsAssociationParameterCollection:
description: LogAnalytics Association Parameter Collection
properties:
items:
description: A list of association parameters.
items:
$ref: '#/components/schemas/LogAnalyticsAssociationParameter'
type: array
type: object
LogAnalyticsAssociationParameter:
description: LogAnalyticsAssociationParameter
properties:
agentId:
description: The agent unique identifier.
type: string
associationProperties:
description: A list of association properties.
items:
$ref: '#/components/schemas/AssociationProperty'
type: array
entityId:
description: The entity unique identifier.
type: string
entityType:
description: The entity type.
type: string
missingProperties:
description: A list of missing properties.
items:
type: string
type: array
requiredProperties:
description: A list of required properties.
items:
type: string
type: array
sourceDisplayName:
description: The source display name.
type: string
sourceId:
description: The source name.
type: string
sourceType:
description: The source type.
type: string
status:
default: SUCCEEDED
description: The status. Either FAILED or SUCCEEDED.
enum:
- SUCCEEDED
- FAILED
type: string
statusDescription:
description: The status description.
type: string
type: object
LogAnalyticsParserFunction:
description: LogAnalyticsParserFunction
properties:
isEnabled:
description: 'A flag indicating whether or not the parser function is enabled.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
parserFunctionId:
description: The parser function unique identifier.
format: int64
type: integer
parserFunctionName:
description: The parser function internal name.
type: string
parserFunctionParameters:
description: The parser function parameter list.
items:
$ref: '#/components/schemas/LogAnalyticsParserFunctionParameter'
type: array
parserFunctionPriority:
description: The parser function priority.
format: int64
type: integer
parserId:
description: The associated parser unique identifier.
format: int64
type: integer
parserMetaPlugin:
$ref: '#/components/schemas/LogAnalyticsParserMetaPlugin'
parserMetaPluginName:
description: The plugin internal name.
type: string
parserName:
description: The associated parser internal name.
type: string
type: object
ValidateLabelConditionDetails:
description: Required information needed to evaluate a source label condition.
properties:
conditionBlock:
$ref: '#/components/schemas/ConditionBlock'
conditionString:
description: String representation of the label condition to validate.
type: string
fieldValues:
description: An array of field name-value pairs to evaluate the label condition.
items:
$ref: '#/components/schemas/LogAnalyticsProperty'
type: array
type: object
EnableAutoAssociationDetails:
description: The information required to enable log source auto-association.
properties:
items:
description: A list of information required to enable auto association on a source.
items:
$ref: '#/components/schemas/EnableAutoAssociationDetail'
type: array
type: object
NamespaceCollection:
description: 'This is a list of NamespaceSummary: there is at most one item in the list.
'
properties:
items:
description: 'There is at most one item in the items array.
'
items:
$ref: '#/components/schemas/NamespaceSummary'
type: array
required:
- items
type: object
Violation:
description: Violation
properties:
indexes:
description: The indices associated with regular expression violations.
items:
$ref: '#/components/schemas/Indexes'
type: array
ruleDescription:
description: The rule description.
type: string
ruleName:
description: The rule name.
type: string
ruleRemediation:
description: The rule remediation.
type: string
ruleType:
description: The rule type. Either WARN or ERROR.
enum:
- WARN
- ERROR
type: string
type: object
ParserActionSummaryCollection:
description: A collection of parser action summary objects.
properties:
items:
description: An array of parser action summary objects.
items:
$ref: '#/components/schemas/ParserActionSummary'
type: array
required:
- items
type: object
LogAnalyticsEmBridgeCollection:
description: 'Collection of log analytics enterprise manager bridges.
'
properties:
items:
description: Array of log analytics enterprise manager bridges.
items:
$ref: '#/components/schemas/LogAnalyticsEmBridgeSummary'
type: array
required:
- items
type: object
LogAnalyticsResourceCategoryDetails:
description: Details of resource category assignments.
properties:
items:
description: An array of resources and their corresponding category assignments to update.
items:
$ref: '#/components/schemas/LogAnalyticsResourceCategory'
type: array
type: object
LogAnalyticsFieldSummary:
allOf:
- $ref: '#/components/schemas/LogAnalyticsField'
description: A summary of a field.
LogAnalyticsConfigWorkRequestPayload:
description: LogAnalyticsConfigWorkRequestPayload
properties:
entityId:
description: The entity unique identifier.
type: string
lookupReference:
description: The lookup reference as an integer.
format: int64
type: integer
lookupReferenceString:
description: lookupReference
type: string
sourceName:
description: The source name.
type: string
type: object
ChangeScheduledTaskCompartmentDetails:
description: 'The details for changing the compartment of a scheduled task.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
required:
- compartmentId
type: object
LogAnalyticsSourcePattern:
description: LogAnalyticsSourcePattern
properties:
alias:
description: The source pattern alias.
type: string
convertedText:
description: The converted text.
type: string
dbParserId:
description: The parser unique identifier.
format: int64
type: integer
dbPatternDateTimeColumns:
description: The date time columns.
type: string
dbPatternDateTimeField:
description: The date time field.
type: string
dbPatternSequenceColumn:
description: The sequence column.
type: string
description:
description: The source pattern description.
type: string
entityType:
description: The source entity type.
items:
type: string
type: array
fields:
description: The parser field list.
items:
$ref: '#/components/schemas/LogAnalyticsParserField'
type: array
isAgentWarningSuppressed:
description: 'A flag indicating whether or not agent warnings are suppressed for
this source pattern.
'
type: boolean
isDefault:
description: 'A flag indicating if this is the default source pattern.
'
type: boolean
isEnabled:
description: 'A flag indicating whether or not the source pattern is enabled.
'
type: boolean
isInclude:
description: 'A flag indicating if this is source pattern is included.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
patternFilter:
$ref: '#/components/schemas/LogAnalyticsPatternFilter'
patternId:
description: The source pattern unique identifier.
format: int64
type: integer
patternProperties:
description: A list of pattern properties.
items:
$ref: '#/components/schemas/LogAnalyticsProperty'
type: array
patternText:
description: The pattern text.
type: string
patternType:
description: The pattern type.
format: int64
type: integer
sourceId:
description: The source unique identifier.
format: int64
type: integer
type: object
SuggestDetails:
description: 'Typeahead input.
'
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
compartmentIdInSubtree:
default: false
description: 'Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
'
type: boolean
queryString:
description: 'Query seeking suggestions for.
'
type: string
subSystem:
description: 'Default subsystem to qualify fields with in the queryString if not specified.
'
enum:
- LOG
type: string
x-obmcs-top-level-enum: '#/definitions/SubSystemName'
required:
- compartmentId
- queryString
- subSystem
type: object
UpdateLogAnalyticsLogGroupDetails:
description: 'Information needed to update an existing log group.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type: object
ParsedField:
description: Parsed field response.
properties:
fieldValues:
description: List of field Values.
items:
type: string
type: array
logContent:
description: Sample log entries picked up from the given file for validation.
type: string
type: object
ChangeLogAnalyticsLogGroupCompartmentDetails:
description: 'The information required to change a log group compartment.
'
properties:
compartmentId:
description: 'The OCID of the compartment where the log analytics entity should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
LogAnalyticsParserMetaPluginCollection:
description: LogAnalyticsParserMetaPluginCollection
properties:
items:
description: list of meta pre-process pagination objects
items:
$ref: '#/components/schemas/LogAnalyticsParserMetaPlugin'
type: array
type: object
LogAnalyticsEmBridge:
description: 'Configuration details for enterprise manager bridge.
'
properties:
bucketName:
description: Object store bucket name where enterprise manager harvested entities will be uploaded.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A description for log analytics enterprise manager bridge.
'
maxLength: 1024
minLength: 1
type: string
displayName:
description: 'Log analytics enterprise manager bridge display name.
'
maxLength: 128
minLength: 1
type: string
emEntitiesCompartmentId:
description: 'Compartment for entities created from enterprise manager.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The enterprise manager bridge OCID.
'
maxLength: 255
minLength: 1
type: string
lastImportProcessingDetails:
description: 'Processing status details of enterprise manager upload. This provides additional details
for failed status
'
type: string
lastImportProcessingStatus:
description: 'The status from last processing status of enterprise manager upload.
'
enum:
- NOT_STARTED
- SUCCESS
- IN_PROGRESS
- FAILED
- PARTIAL_SUCCESS
type: string
x-obmcs-top-level-enum: '#/definitions/EmBridgeLatestImportProcessingStatus'
lifecycleDetails:
description: 'lifecycleDetails has additional information regarding substeps such as verifying connection to object store.
'
type: string
lifecycleState:
description: 'The current state of the enterprise manager bridge.
'
enum:
- CREATING
- ACTIVE
- DELETED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/EmBridgeLifecycleStates'
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeEmDataLastExtracted:
description: 'The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339
'
format: date-time
type: string
timeImportLastProcessed:
description: 'The last time of enterprise manager upload was processed. This is in the format defined by RFC3339
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- emEntitiesCompartmentId
- bucketName
- timeCreated
- timeUpdated
- lifecycleState
- lastImportProcessingStatus
type: object
TestParserPayloadDetails:
description: TestParserPayloadDetails
properties:
content:
description: The content used for testing.
type: string
description:
description: The parser description.
type: string
displayName:
description: The parser display name.
type: string
encoding:
description: The content encoding.
type: string
exampleContent:
description: The example content.
type: string
fieldDelimiter:
description: The parser field delimiter.
type: string
fieldMaps:
description: The parser fields.
items:
$ref: '#/components/schemas/LogAnalyticsParserField'
type: array
fieldQualifier:
description: The parser field qualifier.
type: string
footerContent:
description: The footer regular expression.
type: string
headerContent:
description: The header content.
type: string
isDefault:
description: 'A flag indicating if this is a default parser.
'
type: boolean
isHidden:
description: A flag indicating if the parser is hidden or not.
format: int64
type: integer
isNamespaceAware:
description: 'A flag indicating whether the XML parser should consider the namespace(s) while processing the log data.
'
type: boolean
isParserWrittenOnce:
description: 'A flag indicating whether or not the parser is write once.
'
type: boolean
isPositionAware:
default: false
description: 'A flag indicating whether the parser is positionally aware.
'
type: boolean
isSingleLineContent:
description: 'A flag indicating if this is a single line content parser.
'
type: boolean
isSystem:
description: 'The system flag. A value of false denotes a custom, or user
defined object. A value of true denotes a built in object.
'
type: boolean
language:
description: The language.
type: string
logTypeTestRequestVersion:
description: The log type test request version.
format: int32
type: integer
metadata:
$ref: '#/components/schemas/UiParserTestMetadata'
name:
description: The parser name.
type: string
parserFunctions:
description: The parser function list.
items:
$ref: '#/components/schemas/LogAnalyticsParserFunction'
type: array
parserIgnorelineCharacters:
description: The line characters for the parser to ignore.
type: string
parserSequence:
description: The parser sequence.
format: int32
type: integer
parserTimezone:
description: The parser timezone.
type: string
shouldTokenizeOriginalText:
description: 'A flag indicating whether or not to tokenize the original text.
'
type: boolean
timeUpdated:
description: The last updated date.
format: date-time
type: string
type:
default: REGEX
description: The parser type. Default value is REGEX.
enum:
- XML
- JSON
- REGEX
- ODL
- DELIMITED
type: string
type: object
PropertyDefinition:
description: 'Defines an property of a macro, variable or query.
'
properties:
isGlobal:
description: 'True if property is for all macros. Not applicable for macro variables or query.
'
type: boolean
name:
description: 'Name of the property.
'
type: string
type:
default: STRING
description: 'Type of the property.
'
enum:
- STRING
- DOUBLE
- FLOAT
- LONG
- INTEGER
- TIMESTAMP
type: string
value:
description: 'Value of the property.
'
type: string
CompareLineResult:
description: The result of a comparison of two lines in the two content input strings.
properties:
diffType:
description: 'The result of the line comparison. An empty string means the lines being compared are the
same. A pipe, |, means the lines are different, and a caret, > or <, means the
line is only found either on the right or the left.
'
type: string
leftContent:
description: 'A line from the content on the left. This may be empty if there is no matching line on
the left for a line in the right content.
'
type: string
leftIndices:
description: 'A comma delimited set of indices that identify which characters are different from those
in the right string.
'
type: string
rightContent:
description: 'A line from the content on the right. This may be empty if there is no matching line on
the right for a line in the left content.
'
type: string
rightIndices:
description: 'A comma delimited set of indices that identify which characters are different from those
in the left string.
'
type: string
type: object
ScheduledTaskSummary:
description: Summary information about a scheduled task.
properties:
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the data plane resource.
'
type: string
lastExecutionStatus:
description: The most recent task execution status.
enum:
- FAILED
- SUCCEEDED
type: string
lifecycleState:
description: The current state of the scheduled task.
type: string
x-obmcs-enumref: '#/definitions/ScheduledTask/lifecycleState'
pauseReason:
description: reason for taskStatus PAUSED.
type: string
x-obmcs-enumref: '#/definitions/ScheduledTask/pauseReason'
scheduleType:
description: Type of the task schedule
enum:
- FIXED_FREQUENCY
- CRON
type: string
targetService:
description: Target Service
type: string
taskStatus:
description: Status of the scheduled task.
enum:
- READY
- PAUSED
- COMPLETED
- BLOCKED
type: string
taskType:
description: Task type.
enum:
- SAVED_SEARCH
- ACCELERATION
- PURGE
type: string
x-obmcs-top-level-enum: '#/definitions/TaskType'
timeCreated:
description: 'The date and time the schedule task was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeLastExecuted:
description: The date and time the scheduled task last executed, in the format defined by RFC3339.
format: date-time
type: string
timeUpdated:
description: 'The date and time the scheduled task was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
workRequestId:
description: most recent Work Request Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.
type: string
required:
- id
- displayName
- taskType
- compartmentId
- timeCreated
- timeUpdated
- lifecycleState
type: object
WorkRequestErrorCollection:
description: 'This is a list of errors for the work request.
'
properties:
items:
description: 'This is an array of errors for the work request.
'
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
LabelSourceSummary:
description: source summary
properties:
conditionBlock:
$ref: '#/components/schemas/ConditionBlock'
conditionString:
description: 'String representation of the label condition.
'
type: string
labelCondition:
description: The label condition.
type: string
labelFieldDisplayname:
description: The label field display name.
type: string
labelFieldName:
description: The label field name.
type: string
labelOperatorName:
description: The label operator.
type: string
sourceDisplayName:
description: The source display name.
type: string
sourceId:
description: The source unique identifier.
format: int64
type: integer
sourceName:
description: The source internal name.
type: string
type: object
SourceValidateResults:
description: results of source validation
properties:
items:
description: An array of source validation details.
items:
$ref: '#/components/schemas/SourceValidateDetails'
type: array
type: object
UploadWarningSummary:
description: Summary of Upload warnings.
properties:
errorMessage:
description: The details about upload processing failure.
type: string
reference:
description: Unique internal identifier to refer upload warning.
type: string
status:
description: Status of the upload. Ex - Failed.
type: string
timeStarted:
description: The time when the upload processing started.
format: date-time
type: string
required:
- reference
type: object
CreateLogAnalyticsObjectCollectionRuleDetails:
description: 'The configuration details of collection rule to enable automatic log collection from an object storage bucket.
'
properties:
charEncoding:
description: 'An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing.
It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters,
and very few alphabets.
For e.g. this applies when configuring VCN Flow Logs.
'
maxLength: 50
minLength: 1
type: string
collectionType:
default: LIVE
description: 'The type of collection.
'
enum:
- LIVE
- HISTORIC
- HISTORIC_LIVE
type: string
x-obmcs-top-level-enum: '#/definitions/ObjectCollectionRuleCollectionTypes'
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A string that describes the details of the rule. It does not have to be unique, and can be changed.
Avoid entering confidential information.
'
maxLength: 400
minLength: 0
type: string
entityId:
description: Log Analytics entity OCID. Associates the processed logs with the given entity (optional).
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
isEnabled:
default: true
description: 'Whether or not this rule is currently enabled.
'
type: boolean
isForceHistoricCollection:
default: false
description: 'Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
'
type: boolean
logGroupId:
description: Log Analytics Log group OCID to associate the processed logs with.
maxLength: 255
minLength: 1
type: string
logSet:
description: "The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data \nand this feature has to be enabled for a given tenancy prior to its usage.\nWhen logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically \nusing logSetKey and logSetExtRegex.\n"
maxLength: 128
minLength: 1
type: string
logSetExtRegex:
description: 'The regex to be applied against given logSetKey. Regex has to be in string escaped format.
'
maxLength: 255
minLength: 1
type: string
logSetKey:
default: OBJECT_PATH
description: 'An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
'
enum:
- OBJECT_PATH
type: string
x-obmcs-top-level-enum: '#/definitions/LogSetKeyTypes'
logSourceName:
description: Name of the Log Analytics Source to use for the processing.
maxLength: 128
minLength: 1
type: string
logType:
default: LOG
description: 'Type of files/objects in this object collection rule.
'
enum:
- LOG
- LOG_EVENTS
type: string
x-obmcs-top-level-enum: '#/definitions/LogTypes'
name:
description: A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.
maxLength: 255
minLength: 1
type: string
objectNameFilters:
description: 'When the filters are provided, only the objects matching the filters are picked up for processing.
The matchType supported is exact match and accommodates wildcard "*".
For more information on filters, see [Event Filters](https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm).
'
items:
maxLength: 1024
minLength: 1
type: string
type: array
osBucketName:
description: Name of the Object Storage bucket.
maxLength: 1024
minLength: 1
type: string
osNamespace:
description: Object Storage namespace.
maxLength: 1024
minLength: 1
type: string
overrides:
additionalProperties:
items:
$ref: '#/components/schemas/PropertyOverride'
type: array
description: 'The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket.
Supported propeties for override are: logSourceName, charEncoding, entityId.
Supported matchType for override are "contains".
'
type: object
pollSince:
default: CURRENT_TIME
description: 'The oldest time of the file in the bucket to consider for collection.
Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string.
Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.
'
maxLength: 50
minLength: 1
type: string
pollTill:
default: 'null'
description: 'The newest time of the file in the bucket to consider for collection.
Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string.
Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error.
'
maxLength: 50
minLength: 1
type: string
streamCursorTime:
description: "The time from which to consume the objects, if streamCursorType is AT_TIME. \n"
format: date-time
type: string
streamCursorType:
default: DEFAULT
description: "Cursor type used to fetch messages from stream.\nWhen the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. \nOtherwise, the behaviour is to consume from the oldest available message in the stream. \nWhen the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. \nWhen the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. \nWhen the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. \nFor more information on cursor types, see [Stream Consumer Groups](https://docs.oracle.com/en-us/iaas/Content/Streaming/Tasks/using_consumer_groups.htm).\n"
enum:
- DEFAULT
- TRIM_HORIZON
- LATEST
- AT_TIME
type: string
x-obmcs-top-level-enum: '#/definitions/StreamCursorTypes'
streamId:
description: 'A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage.
'
maxLength: 255
minLength: 1
type: string
timezone:
description: "Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. \nWhen this property is not specified, the timezone of the entity specified is used. \nIf the entity is also not specified or do not have a valid timezone then UTC is used.\n"
format: x-obmcs-time-zone
maxLength: 50
minLength: 1
type: string
required:
- name
- compartmentId
- osNamespace
- osBucketName
- logGroupId
type: object
RecalledInfo:
description: This is the information about data recalled
properties:
collectionId:
description: This is the id for the recalled data collection
format: int64
type: integer
logSets:
description: This is the list of logsets associated with the recall
type: string
purpose:
description: This is the purpose of the recall
type: string
queryString:
description: This is the query associated with the recall
type: string
status:
description: This is the status of the recall
enum:
- RECALLED
- PENDING
- FAILED
- PARTIAL_RECALLED
type: string
x-obmcs-top-level-enum: '#/definitions/RecallStatus'
timeRecalledDataEnded:
description: This is the recalled data end time
format: date-time
type: string
timeRecalledDataStarted:
description: This is the recalled date start time
format: date-time
type: string
required:
- status
- purpose
- queryString
- logSets
- collectionId
- timeRecalledDataStarted
- timeRecalledDataEnded
type: object
LogAnalyticsTemplateCollection:
description: A collection of template summary objects.
properties:
items:
description: An array of template summary objects.
items:
$ref: '#/components/schemas/LogAnalyticsTemplateSummary'
type: array
required:
- items
type: object
EstimatePurgeDataSizeDetails:
description: 'This is the input used to estimate the size of data that might be purged
'
properties:
compartmentId:
description: This is the compartment OCID under which the data will be purged
type: string
compartmentIdInSubtree:
default: true
description: If true, purge child compartments data
type: boolean
dataType:
description: This is the type of the log data to be purged
enum:
- LOG
- LOOKUP
type: string
x-obmcs-top-level-enum: '#/definitions/StorageDataType'
purgeQueryString:
description: This is the solr data filter query, '*' means all
type: string
timeDataEnded:
description: This is the time before which data will be purged
format: date-time
type: string
required:
- compartmentId
- timeDataEnded
type: object
IngestTimeRule:
description: 'An ingest time rule object.
'
properties:
actions:
description: 'The action(s) to be performed if the ingest time rule condition(s) are satisfied.
'
items:
$ref: '#/components/schemas/IngestTimeRuleAction'
type: array
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
conditions:
$ref: '#/components/schemas/IngestTimeRuleCondition'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: The ingest time rule display name.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
isEnabled:
description: A flag indicating whether or not the ingest time rule is enabled.
type: boolean
lifecycleState:
description: 'The current state of the ingest time rule.
'
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/ConfigLifecycleState'
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
required:
- id
- compartmentId
- displayName
type: object
LogAnalyticsEndpoint:
description: Endpoint configuration for REST API based log collection.
discriminator:
propertyName: endpointType
properties:
endpointType:
description: Discriminator.
enum:
- LOG_LIST
- LOG
type: string
required:
- endpointType
type: object
UpdateLogAnalyticsObjectCollectionRuleDetails:
description: 'Configuration of the collection rule to be updated.
'
properties:
charEncoding:
description: 'An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing.
It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters,
and very few alphabets.
For e.g. this applies when configuring VCN Flow Logs.
'
maxLength: 50
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: 'A string that describes the details of the rule.
Avoid entering confidential information.
'
maxLength: 400
minLength: 0
type: string
entityId:
description: Log Analytics entity OCID. Associates the processed logs with the given entity (optional).
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
isEnabled:
description: 'Whether or not this rule is currently enabled.
'
type: boolean
logGroupId:
description: Log Analytics Log group OCID to associate the processed logs with.
maxLength: 255
minLength: 1
type: string
logSet:
description: "The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data \nand this feature has to be enabled for a given tenancy prior to its usage.\nWhen logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically \nusing logSetKey and logSetExtRegex.\n"
maxLength: 128
minLength: 1
type: string
logSetExtRegex:
description: 'The regex to be applied against given logSetKey. Regex has to be in string escaped format.
'
maxLength: 255
minLength: 1
type: string
logSetKey:
default: OBJECT_PATH
description: 'An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
'
enum:
- OBJECT_PATH
type: string
x-obmcs-top-level-enum: '#/definitions/LogSetKeyTypes'
logSourceName:
description: Name of the Log Analytics Source to use for the processing.
maxLength: 128
minLength: 1
type: string
objectNameFilters:
description: 'When the filters are provided, only the objects matching the filters are picked up for processing.
The matchType supported is exact match and accommodates wildcard "*".
For more information on filters, see [Event Filters](https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm).
'
items:
maxLength: 1024
minLength: 1
type: string
type: array
overrides:
additionalProperties:
items:
$ref: '#/components/schemas/PropertyOverride'
type: array
description: 'Use this to override some property values which are defined at bucket level to the scope of object.
Supported propeties for override are: logSourceName, charEncoding, entityId.
Supported matchType for override are "contains".
'
type: object
streamCursorTime:
description: "The time from which to consume the objects, if streamCursorType is AT_TIME. \n"
format: date-time
type: string
streamCursorType:
default: DEFAULT
description: "Cursor type used to fetch messages from stream.\nWhen the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. \nOtherwise, the behaviour is to consume from the oldest available message in the stream. \nWhen the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. \nWhen the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. \nWhen the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. \nFor more information on cursor types, see [Stream Consumer Groups](https://docs.oracle.com/en-us/iaas/Content/Streaming/Tasks/using_consumer_groups.htm).\n"
enum:
- DEFAULT
- TRIM_HORIZON
- LATEST
- AT_TIME
type: string
x-obmcs-top-level-enum: '#/definitions/StreamCursorTypes'
streamId:
description: 'A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage.
'
maxLength: 255
minLength: 1
type: string
timezone:
description: "Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. \nWhen this property is not specified, the timezone of the entity specified is used. \nIf the entity is also not specified or do not have a valid timezone then UTC is used.\n"
format: x-obmcs-time-zone
maxLength: 50
minLength: 1
type: string
type: object
LogAnalyticsLabelOperatorCollection:
description: LogAnalyticsLabelOperatorCollection
properties:
items:
description: An array of of label operators.
items:
$ref: '#/components/schemas/LogAnalyticsLabelOperator'
type: array
type: object
EventTypeCollection:
description: The collection of event types and corresponding versions mapped to the source.
properties:
items:
description: An array of event type specifications.
items:
$ref: '#/components/schemas/EventType'
type: array
type: object
AbstractColumn:
description: 'Generic column defining all attributes common to all querylanguage columns.
'
discriminator:
propertyName: type
properties:
displayName:
description: 'Column display name - will be alias if column is renamed by queryStrng.
'
type: string
internalName:
description: 'Internal identifier for the column.
'
type: string
isCaseSensitive:
default: false
description: 'A flag indicating whether or not the field is a case sensitive field. Only applies to string fields.
'
type: boolean
isEvaluable:
description: 'Identifies if this column can be used as an expression parameter in any command that accepts querylanguage expressions.
'
type: boolean
isGroupable:
description: 'Identifies if this column can be used as a grouping field in any grouping command.
'
type: boolean
isHidden:
default: false
description: 'Identifies if this column should be hidden by default but can be displayed in the UI on demand.
'
type: boolean
isListOfValues:
description: 'Identifies if all values in this column come from a pre-defined list of values.
'
type: boolean
isMultiValued:
description: 'Identifies if this column allows multiple values to exist in a single row.
'
type: boolean
originalDisplayName:
description: 'Same as displayName unless column renamed in which case this will hold the original display name for the column.
'
type: string
subSystem:
description: 'Subsystem column belongs to.
'
enum:
- LOG
type: string
x-obmcs-top-level-enum: '#/definitions/SubSystemName'
type:
description: 'Column classification when column requires special designation.
'
enum:
- COLUMN
- CHART_COLUMN
- CHART_DATA_COLUMN
- TIME_STATS_COLUMN
- TIME_STATS_DATA_COLUMN
- TIME_CLUSTER_COLUMN
- TIME_CLUSTER_DATA_COLUMN
- TABLE_COLUMN
- TIME_COLUMN
- TREND_COLUMN
- CLASSIFY_COLUMN
type: string
valueType:
description: 'Field denoting column data type.
'
enum:
- BOOLEAN
- STRING
- DOUBLE
- FLOAT
- LONG
- INTEGER
- TIMESTAMP
- FACET
- TABLE
type: string
x-obmcs-top-level-enum: '#/definitions/ValueType'
values:
description: 'If the column is a ''List of Values'' column, this array contains the field values that are applicable to query results or all if no filters applied.
'
items:
$ref: '#/components/schemas/FieldValue'
type: array
required:
- type
type: object
TimeRange:
description: 'Specify time range. This paramter can be overwritten if time criteria is specified in the query string. If no time criteria are found in query string this time range is used.
'
properties:
timeEnd:
description: 'Time for query to stop matching results to. End Time must be greater than or equal to start time otherwise it will result in error.
'
format: date-time
type: string
timeStart:
description: 'Time for query to start matching results from. Start time must be less than end time otherwise it will result in error.
'
format: date-time
type: string
timeZone:
default: UTC
description: 'Time zone for query.
'
format: x-obmcs-time-zone
type: string
required:
- timeStart
- timeEnd
type: object
parameters:
NameQueryParam:
description: 'A filter to return only log analytics entities whose name matches the entire name given. The match
is case-insensitive.
'
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
EndTimeQueryParam:
description: The warning end date query parameter.
in: query
name: endTime
required: false
schema:
type: string
IfMatchHeader:
description: '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.
'
in: header
name: if-match
required: false
schema:
type: string
UploadStatusQueryParam:
description: Upload File processing state.
in: query
name: status
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- IN_PROGRESS
- SUCCESSFUL
- FAILED
type: string
default: []
maxItems: 3
FilterByFreeformTagExistsQueryParam:
description: 'A list of tag existence filters to apply. Only entities for which the specified freeform tags exist the value will be returned.
The key for each tag is "{tagName}.true". All inputs are case-insensitive.
Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
Multiple values for different tag names are interpreted as "AND".
'
in: query
name: freeformTagExists
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 106
type: string
AssociableEntitySortByQueryParam:
description: The attribute used to sort the returned entities
in: query
name: sortBy
schema:
type: string
enum:
- entityName
- entityTypeName
- host
- agentId
default: entityName
EntityAssociationTypeQueryParam:
description: The entity type - either eligible or ineligible for association.
in: query
name: type
schema:
type: string
enum:
- ELIGIBLE
- INELIGIBLE
default: ELIGIBLE
ResourceCategoriesSortByQueryParam:
description: The attribute used to sort the returned category resources.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- resourceType
- categoryName
- resourceId
default: categoryName
OpcLogGroupHeader:
description: 'The log group OCID to which the log data in this upload will be mapped to.
'
in: header
name: opc-meta-loggrpid
required: true
schema:
type: string
SourceLifecycleStateQueryParam:
description: 'The source lifecycle state used for filtering. Currently supported
values are ACTIVE and DELETED.
'
in: query
name: lifecycleState
required: false
schema:
type: string
enum:
- ACTIVE
- DELETED
- ALL
default: ACTIVE
DiscoveryDataTypeQueryParam:
description: 'Discovery data type
'
in: query
name: discoveryDataType
required: false
schema:
type: string
enum:
- ENTITY
- K8S_OBJECTS
default: ENTITY
EntityAssociationSummarySortByQueryParam:
description: The attribute used to sort the returned associations
in: query
name: sortBy
schema:
type: string
enum:
- sourceDisplayName
- timeLastAttempted
- status
default: sourceDisplayName
TemplateSortByQueryParam:
description: The attribute used to sort the returned templates
in: query
name: sortBy
required: false
schema:
type: string
enum:
- displayName
- timeCreated
- timeUpdated
default: displayName
SourceTypeQueryParam:
description: 'The source type used for filtering. Only parsers associated with a source of the
specified type will be returned.
'
in: query
name: sourceType
schema:
type: string
enum:
- OS_FILE
- SYSLOG
- ODL
- OS_WINDOWS_SYS
default: OS_FILE
LabelNameQueryParam:
description: 'The label name used for filtering. Only items with, or associated with, the
specified label name will be returned.
'
in: query
name: labelName
required: false
schema:
type: string
LifecycleStateQueryParam:
description: 'Lifecycle state filter.
'
in: query
name: lifecycleState
required: false
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
schema:
type: string
enum:
- ACTIVE
- DELETED
default: ACTIVE
EntityTypeDisplayNameQueryParam:
description: 'The entity type display name used for filtering. Only items associated with the entity
with the specified type display name will be returned.
'
in: query
name: entityTypeDisplayName
required: false
schema:
type: string
ResourceTypesQueryParam:
description: 'A comma-separated list of resource types used for filtering. Only resources of the types
specified will be returned. Examples include SOURCE, PARSER, LOOKUP, etc.
'
in: query
name: resourceTypes
required: false
schema:
type: string
IsHiddenQueryParam:
description: 'A flag indicating whether or not the new lookup should be hidden.
'
in: query
name: isHidden
schema:
type: boolean
PatternIdLongQueryParam:
description: 'The pattern id (long).
'
in: query
name: patternIdLong
required: false
x-default-description: 'null'
schema:
type: integer
format: int64
TemplateIdPathParam:
description: 'Unique ocid of the template.
'
in: path
name: templateId
required: true
schema:
type: string
IsHideSpecialQueryParam:
description: 'A flag indicating whether or not to return OMC annotated or hidden lookups.
'
in: query
name: isHideSpecial
schema:
type: boolean
default: true
LogSourceNameQueryParam:
description: 'Name of the log source that will be used to process the files being uploaded.
'
in: query
name: logSourceName
required: true
schema:
type: string
maxLength: 512
minLength: 1
TemplateIdQueryParam:
description: 'A filter to return only scheduled tasks whose stream action templateId matches the given
id exactly.
'
in: query
name: templateId
required: false
schema:
type: string
default: 'null'
maxLength: 255
minLength: 1
IngestTimeRuleFieldNameQueryParam:
description: 'The field name used for filtering. Only rules using the
specified field name will be returned.
'
in: query
name: fieldName
required: false
schema:
type: string
WarningMessageQueryParam:
description: warning message query parameter
in: query
name: warningMessage
required: false
schema:
type: string
IsManagementAgentIdNullQueryParam:
description: 'A filter to return only those log analytics entities whose managementAgentId is null or is not null.
'
in: query
name: isManagementAgentIdNull
required: false
x-default-description: 'null'
schema:
type: string
enum:
- 'true'
- 'false'
HostNameQueryParam:
description: 'A filter to return only log analytics entities whose hostname matches the entire hostname given.
'
in: query
name: hostname
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ParserNamePathParam:
description: The parser name.
in: path
name: parserName
required: true
schema:
type: string
SourceEventTypeSortByQueryParam:
description: The attribute used to sort the returned source event types.
in: query
name: sortBy
schema:
type: string
enum:
- eventType
- timeUpdated
default: timeUpdated
IsShowTotalQueryParam:
description: A flag indicating whether or not to return the total number of items returned.
in: query
name: isShowTotal
required: false
schema:
type: boolean
ParserNameQueryParam:
description: 'The parser name used for filtering.
'
in: query
name: parserName
required: false
schema:
type: string
FileNameQueryParam:
description: '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).
'
in: query
name: filename
required: true
schema:
type: string
maxLength: 4000
minLength: 1
IsShowDetailQueryParam:
description: 'A boolean indicating whether or not to display detailed field summary information
'
in: query
name: isShowDetail
schema:
type: boolean
default: false
ResourceIdsQueryParam:
description: 'A comma-separated list of resource unique identifiers used for filtering. Only resources
with matching unique identifiers will be returned.
'
in: query
name: resourceIds
required: false
schema:
type: string
WorkRequestSortByQueryParam:
description: The attribute used to sort the returned work requests
in: query
name: sortBy
schema:
type: string
enum:
- timeAccepted
default: timeAccepted
FieldNamePathParam:
description: The field name. Field name can be obtained by running 'oci log-analytics field list-fields --namespace-name '. The json output 'name' parameter value contains the field name.
in: path
name: fieldName
required: true
schema:
type: string
LogAnalyticsEmBridgeLifecycleStateQueryParam:
description: 'A filter to return only log analytics enterprise manager bridges matching all the lifecycle states specified for this parameter.
'
in: query
name: lifecycleState
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- CREATING
- ACTIVE
- DELETED
- NEEDS_ATTENTION
maxItems: 4
minItems: 1
type: string
uniqueItems: true
x-obmcs-top-level-enum: '#/definitions/EmBridgeLifecycleStates'
default: []
OptionalLogGroupQueryParam:
description: 'The log group OCID that gets mapped to the logs in the discovery data.
'
in: query
name: logGroupId
required: false
x-default-description: 'null'
schema:
type: string
PayloadTypeQueryParam:
description: 'Identifies the type of request payload.
'
in: query
name: payloadType
required: false
x-obmcs-top-level-enum: '#/definitions/PayloadType'
schema:
type: string
enum:
- JSON
- GZIP
- ZIP
default: JSON
SourceSortByQueryParam:
description: The attribute used to sort the returned sources
in: query
name: sortBy
schema:
type: string
enum:
- name
- timeUpdated
- associationCount
- sourceType
default: name
CharEncodingQueryParam:
description: The character encoding of the uploaded file.
in: query
name: charEncoding
required: false
schema:
type: string
default: UTF-8
PaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
required: false
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
OpcMetaPropertiesHeader:
description: 'Metadata key and value pairs separated by a semicolon. Example k1:v1;k2:v2;k3:v3
'
in: header
name: opc-meta-properties
required: false
x-default-description: 'null'
schema:
type: string
LabelPriorityQueryParam:
description: 'The label priority used for filtering. Only labels with the specified
priority will be returned.
'
in: query
name: labelPriority
schema:
type: string
enum:
- NONE
- LOW
- MEDIUM
- HIGH
default: NONE
LogGroupQueryParam:
description: 'The log group OCID that gets mapped to the uploaded logs.
'
in: query
name: logGroupId
required: true
schema:
type: string
CategoriesQueryParam:
description: A comma-separated list of categories used for filtering
in: query
name: categories
required: false
schema:
type: string
IsNoSourceQueryParam:
description: 'A flag indicating whether to filter warnings based on source display name or on warning level.
A value of true will filter based on warning level (rule, source, or pattern), while a
value of false will filter based on source display name.
'
in: query
name: isNoSource
required: false
schema:
type: boolean
IsIncludePatternsQueryParam:
description: 'The include pattern flag.
'
in: query
name: isIncludePatterns
required: false
schema:
type: boolean
default: true
TimeStartQueryParam:
description: 'Optional parameter to specify start of time range, in the format defined by RFC3339.
Default value is beginning of time.
'
in: query
name: timeStart
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
PropertyConstraintsQueryParam:
description: 'The constraints that apply to the properties at a certain level.
'
in: query
name: constraints
required: false
schema:
type: string
DateFormatQueryParam:
description: '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.
'
in: query
name: dateFormat
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 32
minLength: 1
TimeDataEndedLessThanQueryParam:
description: This is the end of the time range for recalled data
in: query
name: timeDataEndedLessThan
x-default-description: 'null'
schema:
type: string
format: date-time
SearchStringQueryParam:
description: This can be used to filter upload files based on the file, log group and log source names.
in: query
name: searchStr
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 4000
minLength: 1
WarningTypeQueryParam:
description: The warning type query parameter.
in: query
name: warningType
required: false
schema:
type: string
LogAnalyticsEmBridgeIdentifierPathParam:
description: 'The log analytics enterprise manager bridge OCID. Bridge ID can be obtained by running ''oci log-analytics em-bridge list --namespace-name --compartment-id ''. The json output ''id'' parameter value contains the bridge ID.
'
in: path
name: logAnalyticsEmBridgeId
required: true
schema:
type: string
maxLength: 255
minLength: 1
AssociationParameterSortByQueryParam:
description: The attribute used to sort the returned association parameters
in: query
name: sortBy
schema:
type: string
enum:
- sourceDisplayName
- status
default: sourceDisplayName
RuleKindQueryParam:
description: 'The rule kind used for filtering. Only rules of the specified
kind will be returned.
'
in: query
name: kind
required: false
schema:
type: string
enum:
- INGEST_TIME
- SAVED_SEARCH
- ALL
default: ALL
LogSetsQueryParam:
description: This is the set of logsets to filter recalled collection by if any
in: query
name: logSets
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
type: string
IsAliasPopQueryParam:
description: 'A flag indicating whether or not return the aliases used by each label.
'
in: query
name: isAliasPop
required: false
schema:
type: boolean
IsCountPopQueryParam:
description: 'A flag indicating whether or not to count the label usage per source and per rule.
'
in: query
name: isCountPop
required: false
schema:
type: boolean
RecallSortByQueryParam:
description: '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.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeStarted
- timeDataStarted
default: timeDataStarted
SortOrderQueryParam:
description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`).
'
in: query
name: sortOrder
required: false
x-default-description: Default sorting is dependent on the SortBy column which can be timeCreated or displayName. Default order for timeCreated is descending (DESC). Default order for displayName is ascending (ASC). The displayName sort order is case sensitive.
schema:
type: string
enum:
- ASC
- DESC
FilterByDisplayNameContainsQueryParam:
description: 'A filter to return only resources whose display name contains the substring.
'
in: query
name: displayNameContains
required: false
schema:
type: string
default: 'null'
maxLength: 255
minLength: 1
EventTypeDisplayTextQueryParam:
description: 'The text used for filtering event types by name or description.
'
in: query
name: displayText
schema:
type: string
SourcePatternQueryParam:
description: 'The source pattern used for filtering. Only warnings associated with a source with the
specified pattern will be returned.
'
in: query
name: sourcePattern
required: false
schema:
type: string
IsIncrementalQueryParam:
description: 'A flag indicating whether or not the update of a source is incremental or not. If incremental,
the name of the source must be specified.
'
in: query
name: isIncremental
schema:
type: boolean
IsForceDeleteQueryParam:
description: Option to delete entity even if the entity is associated with a log source and stop any log collections associated with this entity.
in: query
name: isForceDelete
required: false
schema:
type: boolean
default: false
SourceNamesQueryParam:
description: 'A list of source names used for filtering. Only fields used by the specified
sources will be returned.
'
in: query
name: sourceNames
required: false
schema:
type: string
OptionalContentTypeHeader:
description: The content type of the log data.
in: header
name: content-type
x-default-description: 'null'
schema:
type: string
GetEntityTypeNameQueryParam:
description: 'A filter to return only log analytics entity types whose name matches the entire name given. The match is
case-insensitive.
'
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 128
minLength: 1
WorkRequestIdPathParam:
description: Work Request Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request. The work request id can be usually obtained from the 'opc-work-request-id' response header of the asynchronous request.
in: path
name: workRequestId
required: true
schema:
type: string
ContextQueryParam:
description: 'A filter to return log analytics entity toplogy whose context matches the specified string.
'
in: query
name: context
required: false
schema:
type: string
default: []
maxLength: 255
minLength: 1
SavedSearchIdQueryParam:
description: 'A filter to return only scheduled tasks whose stream action savedSearchId matches the given
ManagementSavedSearch id [OCID] exactly.
'
in: query
name: savedSearchId
required: false
schema:
type: string
default: 'null'
maxLength: 255
minLength: 1
NameContainsQueryParam:
description: 'A filter to return only log analytics entities whose name contains the name given. The match
is case-insensitive.
'
in: query
name: nameContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
LookupStatusQueryParam:
description: The lookup status used for filtering when fetching a list of lookups.
in: query
name: status
required: false
schema:
type: string
enum:
- ALL
- SUCCESSFUL
- FAILED
- INPROGRESS
default: ALL
LookupNamePathParam:
description: The name of the lookup to operate on.
in: path
name: lookupName
required: true
schema:
type: string
CreationSourceDetailsQueryParam:
description: 'A filter to return only log analytics entities whose auto-creation source details contains the specified string.
'
in: query
name: creationSourceDetails
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
GetEntityTypeNameContainsQueryParam:
description: 'A filter to return only log analytics entity types whose name or internalName contains name given. The match
is case-insensitive.
'
in: query
name: nameContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 128
minLength: 1
SourceAssociationSortByQueryParam:
description: The attribute used to sort the returned associations
in: query
name: sortBy
schema:
type: string
enum:
- entityName
- timeLastAttempted
- status
default: entityName
IsSystemQueryParam:
description: 'The system value used for filtering. Only items with the specified system value
will be returned. Valid values are built in, custom (for user defined items), or
all (for all items, regardless of system value).
'
in: query
name: isSystem
schema:
type: string
enum:
- ALL
- CUSTOM
- BUILT_IN
default: ALL
FilterQueryParam:
description: filter
in: query
name: filter
required: false
schema:
type: string
SourceNameQueryParam:
description: The source name.
in: query
name: sourceName
required: false
x-default-description: 'null'
schema:
type: string
IsIncludeQueryParam:
description: is included source patterns
in: query
name: isInclude
required: false
schema:
type: boolean
SourceExtendedFieldDefinitionSortByQueryParam:
description: The attribute used to sort the returned source patterns
in: query
name: sortBy
schema:
type: string
enum:
- baseFieldName
- regularExpression
default: baseFieldName
RuleLifecycleStateQueryParam:
description: 'The rule lifecycle state used for filtering. Currently supported
values are ACTIVE and DELETED.
'
in: query
name: lifecycleState
required: false
x-obmcs-top-level-enum: '#/definitions/ConfigLifecycleState'
schema:
type: string
enum:
- ACTIVE
- DELETED
default: ACTIVE
OptionalLogSetHeader:
description: 'The log set that gets associated with the uploaded logs.
'
in: header
name: log-set
required: false
x-default-description: 'null'
schema:
type: string
ObjectCollectionRuleNameQueryParam:
description: A filter to return rules only matching with this name.
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
IngestTimeRuleIdPathParam:
description: 'Unique ocid of the ingest time rule. Ingest time rule ID can be obtained by running ''oci log-analytics ingest-time-rule list --namespace-name --compartment-id ''. The json output ''id'' parameter value contains the rule ID.
'
in: path
name: ingestTimeRuleId
required: true
schema:
type: string
WorkRequestIdQueryParam:
description: Work Request Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.
in: query
name: workRequestId
required: true
schema:
type: string
UploadNameContainsQueryParam:
description: 'A filter to return only uploads whose name contains the given name.
'
in: query
name: nameContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 512
minLength: 1
EntityTypeNamePathParam:
description: 'Log analytics entity type name. Entity type name can be obtained by running ''oci log-analytics entity-type list --namespace-name --all''. The json output ''internal-name'' parameter value contains the entity type name.
'
in: path
name: entityTypeName
required: true
schema:
type: string
maxLength: 128
minLength: 1
UploadNameQueryParam:
description: '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.
'
in: query
name: uploadName
required: false
x-default-description: This is optional parameter and no default value.
schema:
type: string
maxLength: 512
minLength: 1
PatternIdQueryParam:
description: 'The pattern id.
'
in: query
name: patternId
required: false
schema:
type: integer
DescriptionQueryParam:
description: 'The description for a created lookup.
'
in: query
name: description
required: false
schema:
type: string
FilesSortByQueryParam:
description: '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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeStarted
- name
- logGroupName
- sourceName
- status
- timeCreated
- fileName
- logGroup
default: timeStarted
PropertySortByQueryParam:
description: The attribute used to sort the returned properties
in: query
name: sortBy
schema:
type: string
enum:
- name
- displayName
default: name
CompartmentIdQueryParam:
description: The ID of the compartment in which to list resources.
in: query
name: compartmentId
required: true
schema:
type: string
SourceEntityTypeQueryParam:
description: 'A filter to return only sources associated with entities of the specified type.
The match is case-insensitive.
'
in: query
name: entityType
required: false
schema:
type: string
UploadFileReferencePathParam:
description: Unique internal identifier to refer upload file.
in: path
name: fileReference
required: true
schema:
type: string
maxLength: 255
minLength: 1
ExtractParserTypeQueryParam:
description: The parser type - possible values are XML, JSON or DELIMITED.
in: query
name: parserType
required: false
schema:
type: string
enum:
- XML
- JSON
- DELIMITED
- REGEX
default: JSON
ShouldIncludeResultsQueryParam:
description: 'Optional parameter to specify whether to include acceleration results.
Default value is false;
'
in: query
name: shouldIncludeResults
required: false
schema:
type: boolean
default: false
TaskTypeQueryParam:
description: Required parameter to specify schedule task type.
in: query
name: taskType
required: true
x-obmcs-top-level-enum: '#/definitions/TaskType'
schema:
type: string
enum:
- SAVED_SEARCH
- ACCELERATION
- PURGE
ParserSortByQueryParam:
description: The attribute used to sort the returned parsers
in: query
name: sortBy
schema:
type: string
enum:
- name
- type
- sourcesCount
- timeUpdated
default: name
UploadsSortByQueryParam:
description: '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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeUpdated
- timeCreated
- name
default: timeUpdated
IsOverwriteQueryParam:
description: 'A flag indicating whether or not to overwrite existing content if a conflict is
found during import content operation.
'
in: query
name: isOverwrite
schema:
type: boolean
EntityLifecycleDetailsContainsQueryParam:
description: 'A filter to return only log analytics entities whose lifecycleDetails contains the specified string.
'
in: query
name: lifecycleDetailsContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ParserIdsQueryParam:
description: 'A list of parser names used for filtering. Only fields used by the specified
parsers will be returned.
'
in: query
name: parserIds
required: false
schema:
type: string
LogAnalyticsEmBridgeLifecycleDetailsContainsQueryParam:
description: 'A filter to return only log analytics enterprise manager bridges whose lifecycleDetails contains the specified string.
'
in: query
name: lifecycleDetailsContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
UploadsCustomPaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
default: 100
maximum: 1000
minimum: 100
UploadWarningsFilterQueryParam:
description: 'Use this for filtering uploads w.r.t warnings. Only one value is allowed. If no value is specified then ALL is taken as default,
which means that all the uploads with and without warnings will be returned.
'
in: query
name: warningsFilter
schema:
type: string
enum:
- WITH_WARNINGS
- WITHOUT_WARNINGS
- ALL
default: ALL
LogAnalyticsEmBridgeLastImportStatusQueryParam:
description: 'Filter by the processing status of the latest upload from enterprise manager.
'
in: query
name: importStatus
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- NOT_STARTED
- SUCCESS
- IN_PROGRESS
- FAILED
- PARTIAL_SUCCESS
maxItems: 5
minItems: 1
type: string
uniqueItems: true
x-obmcs-top-level-enum: '#/definitions/EmBridgeLatestImportProcessingStatus'
default: []
CreateLikeSourceIdQueryParam:
description: 'The unique identifier of the source to use as the reference for a create like
operation.
'
in: query
name: createLikeSourceId
required: false
schema:
type: integer
FilterByFreeformTagEqualsQueryParam:
description: 'A list of tag filters to apply. Only entities with a freeform tag matching the value will be returned.
The key for each tag is "{tagName}.{value}". All inputs are case-insensitive.
Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
'
in: query
name: freeformTagEquals
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 357
type: string
BasicLabelSortByQueryParam:
description: The attribute used to sort the returned labels
in: query
name: basicLabelSortBy
schema:
type: string
enum:
- name
- priority
default: name
LabelNamePathParam:
description: The label name. Label name can be obtained by running 'oci log-analytics label list-labels --namespace-name '. The json output 'name' parameter value contains the label name.
in: path
name: labelName
required: true
schema:
type: string
PropertyNameQueryParam:
description: 'The property name used for filtering.
'
in: query
name: name
required: false
schema:
type: string
metadataEqualsQueryParam:
description: 'A filter to return only log analytics entities whose metadata name, value and type matches the specified string.
Each item in the array has the format "{name}:{value}:{type}". All inputs are case-insensitive.
'
in: query
name: metadataEquals
required: false
style: form
explode: true
schema:
type: array
items:
maxLength: 288
minLength: 1
type: string
uniqueItems: true
default: []
maxItems: 1
minItems: 1
IsForceQueryParam:
description: is force
in: query
name: isForce
schema:
type: boolean
default: false
IsIncludeParserQueryParam:
description: isIncludeParser
in: query
name: isIncludeParser
required: false
schema:
type: boolean
default: true
PatternTextQueryParam:
description: 'The pattern text filter. Only sources with a pattern |
which contains text with the specified string will be returned.
'
in: query
name: patternText
required: false
x-default-description: 'null'
schema:
type: string
EntityCloudTypeQueryParam:
description: 'A filter to return CLOUD or NON_CLOUD entity types.
'
in: query
name: cloudType
required: false
x-obmcs-top-level-enum: '#/definitions/EntityCloudType'
schema:
type: string
enum:
- CLOUD
- NON_CLOUD
- ALL
default: CLOUD
ParserActionsSortByQueryParam:
description: The attribute used to sort the returned parser actions
in: query
name: sortBy
required: false
schema:
type: string
enum:
- displayName
default: displayName
ChangeScheduledTaskCompartmentDetailsBodyParam:
description: The destination compartment identifier.
in: body
name: ChangeScheduledTaskCompartmentDetails
required: true
schema:
$ref: '#/components/schemas/ChangeScheduledTaskCompartmentDetails'
SortByTimeAcceptedExpiresQueryParam:
description: '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.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeAccepted
- timeExpires
- timeFinished
default: timeAccepted
CategorySortByQueryParam:
description: The attribute used to sort the returned categories
in: query
name: sortBy
required: false
schema:
type: string
enum:
- displayName
- type
default: displayName
SourceDisplayTextQueryParam:
description: 'The source display text used for filtering. Only sources with the specified name
or description will be returned.
'
in: query
name: sourceDisplayText
required: false
schema:
type: string
LogAnalyticsLogGroupIdParam:
description: unique logAnalytics log group identifier
in: path
name: logAnalyticsLogGroupId
required: true
schema:
type: string
FilterByDisplayNameQueryParam:
description: 'A filter to return only resources that match the given display name exactly.
'
in: query
name: displayName
required: false
schema:
type: string
default: 'null'
maxLength: 255
minLength: 1
SortByTimeStartedExpiresQueryParam:
description: '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.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeStarted
- timeExpires
default: tinmeStarted
LabelSourceSortByQueryParam:
description: The attribute used to sort the returned sources
in: query
name: labelSourceSortBy
schema:
type: string
enum:
- sourceDisplayName
- labelFieldDisplayName
default: sourceDisplayName
SourceIdsQueryParam:
description: 'A list of source IDs used for filtering. Only fields used by the specified
sources will be returned.
'
in: query
name: sourceIds
required: false
schema:
type: string
IsIncludeDeletedQueryParam:
description: 'A flag specifying whether or not to include information on deleted labels.
'
in: query
name: isIncludeDeleted
required: true
schema:
type: boolean
default: false
LookupTypeQueryParam:
description: The lookup type. Valid values are Lookup, Dictionary or Module.
in: query
name: type
required: true
schema:
type: string
enum:
- Lookup
- Dictionary
- Module
default: Lookup
EntityIdConfigQueryParam:
description: 'The entity ocid.
'
in: query
name: entityId
required: false
schema:
type: string
ResultLimitQueryParam:
description: Maximum number of results to return in this request. Note a limit=-1 returns all results from pageId onwards up to maxtotalCount.
in: query
name: limit
required: false
schema:
type: integer
format: int32
default: 10
maximum: 2001
minimum: -1
EntityTypeSortByQueryParam:
description: '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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- timeUpdated
- name
default: timeCreated
AutoAssociationsSortByQueryParam:
description: The attribute used to sort the returned auto association information.
in: query
name: sortBy
schema:
type: string
enum:
- isEnabled
default: isEnabled
BucketNameQueryParam:
description: Name of the Object Storage bucket. Bucket name can be obtained by running 'oci os bucket list --namespace-name --compartment-id '. The json output 'name' parameter value contains the bucket name.
in: query
name: bucketName
required: true
schema:
type: string
maxLength: 1024
minLength: 1
LogAnalyticsEmBridgeSortByQueryParam:
description: 'The field to sort enterprise manager bridges by. Only one sort order may be provided. Default order for timeCreated and timeUpdated
is descending. Default order for enterprise manager name is ascending. If no value is specified timeCreated is default.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- timeUpdated
- displayName
default: timeCreated
IsFromRepublishQueryParam:
description: isFromRepublish
in: query
name: isFromRepublish
schema:
type: boolean
ParserActionsDisplayTextQueryParam:
description: 'The parser action display text used for filtering.
'
in: query
name: actionDisplayText
required: false
schema:
type: string
RuleDisplayNameQueryParam:
description: 'A filter to return rules whose displayName matches in whole or in part the
specified value. The match is case-insensitive.
'
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
ObjectLocationQueryParam:
description: Location of the log file.
in: query
name: objectLocation
required: true
schema:
type: string
maxLength: 4000
minLength: 1
UpdateScheduledTaskDetailsBodyParam:
description: "Update details. \nSchedules may be updated only for taskType SAVED_SEARCH and PURGE.\n"
in: body
name: UpdateScheduledTaskDetails
required: true
schema:
$ref: '#/components/schemas/UpdateScheduledTaskDetails'
x-example: "application-json:\n{\n \"displayName\" : \"example for updating a SAVED_SEARCH task\"\n \"schedules\": [\n {\n \"type\": \"FIXED_FREQUENCY\",\n \"recurringInterval\": \"PT10M\",\n }\n ]\n}\n"
IsIgnoreWarningQueryParam:
description: is ignore warning
in: query
name: isIgnoreWarning
required: false
schema:
type: boolean
CompartmentIdQueryParamOptional:
description: The compartment id
in: query
name: compartmentId
required: false
x-default-description: 'null'
schema:
type: string
TimezoneQueryParam:
description: '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
'
in: query
name: timezone
required: false
x-default-description: 'null'
schema:
type: string
format: x-obmcs-time-zone
maxLength: 128
minLength: 1
LookupDisplayTextQueryParam:
description: 'The lookup text used for filtering. Only lookups with the specified name
or description will be returned.
'
in: query
name: lookupDisplayText
required: false
schema:
type: string
WarningStateQueryParam:
description: '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.
'
in: query
name: warningState
required: false
schema:
type: string
enum:
- ALL
- SUPPRESSED
- UNSUPPRESSED
default: UNSUPPRESSED
TemplateTypeQueryParam:
description: 'The template type used for filtering. Only templates of the
specified type will be returned.
'
in: query
name: type
required: false
schema:
type: string
HostNameContainsQueryParam:
description: 'A filter to return only log analytics entities whose hostname contains the substring given.
The match is case-insensitive.
'
in: query
name: hostnameContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
RequiredSourceNameQueryParam:
description: The souce name used for filtering associations.
in: query
name: sourceName
required: true
schema:
type: string
CategoryTypeQueryParam:
description: 'A comma-separated list of category types used for filtering. Only categories of the
specified types will be returned.
'
in: query
name: categoryType
required: false
schema:
type: string
CompartmentDeleteParam:
description: 'if true, the request is from compartment delete service.
'
in: query
name: isCompartmentDelete
required: false
schema:
type: boolean
default: false
TimeEndQueryParam:
description: 'Optional parameter to specify end of time range, in the format defined by RFC3339.
Default value is end of time.
'
in: query
name: timeEnd
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
LabelSortByQueryParam:
description: The attribute used to sort the returned labels
in: query
name: labelSortBy
schema:
type: string
enum:
- name
- priority
- sourceUsing
- timeUpdated
default: name
PropertyDisplayTextQueryParam:
description: 'The property display text used for filtering. Only properties matching the specified display
name or description will be returned.
'
in: query
name: displayText
required: false
schema:
type: string
InvalidateCacheQueryParam:
description: This property can be used to reset configuration cache in case of an issue with the upload.
in: query
name: invalidateCache
required: false
schema:
type: boolean
default: false
TimeDataStartedGreaterThanOrEqualQueryParam:
description: This is the start of the time range for recalled data
in: query
name: timeDataStartedGreaterThanOrEqual
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
ScopeQueryParam:
description: The scope used when testing a parser.
in: query
name: scope
required: false
schema:
type: string
enum:
- LOG_LINES
- LOG_ENTRIES
- LOG_LINES_LOG_ENTRIES
IsMatchAllQueryParam:
description: 'A flag indicating how to handle filtering when multiple filter criteria are specified.
A value of true will always result in the most expansive list of items being returned.
For example, if two field lists are supplies as filter criteria, a value of true will
result in any item matching a field in either list being returned, while a value of
false will result in a list of items which only have fields contained in both input lists.
'
in: query
name: isMatchAll
required: false
schema:
type: boolean
LogAnalyticsEmBridgeDisplayNameQueryParam:
description: 'A filter to return only log analytics enterprise manager bridge name whose name matches the entire name given. The match
is case-insensitive.
'
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ObjectCollectionRuleIdPathParam:
description: The Log Analytics Object Collection Rule [OCID](/iaas/Content/General/Concepts/identifiers.htm).
in: path
name: logAnalyticsObjectCollectionRuleId
required: true
schema:
type: string
maxLength: 255
minLength: 1
SqlQueryParam:
description: The SQL query from which column names are to be extracted.
in: query
name: sqlQuery
required: true
schema:
type: string
IngestTimeRuleFieldValueQueryParam:
description: 'The field value used for filtering. Only rules using the
specified field value will be returned.
'
in: query
name: fieldValue
required: false
schema:
type: string
PropertyLevelQueryParam:
description: 'The level for which applicable properties are to be listed.
'
in: query
name: level
required: false
schema:
type: string
default: TENANCY
SourceNamePathParam:
description: The source name.
in: path
name: sourceName
required: true
schema:
type: string
ParsersDisplayTextQueryParam:
description: 'The parser display text used for filtering. Only parsers with the specified name
or description will be returned.
'
in: query
name: parserDisplayText
required: false
schema:
type: string
IsSimplifiedQueryParam:
description: 'A flag specifying whether or not to return all source information, or a subset of the
information about each source. A value of true will return only the source unique
identifier and the source name. A value of false will return all source information
(such as author, updated date, system flag, etc.)
'
in: query
name: isSimplified
required: false
schema:
type: boolean
TemplateLifecycleStateQueryParam:
description: 'The template lifecycle state used for filtering. Currently supported
values are ACTIVE and DELETED.
'
in: query
name: lifecycleState
required: false
x-obmcs-top-level-enum: '#/definitions/ConfigLifecycleState'
schema:
type: string
enum:
- ACTIVE
- DELETED
default: ACTIVE
AutoAssocQueryParam:
description: 'An auto-associate flag used for filtering. Only sources which are marked for automatic
association will be returned.
'
in: query
name: isAutoAssociated
required: false
schema:
type: boolean
ParserActionsNameQueryParam:
description: 'The parser action name used for filtering.
'
in: query
name: name
required: false
schema:
type: string
EntityTypeOptionalQueryParam:
description: 'The entity type used for filtering. Only associations on an entity with the
specified type will be returned.
'
in: query
name: entityType
required: false
schema:
type: string
CharacterEncodingQueryParam:
description: '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.
'
in: query
name: charEncoding
required: false
x-default-description: 'null'
schema:
type: string
CreationSourceTypeQueryParam:
description: 'A filter to return only those log analytics entities with the specified auto-creation source.
'
in: query
name: creationSourceType
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- EM_BRIDGE
- BULK_DISCOVERY
- SERVICE_CONNECTOR_HUB
- DISCOVERY
- LOGGING_ANALYTICS
- NONE
maxItems: 2
minItems: 1
type: string
uniqueItems: true
x-obmcs-top-level-enum: '#/definitions/CreationSourceType'
default: []
FilterByDefinedTagExistsQueryParam:
description: 'A list of tag existence filters to apply. Only entities for which the specified defined tags exist will be returned.
Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag)
or "{namespace}.true". All inputs are case-insensitive.
Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
'
in: query
name: definedTagExists
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 207
type: string
EntityIdQueryParam:
description: 'The entity OCID.
'
in: query
name: entityId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
IsEnabledQueryParam:
description: 'The enabled flag used for filtering. Only items with the specified enabled value
will be returned.
'
in: query
name: isEnabled
schema:
type: boolean
default: true
EntityNameQueryParam:
description: 'The entity name used for filtering.
'
in: query
name: entityName
required: false
x-default-description: 'null'
schema:
type: string
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
AgentIdQueryParam:
description: 'The agent ocid.
'
in: query
name: agentId
required: false
schema:
type: string
TemplateNameQueryParam:
description: 'The template name used for filtering.
'
in: query
name: name
required: false
schema:
type: string
SourcePatternSortByQueryParam:
description: The attribute used to sort the returned source patterns
in: query
name: sortBy
schema:
type: string
enum:
- patternText
default: patternText
TemplateDisplayTextQueryParam:
description: 'The template display text used for filtering. Only templates with the specified name or
description will be returned.
'
in: query
name: templateDisplayText
required: false
schema:
type: string
SortByQueryParam:
description: '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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- timeUpdated
- displayName
default: timeCreated
ParserNamesQueryParam:
description: 'A list of parser names used for filtering. Only fields used by the specified
parsers will be returned.
'
in: query
name: parserNames
required: false
schema:
type: string
NamespaceNamePathParam:
description: 'The Log Analytics namespace used for the request. The namespace can be obtained by running ''oci os ns get''
'
in: path
name: namespaceName
required: true
schema:
type: string
maxLength: 256
minLength: 1
SourceIdQueryParam:
description: 'A filter to return only log analytics entities whose sourceId matches the sourceId given.
'
in: query
name: sourceId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
StartTimeQueryParam:
description: The warning start date query parameter.
in: query
name: startTime
required: false
schema:
type: string
LabelDisplayTextQueryParam:
description: 'The label display text used for filtering. Only labels with the specified name or
description will be returned.
'
in: query
name: labelDisplayText
required: false
schema:
type: string
LookupOrderByQueryParam:
description: sort by field
in: query
name: sortBy
schema:
type: string
enum:
- displayName
- status
- type
- updatedTime
- creationType
default: name
UploadNameOptionalQueryParam:
description: Name of the upload container.
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 512
minLength: 1
LogSetQueryParam:
description: 'The log set that gets associated with the uploaded logs.
'
in: query
name: logSet
required: false
x-default-description: 'null'
schema:
type: string
EntityLifecycleStateQueryParam:
description: 'A filter to return only those log analytics entities with the specified lifecycle state. The state
value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-obmcs-top-level-enum: '#/definitions/EntityLifecycleStates'
schema:
type: string
enum:
- ACTIVE
- DELETED
default: ACTIVE
FieldSortByQueryParam:
description: The attribute used to sort the returned fields
in: query
name: sortBy
schema:
type: string
enum:
- name
- dataType
- timeUpdated
default: name
TargetServiceQueryParam:
description: 'The target service to use for filtering.
'
in: query
name: targetService
required: false
schema:
type: string
DisplayNameQueryParam:
description: 'A filter to return only log analytics log groups whose displayName matches the entire display name given.
The match is case-insensitive.
'
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
CategoryNamePathParam:
description: The category name.
in: path
name: categoryName
required: true
schema:
type: string
PaginationTokenQueryParam:
description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
in: query
name: page
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 1024
minLength: 1
AssociatedEntitySortByQueryParam:
description: The attribute used to sort the returned entities
in: query
name: sortBy
schema:
type: string
enum:
- entityName
- entityTypeDisplayName
- associationCount
default: entityName
WarningSortByQueryParam:
description: The attribute used to sort the returned warnings
in: query
name: sortBy
schema:
type: string
enum:
- EntityType
- SourceName
- PatternText
- FirstReported
- WarningMessage
- Host
- EntityName
- InitialWarningDate
default: InitialWarningDate
OptionalContentMD5Header:
description: 'The base-64 encoded MD5 hash of the body. If the Content-MD5 header is present, Log 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)"
'
in: header
name: content-md5
x-default-description: 'null'
schema:
type: string
DirectOrAllAssociationsQueryParam:
description: 'Indicates whether to return direct associated entities or direct and inferred associated entities.
'
in: query
name: directOrAllAssociations
required: false
schema:
type: string
enum:
- DIRECT
- ALL
default: DIRECT
IsShowAssociatedSourcesCountQueryParam:
description: Option to return count of associated log sources for log analytics entity(s).
in: query
name: isShowAssociatedSourcesCount
required: false
schema:
type: boolean
default: false
SortByErrorsQueryParam:
description: '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.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
default: timeCreated
PreferenceSortByQueryParam:
description: The attribute used to sort the returned preferences.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- name
default: name
EntitiesSortByQueryParam:
description: '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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- timeUpdated
- name
default: timeCreated
RetryTokenHeader:
description: '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.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
EntitySearchTextQueryParam:
description: 'The text used for filtering returned entities. Search text is applicable to the
entity name and the entity description.
'
in: query
name: searchText
schema:
type: string
CategoryDisplayTextQueryParam:
description: 'The category display text used for filtering. Only categories matching the specified display
name or description will be returned.
'
in: query
name: categoryDisplayText
required: false
schema:
type: string
ScheduledTaskIdPathParam:
description: 'Unique scheduledTask id returned from task create.
If invalid will lead to a 404 not found.
'
in: path
name: scheduledTaskId
required: true
schema:
type: string
CloudResourceIdQueryParam:
description: 'A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.
'
in: query
name: cloudResourceId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
UploadWarningReferencePathParam:
description: Unique internal identifier to refer upload warning.
in: path
name: warningReference
required: true
schema:
type: string
maxLength: 255
minLength: 1
ListSourceTypeQueryParam:
description: The source type.
in: query
name: sourceType
required: false
x-default-description: 'null'
schema:
type: string
FilterByDefinedTagEqualsQueryParam:
description: 'A list of tag filters to apply. Only entities with a defined tag matching the value will be returned.
Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive.
Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
'
in: query
name: definedTagEquals
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 458
type: string
EntityTypeNameQueryParam:
description: '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.
'
in: query
name: entityTypeName
required: false
style: form
explode: true
schema:
type: array
items:
maxLength: 128
minLength: 1
type: string
uniqueItems: true
default: []
IngestTimeRuleConditionKindQueryParam:
description: 'The ingest time rule condition kind used for filtering. Only rules with conditions
of the specified kind will be returned.
'
in: query
name: conditionKind
required: false
schema:
type: string
enum:
- FIELD
default: FIELD
LogAnalyticsEntityIdentifierPathParam:
description: 'The log analytics entity ID [OCID]. Entity ID can be obtained by running ''oci log-analytics entity list --namespace-name --compartment-id ''. The json output ''id'' parameter value contains the entity ID.
'
in: path
name: logAnalyticsEntityId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DateYearQueryParam:
description: 'Used to indicate the year where the log entries timestamp do not mention year (Ex: Nov 8 20:45:56).
'
in: query
name: dateYear
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 4
minLength: 1
ParserTypeQueryParam:
description: 'The parser type used for filtering. Only items with, or associated with, parsers
of the specified type will be returned.
'
in: query
name: parserType
required: false
schema:
type: string
enum:
- ALL
- REGEX
- XML
- JSON
- ODL
- DELIMITED
default: ALL
RequestOriginModuleQueryParam:
description: 'The module to test. A value of ''ParserFunctionTest'' will result in testing of
the parser functions.
'
in: query
name: reqOriginModule
required: false
schema:
type: string
OrderByQueryParam:
description: The attribute used to sort the returned items
in: query
name: sortBy
schema:
type: string
enum:
- name
default: name
UploadReferencePathParam:
description: Unique internal identifier to refer upload container.
in: path
name: uploadReference
required: true
schema:
type: string
maxLength: 255
minLength: 1
LogAnalyticsAssociationLifeCycleStateQueryParam:
description: 'The life cycle state used for filtering. Only associations with the specified
life cycle state will be returned.
'
in: query
name: lifeCycleState
required: false
schema:
type: string
enum:
- ALL
- ACCEPTED
- IN_PROGRESS
- SUCCEEDED
- FAILED
default: ALL
UploadsPaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
default: 50
maximum: 200
minimum: 1
responses:
default:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
x-anchors:
x-headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
location:
description: 'URI to entity or work request created.
'
type: string
opc-content-md5:
description: The base-64 encoded MD5 hash of the request body as computed by the server.
type: string
opc-deleted-log-count:
description: Deleted log records count.
format: int64
type: integer
opc-deleted-logfile-count:
description: Deleted log files count.
format: int64
type: integer
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the next page of the list. Include this value as the `page` parameter for the
subsequent request to get the next batch of items.
'
type: string
opc-object-id:
description: Unique Oracle-assigned identifier for log data.
type: string
opc-prev-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then additional items may be available on the previous page of the list. Include this value as the `page` parameter for the
subsequent request to get the previous batch of items.
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. When you contact Oracle about a specific request, provide the request ID.
'
type: string
opc-retry-token:
description: 'Unique Oracle-assigned identifier for the create request.
'
type: string
opc-total-items:
description: Total count.
format: int64
type: integer
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
format: float
type: number
timeCreated:
description: The time the upload was created, in the format defined by RFC3339
format: date-time
type: string
x-properties:
activeEmBridgeCount:
description: 'Total number of ACTIVE enterprise manager bridges.
'
format: int32
type: integer
activeEntitiesCount:
description: 'Total number of ACTIVE entities
'
format: int32
type: integer
allEntitiesCount:
description: 'Total entities count. This includes ACTIVE and DELETED entities
'
format: int32
type: integer
areLogsCollected:
description: 'The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
'
type: boolean
associatedSourcesCount:
description: 'The count of associated log sources for a given log analytics entity.
'
format: int32
type: integer
category:
description: 'Log analytics entity type category. Category will be used for grouping and filtering.
'
maxLength: 128
minLength: 1
type: string
cloudResourceId:
description: 'The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity
represents a non-cloud resource that the customer may have on their premises.
'
maxLength: 255
minLength: 1
type: string
cloudType:
default: NON_CLOUD
description: 'Log analytics entity type group. Supported values: ClOUD, NON_CLOUD.
'
enum:
- CLOUD
- NON_CLOUD
type: string
compartmentId:
description: Compartment Identifier [OCID] (/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 100
type: string
compartmentIdInSubtree:
default: false
description: 'Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
'
type: boolean
creatingEmBridgeCount:
description: 'Number of enterprise manager bridges in CREATING state.
'
format: int32
type: integer
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
deletedEmBridgeCount:
description: 'Number of enterprise manager bridges in DELETED state.
'
format: int32
type: integer
description:
description: 'Description for this resource.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name that is changeable and that does not have to be unique.
Format: a leading alphanumeric, followed by zero or more
alphanumerics, underscores, spaces, backslashes, or hyphens in any order).
No trailing spaces allowed.
'
maxLength: 255
minLength: 1
type: string
emBridgeBucketName:
description: Object store bucket name where enterprise manager harvested entities will be uploaded.
maxLength: 255
minLength: 1
type: string
emBridgeDescription:
description: 'A description for log analytics enterprise manager bridge.
'
maxLength: 1024
minLength: 1
type: string
emBridgeDisplayName:
description: 'Log analytics enterprise manager bridge display name.
'
maxLength: 128
minLength: 1
type: string
emBridgeId:
description: 'The enterprise manager bridge OCID.
'
maxLength: 255
minLength: 1
type: string
emBridgelifecycleDetails:
description: 'lifecycleDetails has additional information regarding substeps such as verifying connection to object store.
'
type: string
emEntitiesCompartmentId:
description: 'Compartment for entities created from enterprise manager.
'
maxLength: 255
minLength: 1
type: string
entitiesWithHasLogsCollectedCount:
description: 'Entities with log collection enabled
'
format: int32
type: integer
entitiesWithManagementAgentCount:
description: 'Entities with management agent
'
format: int32
type: integer
entityTypeInternalName:
description: 'Internal name for the log analytics entity type.
'
maxLength: 160
minLength: 1
type: string
entityTypeName:
description: 'Log analytics entity type name.
'
maxLength: 128
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
hostname:
description: 'The hostname where the entity represented here is actually present. This would be the output one would get if
they run `echo $HOSTNAME` on Linux or an equivalent OS command. This may be different from
management agents host since logs may be collected remotely.
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The log analytics entity OCID. This ID is a reference used by log analytics features and it represents
a resource that is provisioned and managed by the customer on their premises or on the cloud.
'
maxLength: 255
minLength: 1
type: string
lastImportProcessingDetails:
description: 'Processing status details of enterprise manager upload. This provides additional details
for failed status
'
type: string
lifecycleDetails:
description: 'lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
'
maxLength: 255
minLength: 1
type: string
managementAgentCompartmentId:
description: 'Management agent (management-agents resource kind) compartment OCID
'
maxLength: 255
minLength: 1
type: string
managementAgentDisplayName:
description: 'Management agent (management-agents resource kind) display name
'
maxLength: 255
minLength: 1
type: string
managementAgentId:
description: 'The OCID of the Management Agent.
'
maxLength: 255
minLength: 1
type: string
maxTotalCount:
default: 500
description: 'Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).
'
format: int32
maximum: 2001
minimum: 1
type: integer
moveCompartmentId:
description: 'The OCID of the compartment where the log analytics entity should be moved.
'
maxLength: 255
minLength: 1
type: string
name:
description: 'Log analytics entity name.
'
maxLength: 255
minLength: 1
type: string
needsAttentionEmBridgeCount:
description: 'Number of enterprise manager bridges in NEEDS_ATTENTION state.
'
format: int32
type: integer
percentComplete:
description: 'Percentage progress completion of the work request.
'
format: int32
maximum: 100
minimum: 0
type: integer
properties:
additionalProperties:
maxLength: 512
minLength: 1
type: string
description: 'The name/value pairs for parameter values to be used in file patterns specified in log sources.
'
type: object
sourceId:
description: 'This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
'
maxLength: 255
minLength: 1
type: string
timeAccepted:
description: 'When the work request was accepted. Should match timeStarted in all cases.
'
format: date-time
type: string
timeCreated:
description: 'The date and time the resource was created, in the format defined by RFC3339.
'
format: date-time
type: string
timeEmDataLastExtracted:
description: 'The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339
'
format: date-time
type: string
timeExpires:
description: When the work request will expire.
format: date-time
type: string
timeFinished:
description: When the work request finished execution.
format: date-time
type: string
timeImportLastProcessed:
description: 'The last time of enterprise manager upload was processed. This is in the format defined by RFC3339
'
format: date-time
type: string
timeLastDiscovered:
description: 'The date and time the resource was last discovered, in the format defined by RFC3339.
'
format: date-time
type: string
timeStarted:
description: When the work request started.
format: date-time
type: string
timeUpdated:
description: 'The date and time the resource was last updated, in the format defined by RFC3339.
'
format: date-time
type: string
timezoneRegion:
description: 'The timezone region of the log analytics entity.
'
format: x-obmcs-time-zone
maxLength: 64
minLength: 1
type: string
totalEmBridgeCount:
description: 'Total number of enterprise manager bridges.
'
format: int32
type: integer