FairCom Replication JSON RPC API

ctMemphisCheckAction

int ctMemphisCheckAction( pRCESJson request, ppRCESJson result )

Description:

Check the status of a given action. It can be still pending and return a percentage of completion. It can be already finished or failed, in this last case, the error code and message will be returned. The "checkGroup" input parameter identifies if all the children actions should be checked in order to update progress information. For example, a deploy action generates several "sync" actions to update it all the "sync" actions must be checked.

HTTP URL: <baseURL>/ctMemphisCheckAction/

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

{

"actionID": 44135,

"checkGroup": true

}

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

{

"action": {

"actionID": 44135,

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

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

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

},

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

or

{

"action": {

"actionID": 44135,

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

"progress": 85,

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

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

},

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

or

{

"action": {

"actionID": 44135,

"status": "error", // see "status" note above

"statusMessage": "Error description",

"statusCode": 17,

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

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

},

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code