Skip to main content

List All DB2 Instances​

Select

SaaS
Customer Managed

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

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
  • instanceActivityControl object

    instance activity control details

  • activityControlOptions object[]
  • activityType integer
  • enableAfterADelay boolean
  • enableActivityType boolean
  • db2Instance object

    instance specific properties

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

    plan details of the instance

  • planType integer
  • planName string
  • planSubtype integer
  • planId integer
GET /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

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