Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisSetTrace

int ctMemphisSetTrace( pRCESJson setTraceRequest, ppRCESJson retError )

Description:

Turn ON/OFF trace in the Replication Manager Database. We have two types of trace information that are enabled/disabled by this call: Replication Studio Agent and Replication Studio Web API. We can enable/disable it by one or more specific agent or to all of them.

HTTP URL: <baseURL>/ctMemphisSetTrace/

HTTP Verb: POST

Parameters:

  • connRequest [IN] - Set trace request parameter list in JSON format:

{

"webEnable": true, // optional, default is false, it turns ON/OFF the

tracing for the Web API calls

"enable": true, // optional, if passed, update the trace status for

all the agents. If the agent is not active, it will

check this information to start with the correct

tracing setup.

"traceList": [ // optional, if passed, we expect to receive a list

with dbEngine ID and the tracing status. If the

global "enable" property is provided, this list

is ignored

{

"dbEngine": 0,

"enable": true

},

{

"dbEngine": 1,

"enable": true

},

{

"dbEngine": 2,

"enable": false

}

}

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

{

"success": true,

"error":

{

"errorCode": 0,

"message": "success"

}

}

Return:

Error code

TOCIndex