Download OpenAPI specification:Download
get all WAN replication configs for the given cluster
cluster required | string cluster name |
[- {
- "name": "string",
- "state": "REPLICATING",
- "members": 0,
- "totalQueuedEvents": 0,
- "maxQueueFillPercent": 100,
- "destinations": [
- {
- "name": "string",
- "state": "REPLICATING",
- "supportsSyncCheck": true,
- "members": [
- {
- "member": "string",
- "state": "REPLICATING",
- "connected": true,
- "eventsPerSecond": 0,
- "avgEventLatency": 0,
- "outboundQueueSize": 0,
- "outboundQueueFillPercent": 100
}
]
}
]
}
]
add new WAN replication
cluster required | string cluster name |
name required | string non-empty |
targetClusterName required | string non-empty |
publisherId required | string non-empty |
endpoints required | string non-empty |
queueCapacity | integer Default: 10000 |
batchSize | integer Default: 500 |
batchMaxDelay | integer Default: 1000 |
responseTimeout | integer Default: 60000 |
ackType | string (WanAcknowledgeType) Default: "ACK_ON_OPERATION_COMPLETE" Enum: "ACK_ON_RECEIPT" "ACK_ON_OPERATION_COMPLETE" |
queueFullBehaviour | string (WanQueueFullBehavior) Default: "DISCARD_AFTER_MUTATION" Enum: "DISCARD_AFTER_MUTATION" "THROW_EXCEPTION" "THROW_EXCEPTION_ONLY_IF_REPLICATION_ACTIVE" |
{- "name": "string",
- "targetClusterName": "string",
- "publisherId": "string",
- "endpoints": "string",
- "queueCapacity": 10000,
- "batchSize": 500,
- "batchMaxDelay": 1000,
- "responseTimeout": 60000,
- "ackType": "ACK_ON_RECEIPT",
- "queueFullBehaviour": "DISCARD_AFTER_MUTATION"
}
{- "addedPublisherIds": [
- "string"
], - "ignoredPublisherIds": [
- "string"
]
}
get WAN replication config for the given cluster and replication name
cluster required | string cluster name |
replication required | string WAN replication name |
{- "name": "string",
- "state": "REPLICATING",
- "members": 0,
- "totalQueuedEvents": 0,
- "maxQueueFillPercent": 100,
- "destinations": [
- {
- "name": "string",
- "state": "REPLICATING",
- "supportsSyncCheck": true,
- "members": [
- {
- "member": "string",
- "state": "REPLICATING",
- "connected": true,
- "eventsPerSecond": 0,
- "avgEventLatency": 0,
- "outboundQueueSize": 0,
- "outboundQueueFillPercent": 100
}
]
}
]
}
get WAN publisher configuration
cluster required | string cluster name |
replication required | string WAN replication name |
publisher required | string WAN publisher name |
{- "name": "string",
- "state": "REPLICATING",
- "supportsSyncCheck": true,
- "members": [
- {
- "member": "string",
- "state": "REPLICATING",
- "connected": true,
- "eventsPerSecond": 0,
- "avgEventLatency": 0,
- "outboundQueueSize": 0,
- "outboundQueueFillPercent": 100
}
]
}
check consistency of the given map
cluster required | string cluster name |
replication | string |
publisher | string |
map | string |
{- "replication": "string",
- "publisher": "string",
- "map": "string"
}
{- "id": "string"
}
change state of the given publisher
cluster required | string cluster name |
replication required | string WAN replication name |
publisher required | string WAN publisher name |
state | string (WanPublisherState) Enum: "REPLICATING" "PAUSED" "STOPPED" |
{- "state": "REPLICATING"
}
change state of the given publisher
cluster required | string cluster name |
replication required | string WAN replication name |
publisher required | string WAN publisher name |
member required | string member |
state | string (WanPublisherState) Enum: "REPLICATING" "PAUSED" "STOPPED" |
{- "state": "REPLICATING"
}
sync the given map
cluster required | string cluster name |
replication | string |
publisher | string |
map | string |
{- "replication": "string",
- "publisher": "string",
- "map": "string"
}
{- "id": "string"
}
get WAN Sync events for cluster
cluster required | string cluster name |
[- {
- "timestamp": 0,
- "uuid": "string",
- "endpoint": "string",
- "target": "string",
- "map": "string",
- "type": "SYNC",
- "status": {
- "status": "DONE",
- "progress": 100,
- "partitionsToSync": 0,
- "partitionsSynced": 0
}, - "summary": "string"
}
]
get WAN Sync events for cluster
cluster required | string cluster name |
syncId required | string sync id |
{- "timestamp": 0,
- "uuid": "string",
- "endpoint": "string",
- "target": "string",
- "map": "string",
- "type": "SYNC",
- "status": {
- "status": "DONE",
- "progress": 100,
- "partitionsToSync": 0,
- "partitionsSynced": 0
}, - "summary": "string"
}