Jump to

• Request
• Response

Download cluster logs

post

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

Downloads logs within the specified cluster and time range. The logs can be filtered by severity (`logLevel`), type (`logContentTypeContains`), and other parameters such as execution context and thread identifiers.

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

Header Parameters

• 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 payload containing the parameters for filtering cluster logs.

Root Schema : DownloadClusterLogsDetails

Type: object

Request payload for downloading logs in a cluster.

Show Source

• clientContext: string
  UI-generated identifier to correlate the async job.
• 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`.

  Example: aaa-bbb-ccc-ddd
• logContentTypeContains(required): string
  The string represent the type of compute logs Common values include `events`, `driver`, `executor`. Supported only when `logContentTypeContains` is `executor` or `driver`.

  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
• 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`.

  Example: oracle.dataflow.commons.server.uds.UdsRequestHandlerTask
• timeBegin(required): string(date-time)
  Start filter log's date and time, in RFC 3339 format.

  Example: 2025-03-16T00:00:00Z
• timeEnd(required): string(date-time)
  End filter log's date and time, in RFC 3339 format.

  Example: 2025-03-16T23:59:59Z

{
    "type":"object",
    "description":"Request payload for downloading 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.",
            "example":"2025-03-16T00:00:00Z"
        },
        "timeEnd":{
            "type":"string",
            "format":"date-time",
            "description":"End filter log's date and time, in RFC 3339 format.",
            "example":"2025-03-16T23:59:59Z"
        },
        "logContentTypeContains":{
            "type":"string",
            "description":"The string represent the type of compute logs \nCommon values include `events`, `driver`, `executor`.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n",
            "example":"events"
        },
        "clientContext":{
            "type":"string",
            "description":"UI-generated identifier to correlate the async job.\n"
        },
        "subjectContains":{
            "type":"string",
            "description":"The string represent the specific of compute nodes\nCommon values include `spark-driver`, `spark-executor-1`.\n",
            "example":"executor-1"
        },
        "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"
        },
        "thread":{
            "type":"string",
            "description":"The thread identifier that generated the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n",
            "example":"oracle.dataflow.commons.server.uds.UdsRequestHandlerTask"
        },
        "executionContextId":{
            "type":"string",
            "description":"The execution context identifier associated with the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n",
            "example":"aaa-bbb-ccc-ddd"
        },
        "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

202 Response

Request accepted. Log download is initiated.

Headers

• aidp-async-operation-key: string
  The key of the asynchronous operations associated with an AI Data Platform instance. Use GetAsyncOperation with this key to track the status of the request.
• datalake-cluster-log-par-url: string
  This string represents the PAR URL for the compute log file. The `datalake-cluster-log-par-url` should be used only after the `aidp-async-operation-key` status reaches the SUCCEEDED state. If accessed before the operation completes, the file may be incomplete.
• 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.

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