FairCom Replication JSON RPC API

ctMemphisCheckAgentStatus

int ctMemphisCheckAgentStatus( pRCESJson request, ppRCESJson result )

Description:

Check the agent connection by a basic heartbeat action in order to update its status and return its information.

HTTP URL: <baseURL>/ctMemphisCheckAgentStatus/

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 Agent request in JSON format. For example:

{

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

check for all the agents

}

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

{

"agentList": [

{

"id": 1,

"opSystem": 0,

"workingVolume": 0,

"workingDir": "FairCom",

"dbEngine": 0,

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

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

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

"actionExecs": [

{

"type": "BASIC", // Supported types: BASIC, FILE_SYSTEM,

REPLICATION, REPL_CTREE

"status": "active",

"threadCount": 1,

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

},

{

"type": "FILE_SYSTEM",

"status": "active",

"threadCount": 4,

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

},

{

"type": "REPLICATION",

"status": "active",

"threadCount": 4,

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

}

]

},

{

"id": 2,

"opSystem": 0,

"workingVolume": 0,

"workingDir": "FairCom2",

"dbEngine": 1,

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

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

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

"actionExecs": [

{

"type": "BASIC", // Supported types: BASIC, FILE_SYSTEM,

REPLICATION, REPL_CTREE

"status": "active",

"threadCount": 1,

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

},

{

"type": "FILE_SYSTEM",

"status": "active",

"threadCount": 4,

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

}

]

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code