Overview | Service | Command |
Report on replication status
Network edition only API | TRUE |
Authorization token required | true |
Admin Authorization token required | true |
<ReplicationStatusRequest /> ## ReplicationStatusRequest
<ReplicationStatusResponse replicationEnabled="{replication-enabled-flag} (0|1)"
[currentRole="{current-role-master|slave}"] [originalRole="{original-role-master|slave}"]> ## ReplicationStatusResponse
<masterStatus masterOperatingMode="{master-operating-mode-invalid|normal|slaveless|catchup}"> ## ReplicationMasterStatus
<catchupStatus remainingFiles="{num-remaining-files} (int)" remainingBytes="{num-remaining-bytes} (long)" /> ## ReplicationMasterCatchupStatus
</masterStatus>
<slaveStatus> ## ReplicationSlaveStatus
<catchupStatus remainingOps="{num-pending-redo-operations} (int)"
remainingFiles="{num-remaining-files} (int)" remainingBytes="{num-remaining-bytes} (long)" /> ## ReplicationSlaveCatchupStatus
</slaveStatus>
</ReplicationStatusResponse>
The following table describes elements and attributes you can define within a
<ReplicationStatusResponse>
element:
XPath | Required / Optional | Description |
@replicationEnabled | Required (only 1) | Type:0|1 Flags whether replication is enabled |
@currentRole | Optional (0 or 1) | Type:String Current role - master|slave |
@originalRole | Optional (0 or 1) | Type:String Original role - master|slave |
/masterStatus | Optional (0 or 1) | Master replication status. Only one of masterStatus and slaveStatus can be present |
/masterStatus@masterOperatingMode | Required (only 1) | Type:String Master's operating mode - invalid|normal|slaveless|catchup |
/masterStatus/catchupStatus | Optional (0 or 1) | Catchup status |
/masterStatus/catchupStatus@remainingFiles | Required (only 1) | Type:int Number of remaining files |
/masterStatus/catchupStatus@remainingBytes | Required (only 1) | Type:long Number of remaining bytes |
/slaveStatus | Optional (0 or 1) | Slave replication status |
/slaveStatus/catchupStatus | Optional (0 or 1) | Catchup status |
/slaveStatus/catchupStatus@remainingOps | Required (only 1) | Type:int Number of pending redo operations |
/slaveStatus/catchupStatus@remainingFiles | Required (only 1) | Type:int Number of remaining files |
/slaveStatus/catchupStatus@remainingBytes | Required (only 1) | Type:long Number of remaining bytes |