Fetch SAP Oracle instance properties
Select
SaaS
Customer Managed
Get SAP for Oracle instance details using client name
Path Parameters
- instanceId string required
Query Parameters
- ClientName string required
SAP Oracle client name to get Instance details
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 booleanplanEntity object
planType integerplanName stringplanSubtype integerplanId integersapOracleInstance 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 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
}
]
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"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
}
}
}
]
}
{
"instanceProperties": [
{
"version": "12.2.0.1.0",
"autoDiscovered": false,
"status": 0,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 1322254336,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"instance": {
"clientName": "sapprm1",
"instanceName": "CER1",
"displayName": "sapprm1",
"instanceId": 1164,
"instanceGUID": "59A40B6D-826A-4287-804E-D8708DB207F2",
"clientId": 45,
"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": "plan_test",
"planSubtype": 33554437,
"planId": 58
},
"sapOracleInstance": {
"encryptionFlag": 2,
"clientOSType": 210,
"DBID": "2029581950",
"instanceFlags": 0,
"overrideDataPathsForLogPolicy": false,
"sapDataPath": "E:/app/orclusr/CER1",
"blockSize": 1048576,
"isCDBInstance": false,
"sapExeFolder": "C:/usr/sap/CER1/sys/exe/run",
"oracleHome": "C:/app/orclusr/product/12.2.0/dbhome_1",
"overrideDataPathsForCmdPolicy": false,
"numberOfArchiveLogBackupStreams": 4,
"useSAPSecureStore": false,
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "plan_test",
"storagePolicyId": 84
},
"commandLineStoragePolicy": {
"storagePolicyName": "plan_test",
"storagePolicyId": 84
}
},
"sqlConnect": {
"domainName": "CER1",
"userName": "sys"
},
"oracleUser": {
"domainName": "sapprm1",
"userName": "Test"
},
"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": 669617,
"failureReasonIds": "",
"commCellID": 2,
"failureReasonMessageEnglish": "",
"status": 1,
"startTime": {
"time": 1751899050
},
"endTime": {
"time": 1751899270
}
}
}
]
}
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Loading...