Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisCheckReplPlanStatus

int ctMemphisCheckReplPlanStatus( pRCESJson request, ppRCESJson result )

Description:

Retrieve the current Replication Plan status. If "checkConnection" is set, make some validations in order to update its status and return its information. If "checkConnection" is set for all the Replication Plans, an action ID is returned and it is executed in the background.

HTTP URL: <baseURL>/ctMemphisCheckReplPlanStatus/

HTTP Verb: POST

Notes:

  • "Status" values can be: "inactive", "active", "stopping", "starting", "deploying" and "paused"
  • "StatusCd" values can be: 0 = "inactive", 1 = "active", 2 = "stopping", 3 = "starting", 4 = "deploying" and 5 = "paused"

Parameters:

  • request[IN] - Check Replication Plan Status request in JSON format. For example:

{

"id": 2, // optional, if it is not passed or if it is -1,

returns the status for all the Replication Plans

"checkConnection": true // optional, default is false, but if it is true, the

Replication Manager Database will try to execute some

agent validations to check if current status is OK

}

  • result[OUT] - Result in JSON format. For example, if "checkConnection" is FALSE or the ID is provided:

{

"replPlanStatusList": [

{

"id": 2,

"status": "active", // see "Status" note above

"statusCode": 1, // see "StatusCd" note above

"isDeployed": true,

"statusTime": "2015-11-05T10:00:001",

"statusMsg": "",

"statusActionID": 132,

"latency": 22, // how many seconds behind the

Replication Plan is at this

moment

"latencyTime": "Thu Aug 23 14:55:02 2001", // when latency was last checked

"latencyRev": 22, // how many seconds behind the

Replication Plan reverse

direction is at this moment

"latencyRevTime": "Thu Aug 23 14:55:02 2001", // when reverse direction

latency was last checked

"isMonitorActive": true,

"monitorTime": "Thu Aug 23 14:55:02 2001", // Time when the monitor

is active or not

"refreshRate": 5,

"isExcepLogActive": true,

"excepLogTime": "Thu Aug 23 14:55:02 2001", // Since when the exception

logging is active or not

"isFuncTimingActive": true,

"funcTimingTime": "Thu Aug 23 14:55:02 2001", // Since when the exception

logging is active or not

"hasNonAckException": true // Flag indicating the Plan

has at least one not

acknowledge exception

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

In case "checkConnection" is TRUE and you are checking all the Replication Plans, it is executed asynchronously, by returning the action ID to be checked (ctMemphisCheckAction) as a background execute:

{

"actionID":44135,

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex