List All DB2 Instances
This operation is used to fetch all the DB2 instances and their properties inside a DB2 Client.
Query Parameters
- clientId integer required
ID of the client
- applicationId integer required
Possible values: [
37
,62
]62 needs to be passed for DB2 Unix client or 37 for DB2 windows client
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
instanceProperties object[]
DB2 instance properties
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 integerinstanceActivityControl object
instance activity control details
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleandb2Instance object
instance specific properties
homeDirectory stringpureScale booleanuserAccount object
domainName stringuserName stringDB2StorageDevice object
networkAgents integersoftwareCompression integerthrottleNetworkBandwidth integerdataBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature integerlogBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integercommandLineStoragePolicy object
storagePolicyName stringstoragePolicyId integercloudDBInstance object
overRideAccessNode booleanaccessNodes objectplanEntity object
plan details of the instance
planType integerplanName stringplanSubtype integerplanId integer
{
"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
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"db2Instance": {
"homeDirectory": "string",
"pureScale": true,
"userAccount": {
"domainName": "string",
"userName": "string"
},
"DB2StorageDevice": {
"networkAgents": 0,
"softwareCompression": 0,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 0
},
"logBackupStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"commandLineStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
}
}
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"applicationSize": 348127232,
"excludeFromSLA": false,
"version": "SQL11058 64bit",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "vikram-manual-8",
"instanceName": "auto",
"displayName": "vikram-manual-8",
"instanceId": 502,
"instanceGUID": "F4A45610-CC9D-4DB9-A978-A04F5DDDE301",
"clientId": 203,
"appName": "DB2",
"applicationId": 62,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"db2Instance": {
"homeDirectory": "/home/auto/",
"pureScale": false,
"userAccount": {
"domainName": "",
"userName": "auto"
},
"DB2StorageDevice": {
"networkAgents": 1,
"softwareCompression": 0,
"throttleNetworkBandwidth": -1,
"dataBackupStoragePolicy": {
"storagePolicyName": "vikram auto",
"storagePolicyId": 49
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "vikram auto",
"storagePolicyId": 49
},
"commandLineStoragePolicy": {
"storagePolicyName": "vikram auto",
"storagePolicyId": 49
}
}
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
},
{
"isDeleted": false,
"applicationSize": 348127232,
"excludeFromSLA": false,
"version": "SQL11058 64bit",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "vikram-manual-8",
"instanceName": "db2inst1",
"displayName": "vikram-manual-8",
"instanceId": 400,
"instanceGUID": "4DD059B7-9451-4F5E-9F02-407DCD92E527",
"clientId": 203,
"appName": "DB2",
"applicationId": 62,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"db2Instance": {
"homeDirectory": "/home/db2inst1",
"pureScale": false,
"userAccount": {
"domainName": "",
"userName": "db2inst1"
},
"DB2StorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "a_default_winter11",
"storagePolicyId": 44
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "a_default_winter11",
"storagePolicyId": 44
},
"commandLineStoragePolicy": {
"storagePolicyName": "a_default_winter11",
"storagePolicyId": 44
}
}
},
"planEntity": {
"planType": 2,
"planName": "a_default_winter11",
"planSubtype": 33554437,
"planId": 22
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
},
{
"isDeleted": false,
"applicationSize": 348127232,
"excludeFromSLA": false,
"version": "SQL11058 64bit",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "vikram-manual-8",
"instanceName": "db2inst2",
"displayName": "vikram-manual-8",
"instanceId": 409,
"instanceGUID": "9EF87AA1-0AA9-423A-81BD-769BA24D5E98",
"clientId": 203,
"appName": "DB2",
"applicationId": 62,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"db2Instance": {
"homeDirectory": "/home/db2inst2",
"pureScale": false,
"userAccount": {
"domainName": "",
"userName": "db2inst2"
},
"DB2StorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "a_non-default_winter11",
"storagePolicyId": 45
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "a_non-default_winter11",
"storagePolicyId": 45
},
"commandLineStoragePolicy": {
"storagePolicyName": "a_non-default_winter11",
"storagePolicyId": 45
}
}
},
"planEntity": {
"planType": 2,
"planName": "a_non-default_winter11",
"planSubtype": 33554437,
"planId": 23
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
},
{
"isDeleted": false,
"applicationSize": 348127232,
"excludeFromSLA": false,
"version": "",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "vikram-manual-8",
"instanceName": "db2inst6",
"displayName": "vikram-manual-8",
"instanceId": 766,
"instanceGUID": "9337982B-BFC6-4221-9072-FD2994C3CD03",
"clientId": 203,
"appName": "DB2",
"applicationId": 62,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"db2Instance": {
"homeDirectory": "/home/db2inst6",
"pureScale": false,
"userAccount": {
"domainName": "",
"userName": ""
},
"DB2StorageDevice": {
"networkAgents": 0,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
},
"commandLineStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
}
}
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
},
{
"isDeleted": false,
"applicationSize": 348127232,
"excludeFromSLA": false,
"version": "SQL11058 64bit",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "vikram-manual-8",
"instanceName": "db2inst9",
"displayName": "vikram-manual-8",
"instanceId": 753,
"instanceGUID": "5C9CF9E5-6CC6-4AE4-9D1E-A3163884276C",
"clientId": 203,
"appName": "DB2",
"applicationId": 62,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"db2Instance": {
"homeDirectory": "/home/db2inst9",
"pureScale": false,
"userAccount": {
"domainName": "",
"userName": "db2inst9"
},
"DB2StorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "a_default_winter11",
"storagePolicyId": 44
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "a_default_winter11",
"storagePolicyId": 44
},
"commandLineStoragePolicy": {
"storagePolicyName": "a_default_winter11",
"storagePolicyId": 44
}
}
},
"planEntity": {
"planType": 2,
"planName": "a_default_winter11",
"planSubtype": 33554437,
"planId": 22
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}
Loading...