Management Center - WAN Replication API (1.0)

Download OpenAPI specification:Download

get all WAN replication configs for the given clus

get all WAN replication configs for the given cluster

path Parameters

cluster

required

string

cluster name

Responses

Response samples

200

Content type

application/json

[{"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

path Parameters

cluster

required

string

cluster name

Request Body schema: application/json
required

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"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"targetClusterName": "string",
"publisherId": "string",
"endpoints": "string",
"queueCapacity": 10000,
"batchSize": 500,
"batchMaxDelay": 1000,
"responseTimeout": 60000,
"ackType": "ACK_ON_RECEIPT",
"queueFullBehaviour": "DISCARD_AFTER_MUTATION"
}

Response samples

200

Content type

application/json

{"addedPublisherIds": ["string"
],
"ignoredPublisherIds": ["string"
]
}

get WAN replication config for the given cluster a

get WAN replication config for the given cluster and replication name

path Parameters

cluster required	string cluster name
replication required	string WAN replication name

Responses

Response samples

200

Content type

application/json

{"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

path Parameters

cluster required	string cluster name
replication required	string WAN replication name
publisher required	string WAN publisher name

Responses

Response samples

200

Content type

application/json

{"name": "string",
"state": "REPLICATING",
"supportsSyncCheck": true,
"members": [{"member": "string",
"state": "REPLICATING",
"connected": true,
"eventsPerSecond": 0,
"avgEventLatency": 0,
"outboundQueueSize": 0,
"outboundQueueFillPercent": 100
}
]
}

get IMaps with the given WAN replication

path Parameters

cluster required	string cluster name
replication required	string WAN replication name

Responses

Response samples

200

Content type

application/json

[{"name": "string"
}
]

check consistency of the given map

path Parameters

cluster

required

string

cluster name

Request Body schema: application/json
required

replication	string
publisher	string
map	string

Responses

Request samples

Payload

Content type

application/json

{"replication": "string",
"publisher": "string",
"map": "string"
}

Response samples

200

Content type

application/json

{"id": "string"
}

clear replication queues on all members

path Parameters

cluster required	string cluster name
replication required	string WAN replication name
publisher required	string WAN publisher name

Responses

clear replication queues on the given member

path Parameters

cluster required	string cluster name
replication required	string WAN replication name
publisher required	string WAN publisher name
member required	string member

Responses

change state of the given publisher

path Parameters

cluster required	string cluster name
replication required	string WAN replication name
publisher required	string WAN publisher name

Request Body schema: application/json
required

state

string (WanPublisherState)

Enum: "REPLICATING" "PAUSED" "STOPPED"

Responses

Request samples

Payload

Content type

application/json

{"state": "REPLICATING"
}

change state of the given publisher

path Parameters

cluster required	string cluster name
replication required	string WAN replication name
publisher required	string WAN publisher name
member required	string member

Request Body schema: application/json
required

state

string (WanPublisherState)

Enum: "REPLICATING" "PAUSED" "STOPPED"

Responses

Request samples

Payload

Content type

application/json

{"state": "REPLICATING"
}

sync the given map

path Parameters

cluster

required

string

cluster name

Request Body schema: application/json
required

replication	string
publisher	string
map	string

Responses

Request samples

Payload

Content type

application/json

{"replication": "string",
"publisher": "string",
"map": "string"
}

Response samples

200

Content type

application/json

{"id": "string"
}

get WAN Sync events for cluster

path Parameters

cluster

required

string

cluster name

Responses

Response samples

200

Content type

application/json

[{"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

path Parameters

cluster required	string cluster name
syncId required	string sync id

Responses

Response samples

200

Content type

application/json

{"timestamp": 0,
"uuid": "string",
"endpoint": "string",
"target": "string",
"map": "string",
"type": "SYNC",
"status": {"status": "DONE",
"progress": 100,
"partitionsToSync": 0,
"partitionsSynced": 0
},
"summary": "string"
}

Management Center - WAN Replication API (1.0)

get all WAN replication configs for the given clus

path Parameters

Responses

Response samples

add new WAN replication

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

get WAN replication config for the given cluster a

path Parameters

Responses

Response samples

get WAN publisher configuration

path Parameters

Responses

Response samples

get IMaps with the given WAN replication

path Parameters

Responses

Response samples

check consistency of the given map

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

clear replication queues on all members

path Parameters

Responses

clear replication queues on the given member

path Parameters

Responses

change state of the given publisher

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

change state of the given publisher

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

sync the given map

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

get WAN Sync events for cluster

path Parameters

Responses

Response samples

get WAN Sync events for cluster

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required