Sign in

v3

latestOpenAPI 3.0.12026-07-314655871.8 MB
Service:_Kafka_MirrorMaker

Update a replication flow

put/project/{project}/service/{service_name}/mirrormaker/replication-flows/{source_cluster}/{target_cluster}

Path parameters

projectstring required

Project name

service_namestring required

Service name

source_clusterstring required

Source cluster alias

target_clusterstring required

Target cluster alias

Request body

config_properties_excludestring

A comma separated list of topic configuration properties and/or regexes that should not be replicated. If omitted, MirrorMaker will use default list of exclusions. For stability reasons, we always include the unclean.leader.election.enable field in the excluded parameters. If you have specific requirements for this configuration, please reach out to our support team for assistance.

emit_backward_heartbeats_enabledboolean

Whether to emit heartbeats to the direction opposite to the flow, i.e. to the source cluster

emit_heartbeats_enabledboolean

Whether to emit heartbeats to the target cluster

enabledboolean

Is replication flow enabled

exactly_once_delivery_enabledboolean

Whether to enable exactly-once message delivery. We recommend you set this to enabled for new replications.

follower_fetching_enabledboolean

Assigns a Rack ID based on the availability-zone to enable follower fetching and rack awareness per replication flow.

offset_lag_maxinteger

How out-of-sync a remote partition can be before it is resynced (default: 100)

offset_syncs_topic_location'source' | 'target'

The location of the offset-syncs topic

replication_factorinteger

Replication factor used when creating the remote topics. If the replication factor surpasses the number of nodes in the target cluster, topic creation will fail.

replication_policy_class'org.apache.kafka.connect.mirror.DefaultReplicationPolicy' | 'org.apache.kafka.connect.mirror.IdentityReplicationPolicy'

Class which defines the remote topic naming convention

sync_group_offsets_enabledboolean

Whether to periodically write the translated offsets of replicated consumer groups (in the source cluster) to __consumer_offsets topic in target cluster, as long as no active consumers in that group are connected to the target cluster

sync_group_offsets_interval_secondsinteger

Frequency at which consumer group offsets are synced (default: 60, every minute)

topicsstring[]

Topic names and regular expressions that match topic names that should be replicated. MirrorMaker will replicate these topics if they are not matched by "topics.exclude". Currently defaults to [".*"].

topics.blackliststring[]

Topic names and regular expressions that match topic names that should not be replicated. MirrorMaker will not replicate these topics even if they are matched by "topics". If not set, MM2 uses the default exclusion.

topics.excludestring[]

Topic names and regular expressions that match topic names that should not be replicated. MirrorMaker will not replicate these topics even if they are matched by "topics". If not set, MM2 uses the default exclusion.

topics_excludestring[]

Topic names and regular expressions that match topic names that should not be replicated. MirrorMaker will not replicate these topics even if they are matched by "topics". If not set, MM2 uses the default exclusion.

Response

Response

messagestring

Printable result of the request