List Tables

POST /api/v1/dl/list_tables

Returns all active Tableflow tables for a given virtual cluster.

Request

Field
Type
Required
Description

virtual_cluster_id

string

Yes

The ID of the Tableflow virtual cluster.

CURL Example

curl [https://api.warpstream.com/api/v1/dl/list_tables](https://api.warpstream.com/api/v1/dl/list_tables) \
  -H 'warpstream-api-key: XXXXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{"virtual_cluster_id": "vci_XXXXXXXX_XXXX_XXXX_XXXX_XXXXXXXXXXXX"}'

Response

{
  "tables": [
    {
      "table_name": "my_cluster.my_topic.a1b2c3d4",
      "table_uuid": "550e8400-e29b-41d4-a716-446655440000",
      "source_stream_name": "my_topic",
      "source_cluster_name": "my_cluster",
      "stats_estimated_byte_count": 1048576,
      "stats_estimated_row_count": 10000,
      "created_at_unix_nanos": 1700000000000000000
    }
  ]
}

Field

Type

Description

tables

array

List of table objects.

tables[].table_name

string

The full name of the table.

tables[].table_uuid

string

The unique identifier of the table.

tables[].source_stream_name

string

The source Kafka topic name.

tables[].source_cluster_name

string

The name of the source cluster.

tables[].stats_estimated_byte_count

integer

Estimated total size of the table in bytes.

tables[].stats_estimated_row_count

integer

Estimated total number of rows in the table.

tables[].created_at_unix_nanos

integer

Table creation timestamp in nanoseconds since Unix epoch.

Last updated

Was this helpful?