Get topic

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

Return the specified topic 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

topic stringrequired

The name of the topic

Responses

200

Returns include the topic object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

topic

object

name stringrequired

The name of the topic

comment string

The comment of the topic

properties

object

nullable

The properties of the topic

property name* string

Example (from schema)

{
  "code": 0,
  "topic": {
    "name": "string",
    "comment": "string",
    "properties": {}
  }
}

TopicResponse

{
  "code": 0,
  "topic": {
    "name": "topic1",
    "comment": "This is a topic",
    "properties": {
      "partition-count": "1",
      "replication-factor": "1"
    }
  }
}

404

Not Found - The target topic 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",
    "..."
  ]
}

NoSuchTopicException

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

• 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

schema — pathrequired

topic — pathrequired

ResponseClear

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