Jump to

• Request
• Response

Search cluster logs

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/searchLogs

Searches logs within the specified cluster and time range. Supports pagination and filtering.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• clusterKey(required): string
  Cluster key.
• workspaceKey(required): string
  The key of the Workspace

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running 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 removed from the system, then a retry of the original creation request might be rejected.

Body ()

Request body containing the search parameters for cluster logs.

Root Schema : SearchClusterLogsDetails

Type: object

Request payload for searching logs in a cluster.

Show Source

• advancedFilter: string
  Contains any key and value that you want to search in the logs. Should be provided in the format 'key = value'. As of now supported keys are 'taskRunKey' and 'jobRunKey'

  Example: taskRunKey = c75b2b5e-b104-48ac-ae82-3acbdc638ab2
• eventType: string
  Filters logs based on the event type. Supported only when `logContentTypeContains` is `events`.

  Example: CREATING
• executionContextId: string
  The execution context identifier associated with the log. Supported only when `logContentTypeContains` is `executor` or `driver`.
• logContentTypeContains(required): string
  The string represent the type of compute logs Common values include `events`, `driver`, `executor`.

  Example: events
• logLevel: string
  The severity level of the log messages to filter. Common values include `INFO`, `WARN`, `ERROR`, `DEBUG`, etc. Supported only when `logContentTypeContains` is `executor` or `driver`.

  Example: ERROR
• logStreamTypeContains: string
  Filters logs based on the output stream type. - This includes standard output (`stdout`) for regular program output - and standard error (`stderr`) for error messages and diagnostics. Only supported when logContentTypeContains=executor/driver.

  Example: stderr
• messageContains: string
  The string represent a filter to search message string from the log Supported only when `logContentTypeContains` is `events`.
• opcRequestId: string
  The unique request identifier used for tracking the API call. Supported only when `logContentTypeContains` is `executor` or `driver`.

  Example: bce8d78b-6f12-4a99-95d2-3f44440c54a9
• subjectContains: string
  The string represent the specific of compute nodes Common values include `spark-driver`, `spark-executor-1`.

  Example: executor-1
• thread: string
  The thread identifier that generated the log. Supported only when `logContentTypeContains` is `executor` or `driver`.
• timeBegin(required): string(date-time)
  Start filter log's date and time, in RFC 3339 format.
• timeEnd(required): string(date-time)
  End filter log's date and time, in RFC 3339 format.

