List topics

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

Returns the identifiers of the topics in the schema.

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

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

schema stringrequired

The name of the schema

Responses

200

The identifiers of the topics in the schema.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

identifiers

object[]

The identifiers of the topics. Each namespace holds the metalake, catalog and schema names.

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

TopicListResponse

{
  "code": 0,
  "identifiers": [
    {
      "namespace": [
        "my_metalake",
        "kafka_catalog",
        "my_schema"
      ],
      "name": "my_topic1"
    },
    {
      "namespace": [
        "my_metalake",
        "kafka_catalog",
        "my_schema"
      ],
      "name": "my_topic2"
    }
  ]
}

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