Jump to

• Request
• Response

(Preview) Search deployment lifecycle logs

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/model-deployments/{deploymentId}/monitoring/logs/search

(Preview) Returns one page of deployment lifecycle log events for the model deployment, newest first, read live from OCI Logging. No log content is persisted by the platform.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• deploymentId(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[0-9a-f]{32}$

  The unique 32-character hexadecimal ID of the model deployment.

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  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.

Body ()

Window, filters, and pagination for the log search.

Root Schema : SearchDeploymentLogsDetails

Type: object

Filters and pagination for searching deployment lifecycle logs.

Show Source

• levels: array levels
  Maximum Number of Items: 6

  Optional severity filter. Allowed values: DEBUG, INFO, WARNING, ERROR, CRITICAL, UNKNOWN; any other value is rejected with 400. An empty or absent array means all levels.
• limit: integer(int32)
  Minimum Value: 1

  Maximum Value: 20

  Default Value: 20

  Maximum rows per page.
• opcRequestId: string
  Maximum Length: 1024

  Optional exact match on the original request identifier of a log event. Only events that carry a request identifier can match. Model deployment lifecycle events are not emitted per request and carry none, so this filter excludes them.
• pageToken: string
  Maximum Length: 4096

  Opaque continuation token from a previous page. Bound to the platform, deployment, and query; expires.
• replicaId: string
  Maximum Length: 255

  Optional exact match on the emitting replica or source scope.
• sortBy: string
  Allowed Values: [ "TIMESTAMP" ]

  Sort column. Only TIMESTAMP is supported.
• sortOrder: string
  Allowed Values: [ "DESC" ]

  Sort order. Only DESC is supported.
• timeEnd(required): string(date-time)
  End of the requested publish-time window (RFC 3339, exclusive). Must not be in the future.
• timeStart(required): string(date-time)
  Start of the requested publish-time window (RFC 3339, inclusive).

{
    "description":"Filters and pagination for searching deployment lifecycle logs.",
    "type":"object",
    "required":[
        "timeStart",
        "timeEnd"
    ],
    "properties":{
        "timeStart":{
            "description":"Start of the requested publish-time window (RFC 3339, inclusive).",
            "type":"string",
            "format":"date-time"
        },
        "timeEnd":{
            "description":"End of the requested publish-time window (RFC 3339, exclusive). Must not be in the future.",
            "type":"string",
            "format":"date-time"
        },
        "levels":{
            "description":"Optional severity filter. Allowed values: DEBUG, INFO, WARNING, ERROR, CRITICAL, UNKNOWN; any other value is rejected with 400. An empty or absent array means all levels.",
            "type":"array",
            "maxItems":6,
            "items":{
                "type":"string",
                "maxLength":16
            }
        },
        "opcRequestId":{
            "description":"Optional exact match on the original request identifier of a log event. Only events that carry a request identifier can match. Model deployment lifecycle events are not emitted per request and carry none, so this filter excludes them.",
            "type":"string",
            "maxLength":1024
        },
        "replicaId":{
            "description":"Optional exact match on the emitting replica or source scope.",
            "type":"string",
            "maxLength":255
        },
        "sortBy":{
            "description":"Sort column. Only TIMESTAMP is supported.",
            "type":"string",
            "enum":[
                "TIMESTAMP"
            ]
        },
        "sortOrder":{
            "description":"Sort order. Only DESC is supported.",
            "type":"string",
            "enum":[
                "DESC"
            ]
        },
        "limit":{
            "description":"Maximum rows per page.",
            "type":"integer",
            "format":"int32",
            "minimum":1,
            "maximum":20,
            "default":20
        },
        "pageToken":{
            "description":"Opaque continuation token from a previous page. Bound to the platform, deployment, and query; expires.",
            "type":"string",
            "maxLength":4096
        }
    }
}

Nested Schema : levels

Type: array

Maximum Number of Items: 6

Optional severity filter. Allowed values: DEBUG, INFO, WARNING, ERROR, CRITICAL, UNKNOWN; any other value is rejected with 400. An empty or absent array means all levels.

Show Source

• Array of: string
  Maximum Length: 16

{
    "description":"Optional severity filter. Allowed values: DEBUG, INFO, WARNING, ERROR, CRITICAL, UNKNOWN; any other value is rejected with 400. An empty or absent array means all levels.",
    "type":"array",
    "maxItems":6,
    "items":{
        "type":"string",
        "maxLength":16
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. A page of deployment log events is returned.

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 : DeploymentLogCollection

Type: object

Result of searching deployment lifecycle logs.

Show Source

• coverage(required): object DeploymentLogCoverage
  How completely the underlying log source can serve the requested window.
• deploymentId(required): string
  The model deployment the logs belong to.
• logs(required): object DeploymentLogPage
  One page of deployment log events.
• query(required): object DeploymentLogQueryEcho
  Echo of the executed query and its consistency.

{
    "description":"Result of searching deployment lifecycle logs.",
    "type":"object",
    "required":[
        "deploymentId",
        "logs",
        "query",
        "coverage"
    ],
    "properties":{
        "deploymentId":{
            "description":"The model deployment the logs belong to.",
            "type":"string"
        },
        "logs":{
            "$ref":"#/definitions/DeploymentLogPage"
        },
        "query":{
            "$ref":"#/definitions/DeploymentLogQueryEcho"
        },
        "coverage":{
            "$ref":"#/definitions/DeploymentLogCoverage"
        }
    }
}

Nested Schema : DeploymentLogCoverage

Type: object

How completely the underlying log source can serve the requested window.

Show Source

• reasons: array reasons
  Machine-readable reasons explaining why coverage is not complete, when applicable.
• retentionDays: integer(int32)
  Configured retention of the current log object, when readable.
• state(required): string
  Allowed Values: [ "UNKNOWN", "PARTIAL", "COMPLETE_WITHIN_RETENTION" ]

  COMPLETE_WITHIN_RETENTION only when the window lies inside verified retention and the scan was not truncated. PARTIAL only with an affirmatively known gap. Otherwise UNKNOWN.

{
    "description":"How completely the underlying log source can serve the requested window.",
    "type":"object",
    "required":[
        "state"
    ],
    "properties":{
        "state":{
            "description":"COMPLETE_WITHIN_RETENTION only when the window lies inside verified retention and the scan was not truncated. PARTIAL only with an affirmatively known gap. Otherwise UNKNOWN.",
            "type":"string",
            "enum":[
                "UNKNOWN",
                "PARTIAL",
                "COMPLETE_WITHIN_RETENTION"
            ]
        },
        "retentionDays":{
            "description":"Configured retention of the current log object, when readable.",
            "type":"integer",
            "format":"int32"
        },
        "reasons":{
            "description":"Machine-readable reasons explaining why coverage is not complete, when applicable.",
            "type":"array",
            "items":{
                "type":"string",
                "maxLength":255
            }
        }
    }
}

Nested Schema : DeploymentLogPage

Type: object

One page of deployment log events.

Show Source

• items(required): array items
  Log events for this page, newest first. May be empty while nextPageToken is set.
• nextPageToken: string
  Maximum Length: 4096

  Continuation token. Absent when the traversal is complete. An empty page with a token means the scan quota ended before matches were found; continue.

{
    "description":"One page of deployment log events.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"Log events for this page, newest first. May be empty while nextPageToken is set.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeploymentLogSummary"
            }
        },
        "nextPageToken":{
            "description":"Continuation token. Absent when the traversal is complete. An empty page with a token means the scan quota ended before matches were found; continue.",
            "type":"string",
            "maxLength":4096
        }
    }
}

