Jump to

• Request
• Response

(Preview) Get metadata for an experiment by name

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/get-by-name

(Preview) Returns experiment metadata for a given name. Returns deleted experiments, but prefers the active experiment if an active and deleted experiment share the same name. If multiple deleted experiments share the same name, the API will return one of them.

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

Query Parameters

• experiment_name(required): string
  The name of the experiment to retrieve.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Experiment metadata by experiment name is retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : ExperimentResponse

Type: object

Response object for getting an experiment.

Show Source

• experiment(required): object Experiment
  Details of an MLflow experiment.

{
    "description":"Response object for getting an experiment.",
    "type":"object",
    "required":[
        "experiment"
    ],
    "properties":{
        "experiment":{
            "$ref":"#/definitions/Experiment"
        }
    }
}

Nested Schema : Experiment

Type: object

Details of an MLflow experiment.

Show Source

• artifact_location: string
  Location where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default.
• creation_time: integer(int64)
  Unix timestamp in milliseconds when the experiment was created.
• experiment_id(required): string
  Unique identifier for the experiment.
• last_update_time: integer(int64)
  Unix timestamp in milliseconds when the experiment was last updated.
• lifecycle_stage: string
  Lifecycle stage of the experiment, e.g., 'active' or 'deleted'.
• name(required): string
  Name of the experiment.
• tags: array tags
  List of tags set on the experiment.

{
    "description":"Details of an MLflow experiment.",
    "type":"object",
    "required":[
        "experiment_id",
        "name"
    ],
    "properties":{
        "experiment_id":{
            "type":"string",
            "description":"Unique identifier for the experiment."
        },
        "name":{
            "type":"string",
            "description":"Name of the experiment."
        },
        "artifact_location":{
            "type":"string",
            "description":"Location where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default."
        },
        "lifecycle_stage":{
            "type":"string",
            "description":"Lifecycle stage of the experiment, e.g., 'active' or 'deleted'."
        },
        "creation_time":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when the experiment was created."
        },
        "last_update_time":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when the experiment was last updated."
        },
        "tags":{
            "type":"array",
            "description":"List of tags set on the experiment.",
            "items":{
                "$ref":"#/definitions/ExperimentTag"
            }
        }
    }
}

Nested Schema : tags

Type: array

List of tags set on the experiment.

Show Source

• Array of: object ExperimentTag
  A tag associated with an experiment.

{
    "type":"array",
    "description":"List of tags set on the experiment.",
    "items":{
        "$ref":"#/definitions/ExperimentTag"
    }
}

Nested Schema : ExperimentTag

Type: object

A tag associated with an experiment.

Show Source

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

{
    "description":"A tag associated with an experiment.",
    "type":"object",
    "required":[
        "key"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key of the experiment tag."
        },
        "value":{
            "type":"string",
            "description":"Value of the experiment tag."
        }
    }
}

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