Fetch Oracle Instances associated to a client
Select
SaaS
Customer Managed
Fetch properties of oracle instances associated to the client.
Query Parameters
- clientName string required
Name of the client
- appName string required
Default value:
Oracle
Set this to oracle
Responses
- 200
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
instanceProperties object[]
isDeleted booleanapplicationSize integerexcludeFromSLA booleanversion stringscIdxEnabled integerisSnapEnabled booleanautoDiscovered booleaninstance object
Instance General properties
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integeroracleInstance object
Instance Oracle properties
encryptionFlag integerDBID stringuseCatalogConnect booleanisOnDemand booleanoracleHome stringisTDEEncryptedDB booleanctrlFileAutoBackup integernumberOfArchiveLogBackupStreams integeroverrideLocalSystemAccount booleanoracleWalletAuthentication booleanclientOSType integeroverrideDataPathsForLogPolicy booleanblockSize integerisRMANEnableForTapeMovement booleanisCDBInstance booleanoverrideDataPathsForCmdPolicy booleandbname stringdisableRMANcrosscheck booleanstorageType integercrossCheckTimeout integerTNSAdminPath stringoracleUser object
Oracle User properties
domainName stringuserName stringproxyClients objectoracleStorageDevice object
Storage properties
networkAgents integersoftwareCompression integerthrottleNetworkBandwidth integerdeDuplicationOptions object
generateSignature integerlogBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integercommandLineStoragePolicy object
storagePolicyName stringstoragePolicyId integersqlConnect object
domainName stringuserName stringrdsConfig objectcatalogConnect object
domainName stringuserName stringinstanceActivityControl object
Instance activiy control options
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleanplanEntity object
planType integerplanName stringplanSubtype integerplanId integercloudDBInstance object
overRideAccessNode booleanvmHypType integervmGUID stringaccessNodes object
{
"instanceProperties": [
{
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"version": "string",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": 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
}
},
"oracleInstance": {
"encryptionFlag": 0,
"DBID": "string",
"useCatalogConnect": true,
"isOnDemand": true,
"oracleHome": "string",
"isTDEEncryptedDB": true,
"ctrlFileAutoBackup": 0,
"numberOfArchiveLogBackupStreams": 0,
"overrideLocalSystemAccount": true,
"oracleWalletAuthentication": true,
"clientOSType": 0,
"overrideDataPathsForLogPolicy": true,
"blockSize": 0,
"isRMANEnableForTapeMovement": true,
"isCDBInstance": true,
"overrideDataPathsForCmdPolicy": true,
"dbname": "string",
"disableRMANcrosscheck": true,
"storageType": 0,
"crossCheckTimeout": 0,
"TNSAdminPath": "string",
"oracleUser": {
"domainName": "string",
"userName": "string"
},
"proxyClients": {},
"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"
},
"rdsConfig": {},
"catalogConnect": {
"domainName": "string",
"userName": "string"
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cloudDBInstance": {
"overRideAccessNode": true,
"vmHypType": 0,
"vmGUID": "string",
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"version": "",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "oraserv1",
"instanceName": "ora1",
"displayName": "oraserv1",
"instanceId": 4214,
"instanceGUID": "66ABADAF3B-B605-74AS-ACAA3-F8ACCEDF18B0",
"clientId": 1129,
"appName": "Oracle",
"applicationId": 22,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"oracleInstance": {
"encryptionFlag": 2,
"DBID": "",
"useCatalogConnect": false,
"isOnDemand": false,
"oracleHome": "M:\\\\ora\\\\",
"isTDEEncryptedDB": false,
"ctrlFileAutoBackup": 1,
"numberOfArchiveLogBackupStreams": 1,
"overrideLocalSystemAccount": true,
"oracleWalletAuthentication": false,
"clientOSType": 210,
"overrideDataPathsForLogPolicy": false,
"blockSize": 1048576,
"isRMANEnableForTapeMovement": false,
"isCDBInstance": false,
"overrideDataPathsForCmdPolicy": false,
"dbname": "",
"disableRMANcrosscheck": false,
"storageType": 0,
"crossCheckTimeout": 600,
"TNSAdminPath": "",
"oracleUser": {
"domainName": "",
"userName": ""
},
"proxyClients": {},
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": -1,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "plan1",
"storagePolicyId": 88
},
"commandLineStoragePolicy": {
"storagePolicyName": "plan1",
"storagePolicyId": 88
}
},
"sqlConnect": {
"domainName": "",
"userName": "/"
},
"rdsConfig": {},
"catalogConnect": {
"domainName": "",
"userName": ""
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"planEntity": {
"planType": 2,
"planName": "plan2",
"planSubtype": 33554437,
"planId": 37
},
"cloudDBInstance": {
"overRideAccessNode": false,
"vmHypType": 2,
"vmGUID": "56564239A-ADF-405629-8A78-3B84E727CB03",
"accessNodes": {}
}
},
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"version": "",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "oraserv1",
"instanceName": "ora2",
"displayName": "oraserv1",
"instanceId": 4215,
"instanceGUID": "B433F5A7-FE1B-448C-A575-FB8911870104",
"clientId": 1129,
"appName": "Oracle",
"applicationId": 22,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"oracleInstance": {
"encryptionFlag": 2,
"DBID": "",
"useCatalogConnect": false,
"isOnDemand": false,
"oracleHome": "M:\\\\ora\\\\",
"isTDEEncryptedDB": false,
"ctrlFileAutoBackup": 1,
"numberOfArchiveLogBackupStreams": 0,
"overrideLocalSystemAccount": true,
"oracleWalletAuthentication": false,
"clientOSType": 210,
"overrideDataPathsForLogPolicy": false,
"blockSize": 1048576,
"isRMANEnableForTapeMovement": false,
"isCDBInstance": false,
"overrideDataPathsForCmdPolicy": false,
"dbname": "",
"disableRMANcrosscheck": false,
"storageType": 0,
"crossCheckTimeout": 600,
"TNSAdminPath": "",
"oracleUser": {
"domainName": "",
"userName": ""
},
"proxyClients": {},
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": -1,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
},
"commandLineStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
}
},
"sqlConnect": {
"domainName": "",
"userName": "/"
},
"rdsConfig": {},
"catalogConnect": {
"domainName": "",
"userName": ""
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"cloudDBInstance": {
"overRideAccessNode": false,
"vmHypType": 2,
"vmGUID": "GDSDU-1D42-4029-8A78-YDHDSDYD",
"accessNodes": {}
}
},
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"version": "",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "oraserv1",
"instanceName": "ora3",
"displayName": "oraserv1",
"instanceId": 4226,
"instanceGUID": "12FSHDNKSDJF202-FHFGF-4D2C-8784-A2634D981E1B",
"clientId": 1129,
"appName": "Oracle",
"applicationId": 22,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"oracleInstance": {
"encryptionFlag": 2,
"DBID": "",
"useCatalogConnect": false,
"isOnDemand": false,
"oracleHome": "M:\\\\ora\\\\",
"isTDEEncryptedDB": false,
"ctrlFileAutoBackup": 1,
"numberOfArchiveLogBackupStreams": 0,
"overrideLocalSystemAccount": true,
"oracleWalletAuthentication": false,
"clientOSType": 210,
"overrideDataPathsForLogPolicy": false,
"blockSize": 1048576,
"isRMANEnableForTapeMovement": false,
"isCDBInstance": false,
"overrideDataPathsForCmdPolicy": false,
"dbname": "",
"disableRMANcrosscheck": false,
"storageType": 0,
"crossCheckTimeout": 600,
"TNSAdminPath": "",
"oracleUser": {
"domainName": "",
"userName": ""
},
"proxyClients": {},
"oracleStorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": -1,
"deDuplicationOptions": {
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
},
"commandLineStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
}
},
"sqlConnect": {
"domainName": "",
"userName": "/"
},
"rdsConfig": {},
"catalogConnect": {
"domainName": "",
"userName": ""
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"cloudDBInstance": {
"overRideAccessNode": false,
"vmHypType": 2,
"vmGUID": "A744239A-1D42-4029-8A78-3B84E727CB03",
"accessNodes": {}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Not found
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "No client is specified",
"errorCode": 4
}
Loading...