Create topic

POST 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/topics

Create topic

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

schema stringrequired

The name of the schema

application/json

Body

name stringrequired

The name of the topic

comment stringnullable

The comment of the topic

properties

object

nullable

The properties of the topic

property name* string

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

409

Conflict - The target topic already exists

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

TopicAlreadyExistsErrorResponse

{
  "code": 1004,
  "type": "TopicAlreadyExistsException",
  "message": "Topic already exists",
  "stack": [
    "org.apache.gravitino.exceptions.TopicAlreadyExistsException: Topic already exists: topic1"
  ]
}

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