Fetch DB2 Instance Properties
This operation is used to fetch DB2 instance properties
Path Parameters
- InstanceID integer required
ID of the 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 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 integersecurityAssociations object
ownerAssociations objecttagWithCompany object
providerId integerproviderDomainName stringindexSettings object
indexRetCycle integeroverrideIndexPruning integerindexRetDays integerindexPruningType stringcurrentIndexServer objectqualifyingIndexServers object[]
clientId integerclientName stringinstanceActivityControl object
Info about activity control of instance
activityControlOptions object[]
activityType stringenableAfterADelay booleanenableActivityType booleansecurity object
associatedUserGroups object[]
userGroupId integer_type_ stringuserGroupName stringadvancedPrivacySettings object
isPasskeyFeatureEnabled booleanauthType stringisPrivacyFeatureEnabled booleanpasskeySettings object
enableAuthorizeForRestore booleanexpirationTime object
time integerownerCapabilities objectdb2Instance object
Instance specific properties
homeDirectory stringpureScale booleanuserAccount object
domainName stringuserName stringDB2StorageDevice object
networkAgents integersoftwareCompression stringthrottleNetworkBandwidth integerdataBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature stringlogBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integercommandLineStoragePolicy object
storagePolicyName stringstoragePolicyId integerplanEntity object
Instance plan properties
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": "string",
"currentIndexServer": {},
"qualifyingIndexServers": [
{
"clientId": 0,
"clientName": "string"
}
]
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": "string",
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": "string",
"userGroupName": "string"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": true,
"authType": "string",
"isPrivacyFeatureEnabled": true,
"passkeySettings": {
"enableAuthorizeForRestore": true,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"db2Instance": {
"homeDirectory": "string",
"pureScale": true,
"userAccount": {
"domainName": "string",
"userName": "string"
},
"DB2StorageDevice": {
"networkAgents": 0,
"softwareCompression": "string",
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": "string"
},
"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": "SQL11058 64bit",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "vikram-manual-8",
"instanceName": "db2inst9",
"displayName": "vikram-manual-8",
"instanceId": 752,
"instanceGUID": "BA29D0A3-34B9-4247-8B43-AE10383837B3",
"clientId": 203,
"appName": "DB2",
"applicationId": 62,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"indexSettings": {
"indexRetCycle": -1,
"overrideIndexPruning": 0,
"indexRetDays": -1,
"indexPruningType": "InfiniteRetention",
"currentIndexServer": {},
"qualifyingIndexServers": [
{},
{
"clientId": 168,
"clientName": "winter11"
}
]
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": "BACKUP",
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": "RESTORE",
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": "USERGROUP_ENTITY",
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": "USE_LOGIN",
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"db2Instance": {
"homeDirectory": "/home/db2inst9",
"pureScale": false,
"userAccount": {
"domainName": "",
"userName": "db2inst9"
},
"DB2StorageDevice": {
"networkAgents": 2,
"softwareCompression": "USE_STORAGE_POLICY_SETTINGS",
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"storagePolicyName": "a_default_winter11",
"storagePolicyId": 44
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": "ON_CLIENT"
},
"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": {}
}
}
]
}
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...