PingCAP Changefeed API is one of 32 APIs that PingCAP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Changefeed. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
9 operations
across 7 paths,
and defines 48 schemas.
It is described by OpenAPI 3.2.0, at version v1beta1.
Requests are made against a single base URL, https://dedicated.tidbapi.com/v1beta1.
The identity and technical contract details declared by the specification.
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v1beta1AzureBlobDownstreamConfigEndpoint
object
Endpoint defines the Azure Blob connection endpoint configuration.
2 properties
2 required
TopicPartitionConfigPartitionDispatcherConfig
object
The custom partition dispatcher configuration.
4 properties
1 required
v1beta1ListChangefeedRCUsResponse
object
The response for listing changefeed RCU options.
1 property
v1beta1EventFilter
object
The event filter configuration for fine-grained control.
7 properties
rpcStatus
object
3 properties
v1beta1S3DownstreamConfig
object
The S3 downstream configuration.
3 properties
2 required
v1beta1DownstreamType
string
The downstream type for a changefeed. - KAFKA: Apache Kafka. - MYSQL: MySQL-compatible database. - S3: Amazon S3 or S3-compatible storage. - GCS: Google Cloud…
v1beta1GcsDownstreamConfigEndpoint
object
The GCS endpoint configuration.
1 property
1 required
v1beta1S3DownstreamConfigEndpoint
object
The S3 endpoint configuration.
5 properties
2 required
v1beta1S3DataFormatProtocol
string
Protocol defines the supported output protocols for cloud storage sinks. - PROTOCOLCSV: CSV format. - PROTOCOLCANALJSON: Canal JSON format. - PROTOCOLPARQUET:…
v1beta1ChangefeedRCU
object
The changefeed RCU option.
4 properties
AvroConfigDecimalHandlingMode
string
The decimal serialization mode. - DECIMALHANDLINGMODEPRECISE: Use precise decimal representation. - DECIMALHANDLINGMODESTRING: Use string representation.
KafkaDownstreamConfigDataFormatProtocol
string
The Kafka output protocol. - PROTOCOLCANALJSON: Canal JSON format. Recommended for most use cases. - PROTOCOLOPENPROTOCOL: Open Protocol (TiDB native format).…
v1beta1TableConfigMode
string
The mode for handling unsupported tables. - IGNORENOTSUPPORTTABLE: Skip unsupported tables silently. - FORCESYNC: Force sync all tables (may fail on unsupporte…
v1beta1StartPositionMode
string
The start position mode. - FROMNOW: Start from the current time. - FROMTSO: Start from a specific TSO. - FROMUTC: Start from a specific UTC timestamp.
v1beta1ListChangefeedsResponse
object
The response for listing changefeeds.
3 properties
v1beta1S3DataFormat
object
The S3 data format configuration.
11 properties
1 required
v1beta1Connection
object
The MySQL connection configuration.
3 properties
1 required
TopicPartitionConfigDispatchType
string
The message dispatch type to topics. - DISPATCHTYPEONETOPIC: All messages go to a single topic. - DISPATCHTYPEBYTABLE: Each table gets its own topic. - DISPATC…
AuthenticationAuthType
string
The Kafka authentication type. - DISABLE: No authentication. - SASLPLAIN: SASL/PLAIN authentication. - SASLSCRAMSHA256: SASL/SCRAM-SHA-256 authentication. - SA…
S3DataFormatDateSeparator
string
The date separator for the directory structure. - NONE: No date separator. - YEAR: Separate by year. - MONTH: Separate by month. - DAY: Separate by day.
v1beta1TableConfig
object
The table filtering and event filter configuration.
4 properties
v1beta1GcsDownstreamConfig
object
The GCS downstream configuration.
3 properties
2 required
v1beta1MySQLDownstreamConfig
object
The MySQL downstream configuration.
1 property
1 required
v1beta1StorageFlushConfig
object
The storage flush configuration.
2 properties
v1beta1Changefeed
object
The changefeed configuration.
18 properties
6 required
v1beta1CreateChangefeedRequest
object
The request for creating a changefeed.
2 properties
1 required
KafkaDownstreamConfigCompressionType
string
The Kafka message compression type. - NONE: No compression. - GZIP: GZIP compression. - SNAPPY: Snappy compression. - LZ4: LZ4 compression. - ZSTD: ZSTD compre…
EndpointS3AuthType
string
The S3 authentication type. - S3AUTHTYPEAKSK: Access Key / Secret Key authentication. - S3AUTHTYPEASSUMEROLE: IAM Assume Role authentication.
KafkaDownstreamConfigKafkaVersion
string
The Kafka broker version. - KAFKAVERSION0XX: Kafka 0.x - KAFKAVERSION1XX: Kafka 1.x - KAFKAVERSION2XX: Kafka 2.x - KAFKAVERSION3XX: Kafka 3.x
v1beta1KafkaDownstreamConfig
object
The Kafka downstream configuration.
5 properties
4 required
v1beta1NetworkInfo
object
The network configuration for downstream connectivity.
3 properties
1 required
v1beta1AzureBlobDownstreamConfig
object
The Azure Blob downstream configuration.
3 properties
2 required
AvroConfigSchemaRegistry
object
The Schema Registry connection configuration.
4 properties
v1beta1StartPosition
object
The start position for the changefeed.
3 properties
1 required
NetworkInfoNetworkType
string
The network type for downstream connectivity. - NETWORKTYPEUNSPECIFIED: Default value. - NETWORKTYPEPUBLIC: Public internet access. - NETWORKTYPEVPCPEERING: AW…
AvroConfigBigintUnsignedHandlingMode
string
The handling mode for BIGINT UNSIGNED values. - BIGINTUNSIGNEDHANDLINGMODELONG: Use 64-bit integer (may overflow for very large values). - BIGINTUNSIGNEDHANDLI…
KafkaDownstreamConfigDataFormat
object
The Kafka message format and serialization configuration.
5 properties
1 required
KafkaDownstreamConfigTopicPartitionConfig
object
The Kafka topic and partition configuration.
8 properties
3 required
TopicPartitionConfigPartitionDispatcher
string
The partition dispatch strategy. - TABLE: Dispatch by table name. - INDEXVALUE: Dispatch by index value. - Timestamp: Dispatch by timestamp. - COLUMNS: Dispatc…
DataFormatDebeziumConfig
object
The Debezium-specific data format configuration.
2 properties
DataFormatAvroConfig
object
The Avro-specific data format configuration.
3 properties
ChangefeedState
string
The state of a changefeed. - STATEUNSPECIFIED: Default value. Should not be used. - RUNNING: The changefeed is actively replicating data. - FAILED: The changef…
KafkaDownstreamConfigAuthentication
object
The Kafka authentication configuration.
3 properties
1 required
KafkaDownstreamConfigColumnSelector
object
The column filtering configuration for specific tables.
2 properties
KafkaDownstreamConfigBroker
object
The Kafka broker connection configuration.
5 properties
1 required
S3DataFormatBinaryEncodingMethod
string
The binary encoding method. - BASE64: Base64 encoding. - HEX: Hexadecimal encoding.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs PingCAP publishes across the network.
