Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisReplPlanMonitorStart

int ctMemphisReplPlanMonitorStart( pRCESJson request, ppRCESJson result )

Description:

Start monitoring a Replication Plan. It starts loading into the Replication Manager Database some statistics snapshots by a frequency defined by "refreshRate" starting at the current time. If the Replication Plan is bi-directional, it will start monitoring both directions. If the Replication Plan monitor is already running, returns an error. This status is stored in the Replication Plan's table.

HTTP URL: <baseURL>/ctMemphisReplPlanMonitorStart/

HTTP Verb: POST

Constraints:

  • "id" must be an existing Replication Plan ID.

Parameters:

  • request [IN] - Replication Plan Monitor Start request in JSON format. For example:

{

"id": 1, // required

"refreshRate": 5 // optional - refresh rate in seconds - default is 5 seconds

}

  • result [OUT] - Result in JSON format. For example:

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex