Get model

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

Returns the specified model object

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

Responses

200

The response of model object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

model

object

name stringrequired

The name of the model

latestVersion integerrequired

The latest version of the model

comment stringnullable

The comment of the fileset

properties

object

nullable

The properties of the fileset

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,
  "model": {
    "name": "string",
    "latestVersion": 0,
    "comment": "string",
    "properties": {},
    "audit": {
      "creator": "string",
      "createTime": "2025-01-24T07:48:51.129Z",
      "lastModifier": "string",
      "lastModifiedTime": "2025-01-24T07:48:51.129Z"
    }
  }
}

ModelResponse

{
  "code": 0,
  "model": {
    "name": "model1",
    "latestVersion": 0,
    "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

Not Found - The target fileset 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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

NoSuchCatalogException

{
  "code": 1003,
  "type": "NoSuchCatalogException",
  "message": "Failed to operate catalog(s) [test] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchCatalogException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchCatalogException: Catalog my_test_metalake.test does not exist",
    "..."
  ]
}

NoSuchSchemaException

{
  "code": 1003,
  "type": "NoSuchSchemaException",
  "message": "Failed to operate schema(s) [my_hive_schema1] operation [LOAD] under catalog [my_hive_catalog], reason [NoSuchSchemaException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchSchemaException: Hive schema (database) does not exist: my_hive_schema1 in Hive Metastore",
    "..."
  ]
}

NoSuchModelException

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

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

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

Loading...