|
|
|
int ctMemphisGetArchivedReplPlansDetails( pRCESJson request, ppRCESJson result )
Description:
Retrieve all the Archived Replication Plans from the Replication Manager Database with their details like subscriptions and publications.
Notes:
"normal": when subscriptions are going only from sourceDBEngine to targetDBEngine
"reverse": when subscriptions are going only from targetDBEngine to source DBEngine
"none": there is no subscription between sourceDBEngine and targetDBEngine
"both": there are subscriptions in both ways between sourceDBEngine and targetDBEngine. It can be a "bidirectional" subscription or distinct subscriptions in both ways
HTTP URL: <baseURL>/ctMemphisGetArchivedReplPlansDetails/
HTTP Verb: POST
Parameters:
{
"id": 1, // optional, if provided, search replication plan
by ID
"name": "PLAN1", // optional, if provided search replication plan
by name
"partial": true, // optional, if provided with "name", the search
by name will look for like "<name>%"
"paging": true, // optional, see Note 1 - Paging Parameters
"limit": 100, // optional, see Note 1 - Paging Parameters
"start": 200 // optional, see Note 1 - Paging Parameters
}
{
"replPlanDetailList": [
{
"id": 0,
"name": "PLAN1",
"description": "Plan 1 description",
"sourceDBEngine": 3,
"targetDBEngine": 0,
"synchronous": false,
"direction": "both", // see "Direction" for possible values
"subscriptionDetailList": [
{
"id": 1,
"name": "subscription1",
"description": "Subscription for ABC purposes",
"dbEngineDetail": {
"id": 3,
"logicalName": "FAIRCOMS1@hostname",
"opSystem": 0,
"workingVolume": 0,
"workingDir": "FairCom",
"name": "FAIRCOMS1",
"status": "active", // see "Status" for possible values
"statusCode": 1, // see "EngineStatus" for values
"statusTime": "2015-11-05T10:00:00",
"lastCheckTime": "2015-11-17T11:35:00",
"description": "Faircoms 1 DBEngine description",
"authContent": "I/98U15O\8UOv",
"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": false, // can be true, false or never.
"never" means status can't be changed
"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"
}
],
"databaseList": [
{
"id": 1,
"dbEngine": 1,
"name": "database1",
"dictFileName": "c:\server\databases\database1\SQL_SYS\database1.fdd",
"isSQL": true
},
{
"id": 2,
"dbEngine": 1,
"name": "database2",
"dictFileName": "c:\server\databases\database2\database2.fdd",
"isSQL": false
}
]
},
"redirectionList": [
{
"sourcePath": "C:\sourcePath1",
"targetPath": "C:\targetPath1"
},
{
"sourcePath": "C:\sourcePath2",
"targetPath": "C:\targetPath2"
}
],
"database": 0,
"publicationDetail": {
"id": 3,
"name": "publication3",
"description": "General publication",
"dbEngineDetail": {
"id": 3,
"logicalName": "FAIRCOMS1@hostname",
"opSystem": 0,
"workingVolume": 0,
"workingDir": "FairCom",
"name": "FAIRCOMS1",
"status": "active", // see "Status" for values
"statusCode": 1, // see "EngineStatus" for values
"statusTime": "2015-11-05T10:00:00",
"lastCheckTime": "2015-11-17T11:35:00",
"description": "Faircoms 1 DBEngine description",
"authContent": "I/98U15O\8UOv",
"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": false, // can be true, false or never.
In the last case its status
cannot be changed
"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"
}
],
"databaseList": [
{
"id": 1,
"dbEngine": 1,
"name": "database1",
"dictFileName": "c:\server\databases\database1\SQL_SYS\database1.fdd",
"isSQL": true
},
{
"id": 2,
"dbEngine": 1,
"name": "database2",
"dictFileName": "c:\server\databases\database2\database2.fdd",
"isSQL": false
}
]
}
},
},
{
"id": 2,
"name": "subscription2",
"description": "Subscription for XYZ purposes",
"dbEngineDetail": {
"id": 3,
"logicalName": "FAIRCOMS1@hostname",
"opSystem": 0,
"workingVolume": 0,
"workingDir": "FairCom",
"name": "FAIRCOMS1",
"status": "active", // see "Status" for values
"statusCode": 1, // see "EngineStatus" for values
"statusTime": "2015-11-05T10:00:00",
"lastCheckTime": "2015-11-17T11:35:00",
"description": "Faircoms 1 DBEngine description",
"authContent": "I/98U15O\8UOv,
"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": false, // can be true, false or never.
"never" = status cannot be changed
"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"
}
],
"databaseList": [
{
"id": 1,
"dbEngine": 1,
"name": "database1",
"dictFileName": "c:\server\databases\database1\SQL_SYS\database1.fdd",
"isSQL": true
},
{
"id": 2,
"dbEngine": 1,
"name": "database2",
"dictFileName": "c:\server\databases\database2\database2.fdd",
"isSQL": false
}
]
},
"redirectionList": [
{
"sourcePath": "C:\sourcePath1",
"targetPath": "C:\targetPath1"
},
{
"sourcePath": "C:\sourcePath2",
"targetPath": "C:\targetPath2"
}
],
"publicationDetail": {
"id": 2,
"name": "publication2",
"description": "Publication for XYZ purposes",
"dbEngineDetail": {
"id": 3,
"logicalName": "FAIRCOMS1@hostname",
"opSystem": 0,
"workingVolume": 0,
"workingDir": "FairCom",
"name": "FAIRCOMS1",
"status": "active", // see "Status" for values
"statusCode": 1, // see "EngineStatus" for values
"statusTime": "2015-11-05T10:00:00",
"lastCheckTime": "2015-11-17T11:35:00",
"description": "Faircoms 1 DBEngine description",
"authContent": "I/98U15O\8UOv",
"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": false, // can be true, false or never.
"never" means status can't be changed
"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"
}
],
"databaseList": [
{
"id": 1,
"dbEngine": 1,
"name": "database1",
"dictFileName": "c:\server\databases\database1\SQL_SYS\database1.fdd",
"isSQL": true
},
{
"id": 2,
"dbEngine": 1,
"name": "database2",
"dictFileName": "c:\server\databases\database2\database2.fdd",
"isSQL": false
}
]
}
}
}
],
"warningThreshold": 30, // how many seconds behind to
show a warning message
"errorThreshold": 300, // how many seconds behind
to show an error
"latency": 22, // how many seconds behind
the Replication Plan is
at this moment
"latencyTime": "Thu Aug 23 14:55:02 2001", // when the latency was checked
by the last time
"latencyRev": 22, // how many seconds behind the
Replication Plan reverse
direction is at this moment
"latencyRevTime": "Thu Aug 23 14:55:02 2001", // when the reverse direction
latency was checked by the
last time
"batchSize": 8192,
"debugMinLog": 0,
"exceptionMode": 0,
"lockRetryCount": 5,
"lockRetrySleep": 1000,
"logChangeDetails": "",
"readTimeOut": 5000,
"rememberLogPos": 1,
"parallelApply": true,
"checkDependencies": true,
"syncLogWrites": false,
"analyzerThreadsCount": 1,
"applyThreadsCount": 8,
"fileMask": "",
"isBiDirectional": 1,
"isDeployed": false,
"isPulling": true,
"ignorePartition": false,
"extensionLibrary": "ctrepluser.dll",
"status": "active",
"statusCode": 1, // see "ReplicationStatus" for possible values
"statusTime": "Thu Aug 23 14:55:02 2001",
"statusMsg": "",
"statusActionID": 132,
"sourceLogPos": "1 9383963 1 9383963",
"targetLogPos": "1 9383963 1 9383963",
"isMonitorActive": true,
"monitorTime": "Thu Aug 23 14:55:02 2001", // Since when the monitor is
active or not
"refreshRate": 5,
"isExcepLogActive": true,
"excepLogTime": "Thu Aug 23 14:55:02 2001", // Since when exception logging
is active or not
"isFuncTimingActive": true,
"funcTimingTime": "Thu Aug 23 14:55:02 2001", // Since when exception logging
is active or not,
"conflictDetection": true,
"hasNonAckException": true // Flag indicating Plan has at least
one not acknowledge exception
},
{
"id": 1,
"name": "PLAN2",
"description": "Plan 2 description",
"subscriptionDetailList": [],
"warningThreshold": 30, // how many seconds behind to show
a warning message
"errorThreshold": 300, // how many seconds behind to show
an error
"latency": 22, // how many seconds behind the
Replication Plan is at this moment
"latencyTime": "Thu Aug 23 14:55:02 2001", // when the latency was checked
by the last time
"latencyRev": 22, // how many seconds behind the
Replication Plan reverse direction
is at this moment
"latencyRevTime": "Thu Aug 23 14:55:02 2001", // when the reverse direction
latency was checked
by the last time
"batchSize": 8192,
"debugMinLog": 0,
"exceptionMode": 0,
"lockRetryCount": 5,
"lockRetrySleep": 1000,
"logChangeDetails": "",
"readTimeOut": 5000,
"rememberLogPos": 1,
"parallelApply": true,
"checkDependencies": true,
"syncLogWrites": false,
"analyzerThreadsCount": 1,
"applyThreadsCount": 8,
"fileMask": "",
"isBiDirectional": 1,
"isDeployed": false,
"isPulling": true,
"ignorePartition": false,
"extensionLibrary": "ctrepluser.dll",
"status": "active",
"statusCode": 1, // see "ReplicationStatus" for possible values
"statusTime": "Thu Aug 23 14:55:02 2001",
"statusMsg": "",
"statusActionID": 132,
"sourceLogPos": "1 9383963 1 9383963",
"targetLogPos": "1 9383963 1 9383963",
"isMonitorActive": true,
"monitorTime": "Thu Aug 23 14:55:02 2001", // Since when the monitor
is active or not
"refreshRate": 5,
"isExcepLogActive": true,
"excepLogTime": "Thu Aug 23 14:55:02 2001", // Since when the exception
logging is active or not
"isFuncTimingActive": true,
"funcTimingTime": "Thu Aug 23 14:55:02 2001", // Since when the exception
logging is active or not,
"conflictDetection": true,
"hasNonAckException": true // Flag indicating that the
Plan has at least one not
acknowledge exception
}
]
"success": true,
"error":
{
"errorCode": 0,
"message": "Success"
},
"total": 500 // total number of replication plan for the query - see Note 1
}
Return:
Error code
