Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisReplPlanMonitorGetExceptions

int ctMemphisReplPlanMonitorGetExceptions( pRCESJson request, ppRCESJson result )

Description:

Retrieve the exceptions for the Replication Plan for a given period of time. It will return the exception from both directions sorted by time.

HTTP URL: <baseURL>/ctMemphisReplPlanMonitorGetExceptions/

HTTP Verb: POST

Constraints:

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

Parameters:

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

{

"id": 1, // optional, if not passed or -1, retrieve

the exceptions for all the Replication Plans

"beginTime": "2015-11-05T10:00:00", // optional, if passed and it is more

recent than the last

ctMemphisReplPlanMonitorStart() used,

otherwise uses the last monitoring

start

"endTime": "2015-11-05T11:00:00", // optional, if it is not passed, uses the

current time

"paging": true, // optional, see Note 1 - Paging Parameters

"limit": 100, // optional, see Note 1 - Paging Parameters

"start": 200, // optional, see Note 1 - Paging Parameters

"dump": false // optional, default is false. If true, the

paging parameters are ignored and the

server side file name is returned instead

of the list of exceptions

}

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

{

"replPlanMonitorExceptionList": [

{

"replPlanID: 1,

"direction": "direct",

"sequenceNumber": 1002,

"exceptionTime": "2015-11-05T10:00:02",

"transactionNumber": 100779249,

"logEntryTime": "2015-11-05T9:59:45",

"logNumber": 716,

"logPosition": 11399993,

"fileID": 1472154,

"operation": "add",

"errorCode": 2,

"fileName": "E:\test\database\EFW105_0001"

},

{

"replPlanID: 1,

"direction": "reverse",

"sequenceNumber": 1003,

"exceptionTime": "2015-11-05T10:00:02",

"transactionNumber": 100779251,

"logEntryTime": "2015-11-05T9:59:45",

"logNumber": 716,

"logPosition": 11400793,

"fileID": 1472154,

"operation": "add",

"errorCode": 2,

"fileName": "E:\test\database\EFW105_0001"

},

{

"replPlanID: 1,

"direction": "direct",

"sequenceNumber": 1004,

"exceptionTime": "2015-11-05T10:02:05",

"transactionNumber": 0,

"logEntryTime": "2015-11-05T10:02:04",

"logNumber": 731,

"logPosition": 6991236,

"fileID": 0,

"operation": "beg",

"errorCode": 0

},

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 3 // total number of Replication Plan Exception entries for

the query - see Note 1 - Paging Parameters

}

Example 2:

  • request [IN]:

{

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

retrieve the exceptions for

all the Replication Plans

"beginTime": "2015-11-05T10:00:00", // optional, if passed and it is

more recent than the last

ctMemphisReplPlanMonitorStart(),

used, otherwise uses the last

monitoring start

"endTime": "2015-11-05T11:00:00", // optional, if it is not passed,

uses the current time

"dump": true // optional, default is false.

If true, the paging parameters

are ignored and the server side

file name is returned instead

of the list of exceptions

}

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

{

"exceptionDumpFileName": "dump\ReplPlan1_20151105.json", // dump file name

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex