PIpingcap
switchover

master/slave switchover

master/slave switchover

post/clusters/switchover

Request

  • Base URL
    https://localhost:4100/api/v1
  • URL
    https://localhost:4100/api/v1/clusters/switchover
  • Auth
    API key in header Authorization

Request body

checkMasterWritableFlagboolean
checkSlaveReadOnlyFlagboolean
checkStandaloneClusterFlagboolean

check if cluster specified in SourceClusterID is standalone, i.e. no cluster relation and no cdc if this flag is true, always only check

forceboolean
onlyCheckboolean

only check if this flag is true

rollbackClearPreviousMaintenanceFlagboolean

clear previous un-cleared "Switching" maintenance state

rollbackWorkFlowIDstring

if this field is not empty, that means this is a rollback request

sourceClusterIDstring required

old master/new slave

targetClusterIDstring required

new master/old slave

Response

OK

codeinteger
messagestring

Changes

No recorded changes to this operation across all 50 revisions of this API.