Skip to main content

Fetch DB2 Instance Properties​

Select

SaaS
Customer Managed

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

OK

Schema
  • instanceProperties object[]

    DB2 instance properties

  • isDeleted boolean
  • applicationSize integer
  • excludeFromSLA boolean
  • version string
  • scIdxEnabled integer
  • isSnapEnabled boolean
  • autoDiscovered boolean
  • instance object

    Instance general properties

  • clientName string
  • instanceName string
  • displayName string
  • instanceId integer
  • instanceGUID string
  • clientId integer
  • appName string
  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • securityAssociations object
  • ownerAssociations object
  • tagWithCompany object
  • providerId integer
  • providerDomainName string
  • indexSettings object
  • indexRetCycle integer
  • overrideIndexPruning integer
  • indexRetDays integer
  • indexPruningType string
  • currentIndexServer object
  • qualifyingIndexServers object[]
  • clientId integer
  • clientName string
  • instanceActivityControl object

    Info about activity control of instance

  • activityControlOptions object[]
  • activityType string
  • enableAfterADelay boolean
  • enableActivityType boolean
  • security object
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ string
  • userGroupName string
  • advancedPrivacySettings object
  • isPasskeyFeatureEnabled boolean
  • authType string
  • isPrivacyFeatureEnabled boolean
  • passkeySettings object
  • enableAuthorizeForRestore boolean
  • expirationTime object
  • time integer
  • ownerCapabilities object
  • db2Instance object

    Instance specific properties

  • homeDirectory string
  • pureScale boolean
  • userAccount object
  • domainName string
  • userName string
  • DB2StorageDevice object
  • networkAgents integer
  • softwareCompression string
  • throttleNetworkBandwidth integer
  • dataBackupStoragePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • deDuplicationOptions object
  • enableDeduplication boolean
  • generateSignature string
  • logBackupStoragePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • commandLineStoragePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • planEntity object

    Instance plan properties

  • planType integer
  • planName string
  • planSubtype integer
  • planId integer
  • cloudDBInstance object
  • overRideAccessNode boolean
  • accessNodes object
GET /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
InstanceID — path required
propertyLevel — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:InstanceID' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'