Nested Schema : DeploymentLogQueryEcho

Type: object

Echo of the executed query and its consistency.

Show Source

• consistency(required): string
  Allowed Values: [ "BEST_EFFORT" ]

  Consistency of the returned page. Always BEST_EFFORT for a live read of the log source.
• sortBy: string
  Sort column applied to the results. Only TIMESTAMP is supported.
• sortOrder: string
  Sort order applied to the results. Only DESC is supported.
• timeEnd(required): string(date-time)
  End of the publish-time window the query was evaluated against (RFC 3339, exclusive).
• timeEvaluated(required): string(date-time)
  Retrieval time. Not a claim that ingestion is complete through this instant.
• timeStart(required): string(date-time)
  Start of the publish-time window the query was evaluated against (RFC 3339, inclusive).

{
    "description":"Echo of the executed query and its consistency.",
    "type":"object",
    "required":[
        "timeStart",
        "timeEnd",
        "timeEvaluated",
        "consistency"
    ],
    "properties":{
        "timeStart":{
            "description":"Start of the publish-time window the query was evaluated against (RFC 3339, inclusive).",
            "type":"string",
            "format":"date-time"
        },
        "timeEnd":{
            "description":"End of the publish-time window the query was evaluated against (RFC 3339, exclusive).",
            "type":"string",
            "format":"date-time"
        },
        "sortBy":{
            "description":"Sort column applied to the results. Only TIMESTAMP is supported.",
            "type":"string"
        },
        "sortOrder":{
            "description":"Sort order applied to the results. Only DESC is supported.",
            "type":"string"
        },
        "timeEvaluated":{
            "description":"Retrieval time. Not a claim that ingestion is complete through this instant.",
            "type":"string",
            "format":"date-time"
        },
        "consistency":{
            "description":"Consistency of the returned page. Always BEST_EFFORT for a live read of the log source.",
            "type":"string",
            "enum":[
                "BEST_EFFORT"
            ]
        }
    }
}

