List metalakes

GET 
/metalakes

Returns the metalakes the caller can load, each with its comment, properties and audit information.

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

Responses

200

The metalakes the caller can load, each with its comment, properties and audit information.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

metalakes

object[]

A list of metalake objects

Array [

name stringrequired

The name of the Metalake

comment stringnullable

A comment about the Metalake

audit

object

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

properties

object

Configured string to string map of properties for the Metalake

property name* string

]

Example (from schema)

{
  "code": 0,
  "metalakes": [
    {
      "name": "my_metalake",
      "comment": "This is my metalake",
      "properties": {
        "key1": "value1",
        "key2": "value2",
        "in-use": "true"
      },
      "audit": {
        "creator": "gravitino",
        "createTime": "2023-12-07T14:04:17.349Z"
      }
    }
  ]
}

ListMetalakesResponse

{
  "code": 0,
  "metalakes": [
    {
      "name": "my_metalake",
      "comment": "This is my metalake",
      "properties": {
        "key1": "value1",
        "key2": "value2",
        "in-use": "true"
      },
      "audit": {
        "creator": "gravitino",
        "createTime": "2023-12-06T14:21:24.982Z"
      }
    }
  ]
}

400

The request is malformed or fails validation, for example because of invalid JSON, a missing required field or an invalid parameter value. The body is normally an error model, although the server's middleware can return plain text instead.

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": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

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...