Get model version by alias

GET 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/models/:model/aliases/:alias

Returns the model version that the alias points to, including its URIs, aliases, comment, properties and audit information.

Sign in with a bearer token or a local user's password; see Authentication.

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

schema stringrequired

The name of the schema

model stringrequired

The name of the model

alias stringrequired

An alias of the model version

Responses

200

The model version, with its version number, URIs, aliases, comment, properties and audit information.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

modelVersion

object

uri stringnullable

The uri of the model version

uris

object

nullable

The uris of the model version

property name* string

version integerrequired

The version of the model

aliases string[]nullable

The aliases of the model version

comment stringnullable

The comment of the model version

properties

object

nullable

The properties of the model version

property name* string

audit

object

required

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

Example (from schema)

{
  "code": 0,
  "modelVersion": {
    "uri": "string",
    "uris": {},
    "version": 0,
    "aliases": [
      "string"
    ],
    "comment": "string",
    "properties": {},
    "audit": {
      "creator": "string",
      "createTime": "2024-07-29T15:51:28.071Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-07-29T15:51:28.071Z"
    }
  }
}

ModelResponse

{
  "code": 0,
  "modelVersion": {
    "uris": {
      "hdfs": "hdfs://path/to/model",
      "s3": "s3://path/to/model"
    },
    "version": 0,
    "aliases": [
      "alias1",
      "alias2"
    ],
    "comment": "This is a comment",
    "properties": {
      "key1": "value1",
      "key2": "value2"
    },
    "audit": {
      "creator": "user1",
      "createTime": "2021-01-01T00:00:00Z",
      "lastModifier": "user1",
      "lastModifiedTime": "2021-01-01T00:00:00Z"
    }
  }
}

404

The model does not exist, or none of its versions has the given alias.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

NoSuchModelVersionException

{
  "code": 1003,
  "type": "NoSuchModelVersionException",
  "message": "Model version does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchModelVersionException: Model version does not exist"
  ]
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...