Jump to

• Request
• Response

(Preview) Get registered model details

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/get

(Preview) Returns details for a specified registered model.

Request

Path Parameters

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

Query Parameters

• name(required): string
  Name of the registered model.

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. Registered model details are 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 : GetRegisteredModelResponseDetails

Type: object

Response object for getting a RegisteredModel

Show Source

• registered_model(required): object RegisteredModel
  Details of the registered model

{
    "description":"Response object for getting a RegisteredModel",
    "type":"object",
    "required":[
        "registered_model"
    ],
    "properties":{
        "registered_model":{
            "$ref":"#/definitions/RegisteredModel"
        }
    }
}

Nested Schema : RegisteredModel

Type: object

Details of the registered model

Show Source

• aliases: array aliases
  Aliases pointing to model versions associated with this registered_model.
• creation_timestamp: integer(int64)
  Timestamp in milliseconds when the model was created.
• deployment_job_id: string
  Deployment job ID.
• deployment_job_state: string
  Allowed Values: [ "DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED", "NOT_SET_UP", "CONNECTED", "NOT_FOUND", "REQUIRED_PARAMETERS_CHANGED" ]

  Job state.
• description: string
  Description of the registered model.
• last_updated_timestamp: integer(int64)
  Timestamp in milliseconds when metadata for the model was last updated.
• latest_versions: array latest_versions
  Collection of latest model versions for each stage. Only contains models with current READY status.
• name: string
  Unique name for the model.
• tags: array tags
  Tags for the registered model.

{
    "description":"Details of the registered model",
    "type":"object",
    "properties":{
        "name":{
            "description":"Unique name for the model.",
            "type":"string"
        },
        "creation_timestamp":{
            "description":"Timestamp in milliseconds when the model was created.",
            "type":"integer",
            "format":"int64"
        },
        "last_updated_timestamp":{
            "description":"Timestamp in milliseconds when metadata for the model was last updated.",
            "type":"integer",
            "format":"int64"
        },
        "description":{
            "description":"Description of the registered model.",
            "type":"string"
        },
        "latest_versions":{
            "description":"Collection of latest model versions for each stage. Only contains models with current READY status.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ModelVersion"
            }
        },
        "aliases":{
            "description":"Aliases pointing to model versions associated with this registered_model.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/RegisteredModelAlias"
            }
        },
        "deployment_job_id":{
            "description":"Deployment job ID.",
            "type":"string"
        },
        "deployment_job_state":{
            "description":"Job state.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentJobState",
            "enum":[
                "DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED",
                "NOT_SET_UP",
                "CONNECTED",
                "NOT_FOUND",
                "REQUIRED_PARAMETERS_CHANGED"
            ]
        },
        "tags":{
            "description":"Tags for the registered model.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/RegisteredModelTag"
            }
        }
    }
}

Nested Schema : aliases

Type: array

Aliases pointing to model versions associated with this registered_model.

Show Source

• Array of: object RegisteredModelAlias
  Alias of the registered model

{
    "description":"Aliases pointing to model versions associated with this registered_model.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/RegisteredModelAlias"
    }
}

Nested Schema : latest_versions

Type: array

Collection of latest model versions for each stage. Only contains models with current READY status.

Show Source

• Array of: object ModelVersion
  Details of the model version.

{
    "description":"Collection of latest model versions for each stage. Only contains models with current READY status.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ModelVersion"
    }
}

Nested Schema : tags

Type: array

Tags for the registered model.

Show Source

• Array of: object RegisteredModelTag
  Tag for the registered model.

{
    "description":"Tags for the registered model.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/RegisteredModelTag"
    }
}

Nested Schema : RegisteredModelAlias

Type: object

Alias of the registered model

Show Source

• alias: string
  The name of the alias.
• version: string
  The model version number that the alias points to.

{
    "description":"Alias of the registered model",
    "type":"object",
    "properties":{
        "alias":{
            "description":"The name of the alias.",
            "type":"string"
        },
        "version":{
            "description":"The model version number that the alias points to.",
            "type":"string"
        }
    }
}

