Create topic
POST/metalakes/:metalake/catalogs/:catalog/schemas/:schema/topics
Creates a topic in the schema and returns it. The topic is also created in the Kafka cluster behind the catalog.
Sign in with a bearer token or a local user's password; see Authentication.
Request
Path Parameters
The name of the metalake
The name of the catalog
The name of the schema
- application/json
Body
The name of the topic
The comment of the topic
properties
object
nullable
The properties of the topic
Responses
- 200
- 400
- 403
- 406
- 409
- 501
- 5xx
The topic, with its comment, properties and audit information.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- TopicResponse
Schema
Possible values: [0]
Status code of the response
topic
object
The name of the topic
The comment of the topic
properties
object
nullable
The properties of the topic
audit
object
Audit information for a Gravitino resource.
The user who created the resource
The time the resource was created
The user who last modified the resource
The time the resource was last modified
{
"code": 0,
"topic": {
"name": "string",
"comment": "string",
"properties": {},
"audit": {
"creator": "string",
"createTime": "2024-07-29T15:51:28.071Z",
"lastModifier": "string",
"lastModifiedTime": "2024-07-29T15:51:28.071Z"
}
}
}
{
"code": 0,
"topic": {
"name": "topic1",
"comment": "This is a topic",
"properties": {
"partition-count": "1",
"replication-factor": "1"
}
}
}
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
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1003,
"type": "BadRequestException",
"message": "Malformed request"
}
The caller is not allowed to perform the operation. With authorization on, a metalake that does not exist, or that the caller is not a member of, also returns 403.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1008,
"type": "ForbiddenException",
"message": "Current user alice is not a member of metalake metalake1, or the metalake does not exist"
}
The requested API version is not supported, or the operation cannot answer in the type the Accept header asks for. When Accept names no Gravitino API version, as with application/json, */*, or no header, the server takes the version from Content-Type if present, and the default version otherwise.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1001,
"type": "IllegalArgumentException",
"message": "Unsupported version v99 in request header"
}
A topic with the same name already exists in the schema.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- TopicAlreadyExistsErrorResponse
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1004,
"type": "TopicAlreadyExistsException",
"message": "Topic already exists",
"stack": [
"org.apache.gravitino.exceptions.TopicAlreadyExistsException: Topic already exists: topic1"
]
}
The catalog does not support topics, or does not support the requested topic operation.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1006,
"type": "UnsupportedOperationException",
"message": "Catalog does not support topic operations"
}
The server hit an internal error that the client usually cannot fix by changing the request.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1002,
"type": "RuntimeException",
"message": "Internal Server Error",
"stack": [
"java.lang.RuntimeException: Internal Server Error"
]
}