Nested Schema : reasons

Type: array

Machine-readable reasons explaining why coverage is not complete, when applicable.

Show Source

• Array of: string
  Maximum Length: 255

{
    "description":"Machine-readable reasons explaining why coverage is not complete, when applicable.",
    "type":"array",
    "items":{
        "type":"string",
        "maxLength":255
    }
}

Nested Schema : items

Type: array

Log events for this page, newest first. May be empty while nextPageToken is set.

Show Source

• Array of: object DeploymentLogSummary
  One deployment lifecycle log event.

{
    "description":"Log events for this page, newest first. May be empty while nextPageToken is set.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DeploymentLogSummary"
    }
}

Nested Schema : DeploymentLogSummary

Type: object

One deployment lifecycle log event.

Show Source

• isDetailAvailable(required): boolean
  Whether the log detail operation can resolve this record.
• latencyMs: number(double)
  Latency in milliseconds, when the event carries one. Zero is a real value, distinct from absent.
• level(required): string
  Allowed Values: [ "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL", "UNKNOWN" ]

  Normalized severity. Unrecognized producer values are returned as UNKNOWN.
• logId(required): string
  Maximum Length: 4096

  Opaque, expiring locator usable with the log detail operation.
• opcRequestId: string
  Maximum Length: 1024

  Original request identifier. Absent when the event carries none. Model deployment lifecycle events are not emitted per request and never carry one.
• recordId(required): string
  Maximum Length: 128

  Stable identity of the ingested log record.
• replicaId: string
  Maximum Length: 255

  Emitting replica or source scope, when the event carries one.
• timestamp(required): string(date-time)
  Displayed event time (RFC 3339 UTC). Producer event time when available; otherwise the publish time, per timestampSource.
• timestampSource(required): string
  Allowed Values: [ "EVENT_TIME", "PUBLISH_TIME" ]

  EVENT_TIME when the producer timestamp was valid; PUBLISH_TIME when the displayed value fell back to the provider publish time.

{
    "description":"One deployment lifecycle log event.",
    "type":"object",
    "required":[
        "recordId",
        "logId",
        "timestamp",
        "timestampSource",
        "level",
        "isDetailAvailable"
    ],
    "properties":{
        "recordId":{
            "description":"Stable identity of the ingested log record.",
            "type":"string",
            "maxLength":128
        },
        "logId":{
            "description":"Opaque, expiring locator usable with the log detail operation.",
            "type":"string",
            "maxLength":4096
        },
        "timestamp":{
            "description":"Displayed event time (RFC 3339 UTC). Producer event time when available; otherwise the publish time, per timestampSource.",
            "type":"string",
            "format":"date-time"
        },
        "timestampSource":{
            "description":"EVENT_TIME when the producer timestamp was valid; PUBLISH_TIME when the displayed value fell back to the provider publish time.",
            "type":"string",
            "enum":[
                "EVENT_TIME",
                "PUBLISH_TIME"
            ]
        },
        "level":{
            "description":"Normalized severity. Unrecognized producer values are returned as UNKNOWN.",
            "type":"string",
            "enum":[
                "DEBUG",
                "INFO",
                "WARNING",
                "ERROR",
                "CRITICAL",
                "UNKNOWN"
            ]
        },
        "opcRequestId":{
            "description":"Original request identifier. Absent when the event carries none. Model deployment lifecycle events are not emitted per request and never carry one.",
            "type":"string",
            "maxLength":1024
        },
        "latencyMs":{
            "description":"Latency in milliseconds, when the event carries one. Zero is a real value, distinct from absent.",
            "type":"number",
            "format":"double"
        },
        "replicaId":{
            "description":"Emitting replica or source scope, when the event carries one.",
            "type":"string",
            "maxLength":255
        },
        "isDetailAvailable":{
            "description":"Whether the log detail operation can resolve this record.",
            "type":"boolean"
        }
    }
}

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"
        }
    }
}

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