Fetch SAP for Oracle Instances associated to a client
Get SAP for Oracle Instances associated to a client
Query Parameters
- clientName string required
Name of the client
- appName string required
Default value:
SAP for Oracle
Set this to SAP for Oracle
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
instanceProperties object[]
version stringautoDiscovered booleanstatus integerjobStartTime integerisDeleted booleanapplicationSize integerexcludeFromSLA booleanscIdxEnabled integerisSnapEnabled booleaninstance object
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleansapOracleInstance object
encryptionFlag integerclientOSType integerDBID stringinstanceFlags integeroverrideDataPathsForLogPolicy booleansapDataPath stringblockSize integerisCDBInstance booleansapExeFolder stringoracleHome stringoverrideDataPathsForCmdPolicy booleannumberOfArchiveLogBackupStreams integeruseSAPSecureStore booleanoracleStorageDevice object
networkAgents integersoftwareCompression integerthrottleNetworkBandwidth integerdeDuplicationOptions object
generateSignature integerlogBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integercommandLineStoragePolicy object
storagePolicyName stringstoragePolicyId integersqlConnect object
domainName stringuserName stringoracleUser object
domainName stringuserName stringosUserCredInfo objectsnapProtectInfo object
isSnapBackupEnabled booleanuseSourceProxyUnreachable booleanallowMultipleDataReaders booleanproxyToUse object
clientId integerclientName stringsnapSelectedEngine object
snapShotEngineId integersnapShotEngineName stringcredentialEntity object
credentialId integercredentialName stringcloudDBInstance object
overRideAccessNode booleanaccessNodes objectlastBackupJobInfo object
jobID integerfailureReasonIds stringcommCellID integerfailureReasonMessageEnglish stringstatus integerstartTime object
time integerendTime object
time integerplanEntity object
planType integerplanName stringplanSubtype integerplanId integer
{
"instanceProperties": [
{
"version": "string",
"autoDiscovered": true,
"status": 0,
"jobStartTime": 0,
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"scIdxEnabled": 0,
"isSnapEnabled": true,
"instance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"instanceGUID": "string",
"clientId": 0,
"appName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"sapOracleInstance": {
"encryptionFlag": 0,
"clientOSType": 0,
"DBID": "string",
"instanceFlags": 0,
"overrideDataPathsForLogPolicy": true,
"sapDataPath": "string",
"blockSize": 0,
"isCDBInstance": true,
"sapExeFolder": "string",
"oracleHome": "string",
"overrideDataPathsForCmdPolicy": true,
"numberOfArchiveLogBackupStreams": 0,
"useSAPSecureStore": true,
"oracleStorageDevice": {
"networkAgents": 0,
"softwareCompression": 0,
"throttleNetworkBandwidth": 0,
"deDuplicationOptions": {
"generateSignature": 0
},
"logBackupStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"commandLineStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
}
},
"sqlConnect": {
"domainName": "string",
"userName": "string"
},
"oracleUser": {
"domainName": "string",
"userName": "string"
},
"osUserCredInfo": {},
"snapProtectInfo": {
"isSnapBackupEnabled": true,
"useSourceProxyUnreachable": true,
"allowMultipleDataReaders": true,
"proxyToUse": {
"clientId": 0,
"clientName": "string"
},
"snapSelectedEngine": {
"snapShotEngineId": 0,
"snapShotEngineName": "string"
}
}
},
"credentialEntity": {
"credentialId": 0,
"credentialName": "string"
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
},
"lastBackupJobInfo": {
"jobID": 0,
"failureReasonIds": "string",
"commCellID": 0,
"failureReasonMessageEnglish": "string",
"status": 0,
"startTime": {
"time": 0
},
"endTime": {
"time": 0
}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
}
}
]
}
{
"instanceProperties": [
{
"version": "12.1.0.2.0",
"autoDiscovered": false,
"status": 0,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 17197694976,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"instance": {
"clientName": "sde3",
"instanceName": "N741",
"displayName": "sde3",
"instanceId": 886,
"instanceGUID": "A9F5E771-298C-43BE-854A-96958BB25545",
"clientId": 465,
"appName": "SAP for Oracle",
"applicationId": 61,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"sapOracleInstance": {
"encryptionFlag": 0,
"clientOSType": 98,
"DBID": 760389992,
"instanceFlags": 258,
"overrideDataPathsForLogPolicy": false,
"sapDataPath": "/oracle/N74",
"blockSize": 1048576,
"isCDBInstance": false,
"sapExeFolder": "/folder",
"oracleHome": "/oracle/N74/121",
"overrideDataPathsForCmdPolicy": false,
"numberOfArchiveLogBackupStreams": 1,
"useSAPSecureStore": true,
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "backupPlan_LS_1",
"storagePolicyId": 11
},
"commandLineStoragePolicy": {
"storagePolicyName": "backupPlan_LS_1",
"storagePolicyId": 11
}
},
"sqlConnect": {
"domainName": "N741",
"userName": "SYS"
},
"oracleUser": {
"domainName": "",
"userName": "oracle"
},
"osUserCredInfo": {},
"snapProtectInfo": {
"isSnapBackupEnabled": false,
"useSourceProxyUnreachable": false,
"allowMultipleDataReaders": false,
"proxyToUse": {
"clientId": 0,
"clientName": ""
},
"snapSelectedEngine": {
"snapShotEngineId": 0,
"snapShotEngineName": "NA"
}
}
},
"credentialEntity": {
"credentialId": 0,
"credentialName": ""
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
},
"lastBackupJobInfo": {
"jobID": 678193,
"failureReasonIds": "",
"commCellID": 2,
"failureReasonMessageEnglish": "",
"status": 1,
"startTime": {
"time": 1752657310
},
"endTime": {
"time": 1752657375
}
}
},
{
"version": "",
"autoDiscovered": false,
"status": 0,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 17197694976,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"instance": {
"clientName": "sde3",
"instanceName": "N742",
"displayName": "sde3",
"instanceId": 1433,
"instanceGUID": "BBD312A3-5A8D-4EC8-9D5E-FACC4B9D71FF",
"clientId": 465,
"appName": "SAP for Oracle",
"applicationId": 61,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"planEntity": {
"planType": 2,
"planName": "backupPlan_LS_1",
"planSubtype": 33554437,
"planId": 6
},
"sapOracleInstance": {
"encryptionFlag": 2,
"clientOSType": 98,
"DBID": "",
"instanceFlags": 0,
"overrideDataPathsForLogPolicy": false,
"sapDataPath": "/oracle/N74",
"blockSize": 1048576,
"isCDBInstance": false,
"sapExeFolder": "/folder",
"oracleHome": "/oracle/N74/121",
"overrideDataPathsForCmdPolicy": false,
"numberOfArchiveLogBackupStreams": 1,
"useSAPSecureStore": true,
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "backupPlan_LS_1",
"storagePolicyId": 11
},
"commandLineStoragePolicy": {
"storagePolicyName": "backupPlan_LS_1",
"storagePolicyId": 11
}
},
"sqlConnect": {
"domainName": "N741",
"userName": "user"
},
"oracleUser": {
"domainName": "",
"userName": "oracle"
},
"osUserCredInfo": {},
"snapProtectInfo": {
"isSnapBackupEnabled": false,
"useSourceProxyUnreachable": false,
"allowMultipleDataReaders": false,
"proxyToUse": {
"clientId": 0,
"clientName": ""
},
"snapSelectedEngine": {
"snapShotEngineId": 0,
"snapShotEngineName": "NA"
}
}
},
"credentialEntity": {
"credentialId": 0,
"credentialName": ""
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
},
"lastBackupJobInfo": {
"jobID": 673728,
"failureReasonIds": 5261973,
"commCellID": 2,
"failureReasonMessageEnglish": "Last Backup job 673728 did not complete\nsuccessfully for the instance with the error: Error\n:[Database should be in OPEN mode for online SAP\nbackup, present status = SHUTDOWN.]",
"status": 2,
"startTime": {
"time": 1752251425
},
"endTime": {
"time": 1752264282
}
}
},
{
"version": "",
"autoDiscovered": false,
"status": 0,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 17197694976,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"instance": {
"clientName": "sde3",
"instanceName": "N742_test",
"displayName": "sde3",
"instanceId": 1440,
"instanceGUID": "A0A65DC4-7C25-4B25-8857-9F9855116150",
"clientId": 465,
"appName": "SAP for Oracle",
"applicationId": 61,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"planEntity": {
"planType": 2,
"planName": "backupPlan_CS_1",
"planSubtype": 33554437,
"planId": 1
},
"sapOracleInstance": {
"encryptionFlag": 2,
"clientOSType": 98,
"DBID": "",
"instanceFlags": 0,
"overrideDataPathsForLogPolicy": false,
"sapDataPath": "/oracle/N74",
"blockSize": 1048576,
"isCDBInstance": false,
"sapExeFolder": "/folder",
"oracleHome": "/oracle/N74/121",
"overrideDataPathsForCmdPolicy": false,
"numberOfArchiveLogBackupStreams": 1,
"useSAPSecureStore": false,
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "backupPlan_CS_1",
"storagePolicyId": 4
},
"commandLineStoragePolicy": {
"storagePolicyName": "backupPlan_CS_1",
"storagePolicyId": 4
}
},
"sqlConnect": {
"domainName": "N741",
"userName": "user"
},
"oracleUser": {
"domainName": "",
"userName": "oracle"
},
"osUserCredInfo": {},
"snapProtectInfo": {
"isSnapBackupEnabled": false,
"useSourceProxyUnreachable": false,
"allowMultipleDataReaders": false,
"proxyToUse": {
"clientId": 0,
"clientName": ""
},
"snapSelectedEngine": {
"snapShotEngineId": 0,
"snapShotEngineName": "NA"
}
}
},
"credentialEntity": {
"credentialId": 0,
"credentialName": ""
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
},
{
"version": "",
"autoDiscovered": false,
"status": 0,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 17197694976,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"instance": {
"clientName": "sde3",
"instanceName": "N777",
"displayName": "sde3",
"instanceId": 1441,
"instanceGUID": "BB0D3035-E423-4921-9D58-51683E512428",
"clientId": 465,
"appName": "SAP for Oracle",
"applicationId": 61,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"planEntity": {
"planType": 2,
"planName": "backupPlan_CS_1",
"planSubtype": 33554437,
"planId": 1
},
"sapOracleInstance": {
"encryptionFlag": 2,
"clientOSType": 98,
"DBID": "",
"instanceFlags": 0,
"overrideDataPathsForLogPolicy": false,
"sapDataPath": "/oracle/N74",
"blockSize": 1048576,
"isCDBInstance": false,
"sapExeFolder": "/folder",
"oracleHome": "/oracle/N74/121",
"overrideDataPathsForCmdPolicy": false,
"numberOfArchiveLogBackupStreams": 1,
"useSAPSecureStore": false,
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "backupPlan_CS_1",
"storagePolicyId": 4
},
"commandLineStoragePolicy": {
"storagePolicyName": "backupPlan_CS_1",
"storagePolicyId": 4
}
},
"sqlConnect": {
"domainName": "N741",
"userName": "user"
},
"oracleUser": {
"domainName": "",
"userName": "oracle"
},
"osUserCredInfo": {},
"snapProtectInfo": {
"isSnapBackupEnabled": false,
"useSourceProxyUnreachable": false,
"allowMultipleDataReaders": false,
"proxyToUse": {
"clientId": 0,
"clientName": ""
},
"snapSelectedEngine": {
"snapShotEngineId": 0,
"snapShotEngineName": "NA"
}
}
},
"credentialEntity": {
"credentialId": 0,
"credentialName": ""
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Bad Request
Unauthorized
Loading...