Tableflow Topics (tableflow/v1)
Read a Tableflow Topic
Make a request to read a tableflow topic.
get/tableflow/v1/tableflow-topics/{display_name}
Path parameters
display_namestring required
The name of the Kafka topic for which Tableflow is enabled.
Query parameters
environmentstring required
Filter a collection by a string search
Scope the operation to the given environment.
spec.kafka_clusterstring required
Filter a collection by a string search
Scope the operation to the given spec.kafka_cluster.
Response
Tableflow Topic.
Example response
{
"metadata": {
"self": "https://api.confluent.cloud/tableflow/v1/tableflow-topics/tt-12345",
"resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/tableflow-topic=tt-12345",
"created_at": "2006-01-02T15:04:05-07:00",
"updated_at": "2006-01-02T15:04:05-07:00",
"deleted_at": "2006-01-02T15:04:05-07:00"
},
"spec": {
"display_name": "topic_1",
"config": {
"enable_compaction": true,
"enable_partitioning": true,
"retention_ms": "7776000000",
"data_retention_ms": "2592000000"
},
"storage": {
"bucket_name": "bucket_1",
"bucket_region": "us-east-1",
"provider_integration_id": "cspi-stgce89r7",
"table_path": "s3://dummy-bucket-name-1/10011010/11101100/org-1/env-2/lkc-3/v1/tableId"
},
"table_formats": [
"DELTA"
],
"environment": {
"id": "env-00000",
"related": "https://api.confluent.cloud/org/v2/environments/env-00000",
"resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
},
"kafka_cluster": {
"id": "lkc-00000",
"related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-00000",
"resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000"
}
},
"status": {
"phase": "PENDING",
"error_message": "Could not enable catalog integration",
"catalog_sync_statuses": [
{
"catalog_integration_id": "tci-12345",
"catalog_type": "AWS_GLUE",
"sync_status": "SYNCED",
"error_message": "Failed to connect to catalog: authentication error"
}
],
"failing_table_formats": [
{
"format": "ICEBERG",
"error_message": "Schema validation failed"
},
{
"format": "DELTA",
"error_message": "Connection timeout"
}
],
"write_mode": "APPEND"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.