List model versions

GET 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/models/:model/versions

Returns the version numbers of a model, or the full model versions when details is true.

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

Query Parameters

details boolean

Whether to return full model versions instead of version numbers

Responses

200

The version numbers of the model, or the full model versions with their URIs, aliases, comment, properties and audit information when details is true.

application/vnd.gravitino.v1+json

Schema

Schema

oneOf

ModelVersionListResponse

code int32

Possible values: [0]

Status code of the response

versions int32[]

The list of model versions

ModelVersionInfoListResponse

code int32

Possible values: [0]

Status code of the response

infos

object[]

The list of model version objects

Array [

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)

{}

ModelVersionListResponse

{
  "code": 0,
  "versions": [
    0,
    1,
    2
  ]
}

ModelVersionInfoListResponse

{
  "code": 0,
  "infos": [
    {
      "uri": "hdfs://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 metalake, catalog, schema or model does not exist.

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

NoSuchModelException

{
  "code": 1003,
  "type": "NoSuchModelException",
  "message": "Model does not exist",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchModelException: Model 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...