Fetch DB2 MultiNode Instance Properties
Select
SaaS
Customer Managed
This Operation is used to fetch the DB2 MultiNode Instance properties
Path Parameters
- InstanceID integer required
ID of the DB2 MultiNode Instance
Query Parameters
- propertyLevel integer
Possible values: [
0
,10
,20
,30
]Higher the property level more properties are fetched
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
instanceProperties object[]
DB2 MultiNode Instance Properties
isDeleted booleanapplicationSize integerexcludeFromSLA booleanversion stringscIdxEnabled integerisSnapEnabled booleanautoDiscovered booleaninstance object
Instance Specific Properties
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integersecurityAssociations object
ownerAssociations objecttagWithCompany object
providerId integerproviderDomainName stringindexSettings object
indexRetCycle integeroverrideIndexPruning integerindexRetDays integerindexPruningType integercurrentIndexServer objectqualifyingIndexServers object[]
clientId integerclientName stringinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleansecurity object
associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringadvancedPrivacySettings object
isPasskeyFeatureEnabled booleanauthType integerisPrivacyFeatureEnabled booleanpasskeySettings object
enableAuthorizeForRestore booleanexpirationTime object
time integerownerCapabilities objectdb2Instance object
homeDirectory stringpureScale booleandpfpartitionclients object[]
nodenum integernodeClient object
hostName stringclientId integerclientName stringdisplayName stringuserAccount object
domainName stringuserName stringDB2StorageDevice object
networkAgents integersoftwareCompression integerthrottleNetworkBandwidth integerdataBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature integerlogBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integercommandLineStoragePolicy object
storagePolicyName stringstoragePolicyId integerplanEntity object
planType integerplanName stringplanSubtype integerplanId integercloudDBInstance object
overRideAccessNode booleanaccessNodes 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
}
},
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "string"
}
},
"indexSettings": {
"indexRetCycle": 0,
"overrideIndexPruning": 0,
"indexRetDays": 0,
"indexPruningType": 0,
"currentIndexServer": {},
"qualifyingIndexServers": [
{
"clientId": 0,
"clientName": "string"
}
]
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": 0,
"userGroupName": "string"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": true,
"authType": 0,
"isPrivacyFeatureEnabled": true,
"passkeySettings": {
"enableAuthorizeForRestore": true,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"db2Instance": {
"homeDirectory": "string",
"pureScale": true,
"dpfpartitionclients": [
{
"nodenum": 0,
"nodeClient": {
"hostName": "string",
"clientId": 0,
"clientName": "string",
"displayName": "string"
}
}
],
"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
}
}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"version": "SQL11014 64bit",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "vikramdpf",
"instanceName": "dpfinst",
"displayName": "vikramdpf",
"instanceId": 5419,
"instanceGUID": "5F459610-639D-42D8-8247-8562A6855948",
"clientId": 1483,
"appName": "DB2 MultiNode",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"indexSettings": {
"indexRetCycle": -1,
"overrideIndexPruning": 0,
"indexRetDays": -1,
"indexPruningType": 0,
"currentIndexServer": {},
"qualifyingIndexServers": [
{},
{
"clientId": 1227,
"clientName": "vikram-win-man"
}
]
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": 1,
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"db2Instance": {
"homeDirectory": "/home/dpfinst",
"pureScale": false,
"dpfpartitionclients": [
{
"nodenum": 0,
"nodeClient": {
"hostName": "12.16.20.39",
"clientId": 1469,
"clientName": "vikramdpf1",
"displayName": "vikramdpf1"
}
},
{
"nodenum": 1,
"nodeClient": {
"hostName": "72.6.20.29",
"clientId": 1469,
"clientName": "vikramdpf1",
"displayName": "vikramdpf1"
}
},
{
"nodenum": 2,
"nodeClient": {
"hostName": "12.16.2.44",
"clientId": 1470,
"clientName": "vikramdpf2",
"displayName": "vikramdpf2"
}
},
{
"nodenum": 3,
"nodeClient": {
"hostName": "1.1.10.44",
"clientId": 1470,
"clientName": "vikramdpf2",
"displayName": "vikramdpf2"
}
}
],
"userAccount": {
"domainName": "",
"userName": "dpfinst"
},
"DB2StorageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "vikram trad dedup regression",
"storagePolicyId": 291
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"storagePolicyName": "vikram trad dedup regression",
"storagePolicyId": 291
},
"commandLineStoragePolicy": {
"storagePolicyName": "vikram trad dedup regression",
"storagePolicyId": 291
}
}
},
"planEntity": {
"planType": 2,
"planName": "vikram trad dedup regression",
"planSubtype": 33554437,
"planId": 118
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Bad Request
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}
Loading...