{
    "type":"object",
    "description":"Request payload for searching logs in a cluster.",
    "required":[
        "timeBegin",
        "timeEnd",
        "logContentTypeContains"
    ],
    "properties":{
        "timeBegin":{
            "type":"string",
            "format":"date-time",
            "description":"Start filter log's date and time, in RFC 3339 format."
        },
        "timeEnd":{
            "type":"string",
            "format":"date-time",
            "description":"End filter log's date and time, in RFC 3339 format."
        },
        "logContentTypeContains":{
            "type":"string",
            "description":"The string represent the type of compute logs \nCommon values include `events`, `driver`, `executor`.\n",
            "example":"events"
        },
        "subjectContains":{
            "type":"string",
            "description":"The string represent the specific of compute nodes\nCommon values include `spark-driver`, `spark-executor-1`.\n",
            "example":"executor-1"
        },
        "messageContains":{
            "type":"string",
            "description":"The string represent a filter to search message string from the log\nSupported only when `logContentTypeContains` is `events`.\n"
        },
        "logLevel":{
            "type":"string",
            "description":"The severity level of the log messages to filter. \nCommon values include `INFO`, `WARN`, `ERROR`, `DEBUG`, etc.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n",
            "example":"ERROR"
        },
        "opcRequestId":{
            "type":"string",
            "description":"The unique request identifier used for tracking the API call.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n",
            "example":"bce8d78b-6f12-4a99-95d2-3f44440c54a9"
        },
        "advancedFilter":{
            "type":"string",
            "description":"Contains any key and value that you want to search in the logs.\nShould be provided in the format 'key = value'. As of now supported keys are 'taskRunKey' and 'jobRunKey'\n",
            "example":"taskRunKey = c75b2b5e-b104-48ac-ae82-3acbdc638ab2"
        },
        "thread":{
            "type":"string",
            "description":"The thread identifier that generated the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n"
        },
        "executionContextId":{
            "type":"string",
            "description":"The execution context identifier associated with the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n"
        },
        "logStreamTypeContains":{
            "type":"string",
            "description":"Filters logs based on the output stream type. \n- This includes standard output (`stdout`) for regular program output \n- and standard error (`stderr`) for error messages and diagnostics.\nOnly supported when logContentTypeContains=executor/driver.\n",
            "example":"stderr"
        },
        "eventType":{
            "type":"string",
            "description":"Filters logs based on the event type.\nSupported only when `logContentTypeContains` is `events`.\n",
            "example":"CREATING"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. A collection of logs for the specified parameters is retrieved.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : ClusterLogCollection

Type: object

Results of a cluster log list.

Show Source

• items(required): array items
  List of cluster logs.

{
    "type":"object",
    "description":"Results of a cluster log list.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of cluster logs.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ClusterLogsSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of cluster logs.

Show Source

• Array of: object ClusterLogsSummary
  Response payload containing search results and metadata.

{
    "description":"List of cluster logs.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ClusterLogsSummary"
    }
}

Nested Schema : ClusterLogsSummary

Type: object

Response payload containing search results and metadata.

Show Source

• fields: array fields
  List of log field schema information.
• results(required): array results
  List of search results.
• summary(required): object SearchResultSummary
  Summary of the search response.

{
    "type":"object",
    "description":"Response payload containing search results and metadata.",
    "required":[
        "results",
        "summary"
    ],
    "properties":{
        "fields":{
            "type":"array",
            "description":"List of log field schema information.",
            "items":{
                "$ref":"#/definitions/FieldInfo"
            }
        },
        "results":{
            "type":"array",
            "description":"List of search results.",
            "items":{
                "$ref":"#/definitions/SearchResult"
            }
        },
        "summary":{
            "$ref":"#/definitions/SearchResultSummary"
        }
    }
}

Nested Schema : fields

Type: array

List of log field schema information.

Show Source

• Array of: object FieldInfo
  Schema details of log fields.

{
    "type":"array",
    "description":"List of log field schema information.",
    "items":{
        "$ref":"#/definitions/FieldInfo"
    }
}

Nested Schema : results

Type: array

List of search results.

Show Source

• Array of: object SearchResult
  A single search result.

{
    "type":"array",
    "description":"List of search results.",
    "items":{
        "$ref":"#/definitions/SearchResult"
    }
}

Nested Schema : SearchResultSummary

Type: object

Summary of the search response.

Show Source

• fieldCount(required): integer
  Total number of field schema information.
• resultCount(required): integer
  Total number of search results.

{
    "type":"object",
    "description":"Summary of the search response.",
    "required":[
        "resultCount",
        "fieldCount"
    ],
    "properties":{
        "resultCount":{
            "type":"integer",
            "description":"Total number of search results."
        },
        "fieldCount":{
            "type":"integer",
            "description":"Total number of field schema information."
        }
    }
}

Nested Schema : FieldInfo

Type: object

Schema details of log fields.

Show Source

• fieldName(required): string
  Minimum Length: 1

  Maximum Length: 1024

  The name of the field.
• fieldType(required): string
  Allowed Values: [ "STRING", "NUMBER", "BOOLEAN", "ARRAY" ]

  The type of the field.

{
    "type":"object",
    "description":"Schema details of log fields.",
    "required":[
        "fieldName",
        "fieldType"
    ],
    "properties":{
        "fieldName":{
            "type":"string",
            "minLength":1,
            "maxLength":1024,
            "description":"The name of the field."
        },
        "fieldType":{
            "type":"string",
            "description":"The type of the field.",
            "enum":[
                "STRING",
                "NUMBER",
                "BOOLEAN",
                "ARRAY"
            ]
        }
    }
}

Nested Schema : SearchResult

Type: object

A single search result.

Show Source

• data(required): object data
  The actual log data with field mappings.

{
    "type":"object",
    "description":"A single search result.",
    "required":[
        "data"
    ],
    "properties":{
        "data":{
            "type":"object",
            "description":"The actual log data with field mappings."
        }
    }
}

Nested Schema : data

Type: object

The actual log data with field mappings.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top