Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetDBEnginesByGroup

int ctMemphisGetDBEnginesByGroup( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the DBEngines from all the groups from the Replication Manager Database, separated by DBEngine Group.

HTTP URL: <baseURL>/ctMemphisGetDBEnginesByGroup/

HTTP Verb: POST

Note:

  • "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] - Get DBEngines By Groups request in JSON format. For example:

{

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

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

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

}

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

{

"dbEngineByGroupList": [

{

"id": 1,

"name": "dbEngineGroup1",

"description": "DBEngine group for ABC purposes",

"dbEngineList": [

{

"id": 1,

"logicalName": "FAIRCOMS1@hostname",

"opSystem": 0,

"workingVolume": 0,

"workingDir": "FairCom",

"name": "FAIRCOMS1",

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

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

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

"lastCheckTime": "2015-11-17T11:35:00",

"description": "Faircoms 1 DBEngine description",

"authContent": "Ï/9ÈÓ8\ÛÞ15Ԑ,=ÉÉ+8ºÛ81ÓÔv",

"isSQL": 1,

"portNbr": 5587,

"sqlPortNbr": 6587,

"localVolume": 0,

"localDir": "FairCom\data",

"users": 150,

"releaseVersion": "10.5.0.23948(Build-140411)",

"serial": "39000010",

"licenseOEM": 1,

"licenseType": "2",

"licenseCPUNbr": 0,

"licenseServerType": "ALL (Standard - SQL)",

"licenseUserNbr": 150,

"isAgent": 1,

"acceptConn": 1,

"readOnly": 0,

"isMemphis": 0,

"ipAddress": 192.168.1.32,

"configFilePath": "C:/temp/ctsrvr_temp.cfg",

"ipList": [

{

"ip": "10.0.0.1",

"type": "ipV4"

},

{

"ip": "0000:0000:0000:0000:0000:0000:0000:0001",

"type": "ipV6"

}

]

},

{

"id": 2,

"logicalName": "FAIRCOMS2@hostname2",

"opSystem": 0,

"workingVolume": 0,

"workingDir": "FairCom2",

"name": "FAIRCOMS2",

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

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

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

"lastCheckTime": "2015-11-17T11:35:00",

"description": "Faircoms 2 DBEngine description",

"authContent": "Ï/9ÈÓ8\ÛÞ15Ԑ,=ÉÉ+8ºÛ81ÓÔv",

"isSQL": 1,

"portNbr": 5587,

"sqlPortNbr": 6587,

"localVolume": 0,

"localDir": "FairCom2\data",

"users": 150,

"releaseVersion": "10.5.0.23948(Build-140411)",

"serial": "39000010",

"licenseOEM": 1,

"licenseType": "2",

"licenseCPUNbr": 0,

"licenseServerType": "ALL (Standard - SQL)",

"licenseUserNbr": 150,

"isAgent": 0,

"acceptConn": 1,

"readOnly": false, // can be true, false, or never.

"never" means status can't be changed

"isMemphis": 0,

"ipAddress": 192.168.1.32,

"ipList": [

{

"ip": "10.0.0.1",

"type": "ipV4"

},

{

"ip": "0000:0000:0000:0000:0000:0000:0000:0001",

"type": "ipV6"

}

]

}

]

},

{

"id": 2,

"name": "dbEngineGroup2",

"description": "File group for XYZ purposes",

"dbEngineList": [

]

}

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 2 // total number of dbEngines for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex