List schemas

GET 
http://localhost:8090/api/metalakes/:metalake/catalogs/:catalog/schemas

List schemas

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

Responses

200

A list of entities

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

identifiers

object[]

A list of NameIdentifier objects

Array [

namespace string[]required

The namespace of the entity may be with multiple levels

name stringrequired

The name of the entity

]

Example (from schema)

{
  "code": 0,
  "identifiers": [
    {
      "namespace": [
        "string"
      ],
      "name": "string"
    }
  ]
}

CatalogListResponse

{
  "code": 0,
  "identifiers": [
    {
      "namespace": [
        "my_metalake"
      ],
      "name": "my_hive_catalog"
    }
  ]
}

SchemaListResponse

{
  "code": 0,
  "identifiers": [
    {
      "namespace": [
        "my_metalake",
        "my_hive_catalog"
      ],
      "name": "my_hive_schema"
    }
  ]
}

TableListResponse

{
  "code": 0,
  "identifiers": [
    {
      "namespace": [
        "my_metalake",
        "my_hive_catalog",
        "my_hive_schema"
      ],
      "name": "my_hive_table"
    }
  ]
}

400

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

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

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

Request Collapse all

Base URL

http://localhost:8090/api

Auth

Security Scheme

OAuth2WithJWTBasicAuth

Bearer Token

Parameters

metalake — pathrequired

catalog — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!