Nested Schema : ModelVersion

Type: object

Details of the model version.

Show Source

• aliases: array aliases
  Aliases pointing to this version.
• creation_timestamp: integer(int64)
  Timestamp in milliseconds when the model version was created.
• current_stage: string
  Current stage for this model version.
• deployment_job_state: object ModelVersionDeploymentJobState
  ModelVersion tag.
• description: string
  Description of this model version.
• last_updated_timestamp: integer(int64)
  Timestamp in milliseconds when metadata for the model version was last updated.
• model_id: string
  Model ID for model version that is used to link the registered model to the source logged model.
• model_metrics: array model_metrics
  Metrics logged for the model.
• model_params: array model_params
  Parameters logged for the model.
• name: string
  Unique name for the model.
• run_id: string
  Run ID used when creating model version.
• run_link: string
  Direct link to the run that generated this version.
• source: string
  URI indicating the location of the source model artifacts, used when creating model version.
• status: string
  Allowed Values: [ "PENDING_REGISTRATION", "FAILED_REGISTRATION", "READY" ]

  Current status of model version.
• status_message: string
  Details on current status, if it is pending or failed.
• tags: array tags
  Tags of model version.
• user_id: string
  User that created this model version.
• version: string
  Model???s version number.

{
    "description":"Details of the model version.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Unique name for the model.",
            "type":"string"
        },
        "version":{
            "description":"Model???s version number.",
            "type":"string"
        },
        "creation_timestamp":{
            "description":"Timestamp in milliseconds when the model version was created.",
            "type":"integer",
            "format":"int64"
        },
        "last_updated_timestamp":{
            "description":"Timestamp in milliseconds when metadata for the model version was last updated.",
            "type":"integer",
            "format":"int64"
        },
        "user_id":{
            "description":"User that created this model version.",
            "type":"string"
        },
        "current_stage":{
            "description":"Current stage for this model version.",
            "type":"string"
        },
        "description":{
            "description":"Description of this model version.",
            "type":"string"
        },
        "source":{
            "description":"URI indicating the location of the source model artifacts, used when creating model version.",
            "type":"string"
        },
        "run_id":{
            "description":"Run ID used when creating model version.",
            "type":"string"
        },
        "status":{
            "description":"Current status of model version.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ModelVersionStatus",
            "enum":[
                "PENDING_REGISTRATION",
                "FAILED_REGISTRATION",
                "READY"
            ]
        },
        "status_message":{
            "description":"Details on current status, if it is pending or failed.",
            "type":"string"
        },
        "tags":{
            "type":"array",
            "description":"Tags of model version.",
            "items":{
                "$ref":"#/definitions/ModelVersionTag"
            }
        },
        "run_link":{
            "description":"Direct link to the run that generated this version.",
            "type":"string"
        },
        "aliases":{
            "description":"Aliases pointing to this version.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "model_id":{
            "description":"Model ID for model version that is used to link the registered model to the source logged model.",
            "type":"string"
        },
        "model_metrics":{
            "type":"array",
            "description":"Metrics logged for the model.",
            "items":{
                "$ref":"#/definitions/ModelMetric"
            }
        },
        "model_params":{
            "type":"array",
            "description":"Parameters logged for the model.",
            "items":{
                "$ref":"#/definitions/ModelParam"
            }
        },
        "deployment_job_state":{
            "$ref":"#/definitions/ModelVersionDeploymentJobState"
        }
    }
}

Nested Schema : aliases

Type: array

Aliases pointing to this version.

Show Source

• Array of: string

