Jump to

• Request
• Response

(Preview) List logged models

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/logged-models/search

(Preview) Returns a list of logged models.

Request

Path Parameters

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

Header Parameters

• dh-user-principal: string
  The DH User Principal Header .
• 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.

Body ()

Details of logged models to fetch.

Root Schema : ListLoggedModelsDetails

Type: object

Details of logged models to fetch.

Show Source

• experiment_ids: array experiment_ids
  Fetch logged-models under list of experiments.
• filter: string
  A filter expression over logged-models attributes.
• max_results: integer(int64)
  Maximum number of logged-models desired. Servers may select a default. Callers are encouraged to pass max_results explicitly and leverage page_token to iterate.
• order_by: array order_by
  List of attributes for ordering search results.
• page_token: string
  Token indicating the page of logged-models to fetch.

{
    "description":"Details of logged models to fetch.",
    "type":"object",
    "properties":{
        "experiment_ids":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Fetch logged-models under list of experiments.\n"
        },
        "max_results":{
            "type":"integer",
            "format":"int64",
            "description":"Maximum number of logged-models desired. Servers may select a default. Callers are encouraged to \npass max_results explicitly and leverage page_token to iterate.\n"
        },
        "page_token":{
            "type":"string",
            "description":"Token indicating the page of logged-models to fetch."
        },
        "filter":{
            "type":"string",
            "description":"A filter expression over logged-models attributes.\n"
        },
        "order_by":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LoggedModelOrder"
            },
            "description":"List of attributes for ordering search results.\n"
        }
    }
}

Nested Schema : experiment_ids

Type: array

Fetch logged-models under list of experiments.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Fetch logged-models under list of experiments.\n"
}

Nested Schema : order_by

Type: array

List of attributes for ordering search results.

Show Source

• Array of: object LoggedModelOrder
  LoggedModelOrder.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LoggedModelOrder"
    },
    "description":"List of attributes for ordering search results.\n"
}

Nested Schema : LoggedModelOrder

Type: object

LoggedModelOrder.

Show Source

• ascending: boolean
  Whether the order is ascending.
• field_name(required): string
  Field name. Allowed values are creation_time.

{
    "type":"object",
    "description":"LoggedModelOrder.",
    "required":[
        "field_name"
    ],
    "properties":{
        "field_name":{
            "description":"Field name. Allowed values are creation_time.",
            "type":"string"
        },
        "ascending":{
            "description":"Whether the order is ascending.",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. List of logged models 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 : LoggedModelCollection

Type: object

Result of listing logged-models.

Show Source

• models: array models
  Logged models that match the search criteria
• next_page_token: string
  Token that can be used to retrieve the next page of logged-models. An empty token means that no more logged-models are available for retrieval.

{
    "type":"object",
    "description":"Result of listing logged-models.",
    "properties":{
        "models":{
            "description":"Logged models that match the search criteria",
            "type":"array",
            "items":{
                "$ref":"#/definitions/LoggedModel"
            }
        },
        "next_page_token":{
            "description":"Token that can be used to retrieve the next page of logged-models. An empty token means that no more logged-models are available for retrieval.",
            "type":"string"
        }
    }
}

Nested Schema : models

Type: array

Logged models that match the search criteria

Show Source

• Array of: object LoggedModel
  Details of the logged model.

{
    "description":"Logged models that match the search criteria",
    "type":"array",
    "items":{
        "$ref":"#/definitions/LoggedModel"
    }
}

Nested Schema : LoggedModel

Type: object

Details of the logged model.

Show Source

• data: object data
  Additional Properties Allowed: true

  Details of the logged model data.
• info: object LoggedModelInfo
  Details of the logged model info.

{
    "type":"object",
    "description":"Details of the logged model.",
    "properties":{
        "info":{
            "$ref":"#/definitions/LoggedModelInfo"
        },
        "data":{
            "description":"Details of the logged model data.",
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : data

Type: object

Additional Properties Allowed: true

Details of the logged model data.

Nested Schema : LoggedModelInfo

Type: object

Details of the logged model info.

Show Source

• artifact_uri: string
  Artifact URI.
• creation_timestamp_ms: integer(int64)
  Unix timestamp in milliseconds when the logged model was created.
• experiment_id: string
  Unique identifier for the experiment.
• last_updated_timestamp_ms: integer(int64)
  Unix timestamp in milliseconds when the logged model was last updated.
• model_id: string
  ID of logged model.
• model_type: string
  Model type of logged model.
• name: string
  Name of logged model.
• source_run_id: string
  Source run ID of logged model.
• status: string
  Status of logged model.
• tags: array tags
  Tags of logged model.

{
    "type":"object",
    "description":"Details of the logged model info.",
    "properties":{
        "model_id":{
            "description":"ID of logged model.",
            "type":"string"
        },
        "experiment_id":{
            "type":"string",
            "description":"Unique identifier for the experiment."
        },
        "name":{
            "description":"Name of logged model.",
            "type":"string"
        },
        "creation_timestamp_ms":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when the logged model was created."
        },
        "last_updated_timestamp_ms":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when the logged model was last updated."
        },
        "artifact_uri":{
            "description":"Artifact URI.",
            "type":"string"
        },
        "status":{
            "description":"Status of logged model.",
            "type":"string"
        },
        "model_type":{
            "description":"Model type of logged model.",
            "type":"string"
        },
        "source_run_id":{
            "description":"Source run ID of logged model.",
            "type":"string"
        },
        "tags":{
            "description":"Tags of logged model.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/LoggedModelTag"
            }
        }
    }
}

Nested Schema : tags

Type: array

Tags of logged model.

Show Source

• Array of: object LoggedModelTag
  Logged model tag.

{
    "description":"Tags of logged model.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/LoggedModelTag"
    }
}

Nested Schema : LoggedModelTag

Type: object

Logged model tag.

Show Source

• key(required): string
  Key of the tag.
• value(required): string
  Value of the tag.

{
    "type":"object",
    "description":"Logged model tag.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "description":"Key of the tag.",
            "type":"string"
        },
        "value":{
            "description":"Value of the tag.",
            "type":"string"
        }
    }
}

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