{
    "description":"Aliases pointing to this version.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ModelVersionDeploymentJobState

Type: object

ModelVersion tag.

Show Source

• current_task_name: string
  Current task name.
• job_id: string
  Job ID.
• job_state: string
  Allowed Values: [ "DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED", "NOT_SET_UP", "CONNECTED", "NOT_FOUND", "REQUIRED_PARAMETERS_CHANGED" ]

  Job state.
• run_id: string
  Run ID.
• run_state: string
  Allowed Values: [ "DEPLOYMENT_JOB_RUN_STATE_UNSPECIFIED", "NO_VALID_DEPLOYMENT_JOB_FOUND", "RUNNING", "SUCCEEDED", "FAILED", "PENDING", "APPROVAL" ]

  Run state.

{
    "type":"object",
    "description":"ModelVersion tag.",
    "properties":{
        "job_id":{
            "description":"Job ID.",
            "type":"string"
        },
        "run_id":{
            "description":"Run ID.",
            "type":"string"
        },
        "job_state":{
            "description":"Job state.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentJobState",
            "enum":[
                "DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED",
                "NOT_SET_UP",
                "CONNECTED",
                "NOT_FOUND",
                "REQUIRED_PARAMETERS_CHANGED"
            ]
        },
        "run_state":{
            "description":"Run state.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentJobRunState",
            "enum":[
                "DEPLOYMENT_JOB_RUN_STATE_UNSPECIFIED",
                "NO_VALID_DEPLOYMENT_JOB_FOUND",
                "RUNNING",
                "SUCCEEDED",
                "FAILED",
                "PENDING",
                "APPROVAL"
            ]
        },
        "current_task_name":{
            "description":"Current task name.",
            "type":"string"
        }
    }
}

Nested Schema : model_metrics

Type: array

Metrics logged for the model.

Show Source

• Array of: object ModelMetric
  Model metric.

{
    "type":"array",
    "description":"Metrics logged for the model.",
    "items":{
        "$ref":"#/definitions/ModelMetric"
    }
}

Nested Schema : model_params

Type: array

Parameters logged for the model.

Show Source

• Array of: object ModelParam
  Model param.

{
    "type":"array",
    "description":"Parameters logged for the model.",
    "items":{
        "$ref":"#/definitions/ModelParam"
    }
}

Nested Schema : tags

Type: array

Tags of model version.

Show Source

• Array of: object ModelVersionTag
  ModelVersion tag.

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

Nested Schema : ModelMetric

Type: object

Model metric.

Show Source

• key: string
  Name of the metric.
• step: integer(int64)
  Step at which to log the metric.
• timestamp: integer(int64)
  Unix timestamp in milliseconds when this metric was recorded.
• value: number(double)
  Value of the metric.

{
    "type":"object",
    "description":"Model metric.",
    "properties":{
        "key":{
            "description":"Name of the metric.",
            "type":"string"
        },
        "value":{
            "description":"Value of the metric.",
            "type":"number",
            "format":"double"
        },
        "timestamp":{
            "type":"integer",
            "format":"int64",
            "description":"Unix timestamp in milliseconds when this metric was recorded."
        },
        "step":{
            "type":"integer",
            "format":"int64",
            "description":"Step at which to log the metric."
        }
    }
}

Nested Schema : ModelParam

Type: object

Model param.

Show Source

• name: string
  Name of the parameter.
• value: string
  Value of the parameter.

{
    "type":"object",
    "description":"Model param.",
    "properties":{
        "name":{
            "description":"Name of the parameter.",
            "type":"string"
        },
        "value":{
            "description":"Value of the parameter.",
            "type":"string"
        }
    }
}

Nested Schema : ModelVersionTag

Type: object

ModelVersion tag.

Show Source

• key: string
  Key of the tag.
• value: string
  Value of the tag.

{
    "type":"object",
    "description":"ModelVersion tag.",
    "properties":{
        "key":{
            "description":"Key of the tag.",
            "type":"string"
        },
        "value":{
            "description":"Value of the tag.",
            "type":"string"
        }
    }
}

Nested Schema : RegisteredModelTag

Type: object

Tag for the registered model.

Show Source

• key: string
  Key of the registered model tag.
• value: string
  Value of the registered model tag.

{
    "type":"object",
    "description":"Tag for the registered model.",
    "properties":{
        "key":{
            "description":"Key of the registered model tag.",
            "type":"string"
        },
        "value":{
            "description":"Value of the registered model 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"
        }
    }
}

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