Skip to main content

List All Subclients Of A DB2 MultiNode Instance​

Select

SaaS
Customer Managed

This operation returns a list of SubClients and their properties of a DB2 MultiNode Instance.

Query Parameters
  • clientId integer required

    ID of the DB2 MultiNode Pseudo Client

  • applicationId integer required

    Possible values: [103]

    application ID of DB2 MultiNode is 103

  • instanceId integer required

    Id of the DB2 MultiNode Instance

  • backupsetId integer

    Add Backupset ID of backupset to get subclients only related to this backupset ID

  • propertyLevel integer

    Possible values: [0, 10, 20, 30]

    Higher the property level more properties of subclients are fetched

Responses

OK

Schema
  • filterQueryCount integer
  • subClientProperties object[]

    This object has all properties of the subclient

  • status integer
  • useLocalContent boolean
  • useLocalArchivalRules boolean
  • planEntity object

    plan details of the subclient

  • planType integer
  • planName string
  • planSubtype integer
  • planId integer
  • cassandraProps object
  • planParentEntity object

    parent details of the subclient

  • displayName string
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
  • backupsetId integer
  • backupsetName string
  • taPlanEntity object
  • splunkProps object
  • proxyClient object
  • dcPlanEntity object
  • subClientEntity object

    subclient general properties

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • _type_ integer
  • commCellName string
  • instanceId integer
  • csGUID string
  • subclientGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • subclientName string
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • dfsSubclientProp object
  • region object
  • db2SubclientProp object

    subclient specific properties

  • db2DeleteLogFilesAfterTime integer
  • db2BackupMode integer
  • numberOfBackupStreams integer
  • db2DeleteLogFilesAfter boolean
  • db2BackupLogFiles boolean
  • db2BackupType integer
  • db2BackupData boolean
  • db2DpfStreams string
  • skipLogsInBackupImage integer
  • db2UseDedupeDevice boolean
  • commonProperties object

    common properties of the subclient

  • nextBackupTime integer
  • slaStatus integer
  • isAdAppAwareSubclient boolean
  • disableArchivingTurboRule boolean
  • firstBackupTime integer
  • lastBackupTime integer
  • indexingBackupSubClient boolean
  • allowVssForSnapbackup boolean
  • isActivityDisabledFromPolicy boolean
  • isETCDSubclient boolean
  • enableBackupAfterDelay boolean
  • runAs integer
  • slaCategoryDescription string
  • onBoardCompanyId integer
  • sizeOnMedia integer
  • enableBackup boolean
  • encryptionFlag integer
  • numberOfBackupStreams integer
  • idaType integer
  • isKeepItemPastExpiryTime boolean
  • runTrueUpJobAfterDays integer
  • totalBackupSize integer
  • isDefaultSubclient boolean
  • dedupeRatio integer
  • isTrueUpOptionEnabled boolean
  • slaCategory integer
  • subClientPropertiesFlag integer
  • lastBackupSize integer
  • securityAssociations object
  • ownerAssociations object
  • tagWithCompany object
  • providerId integer
  • providerDomainName string
  • associatedSnapShotSCId object
  • _type_ integer
  • snapCopyInfo object

    snap details of the subclient

  • IsOracleSposDriverEnabled boolean
  • isRMANEnableForTapeMovement boolean
  • useProxyForSQLIntegrity object
  • sybaseUser object
  • snapToTapeSelectedEngine object
  • _type_ integer
  • sqlUser object
  • vmApplicationUser object
  • snapToTapeProxyToUse object
  • _type_ integer
  • quiesceImpersonateUser object
  • separateProxyForSnapToTape object
  • _type_ integer
  • sshKey object
  • configuredSybaseInstance object
  • _type_ integer
  • subclientPolicy object
  • _type_ integer
  • subclientPolicyName string
  • impersonateUserCredentialinfo object
  • credentialId integer
  • credentialName string
  • enableBackupAtDateTime object
  • TimeZoneID integer
  • time integer
  • turboNASClient object
  • _type_ integer
  • prepostProcess object
  • runPostScan integer
  • runPostBackup integer
  • runPostLog integer
  • prepostUserName object
  • security object
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • advancedPrivacySettings object
  • isPasskeyFeatureEnabled boolean
  • authType integer
  • isPrivacyFeatureEnabled boolean
  • passkeySettings object
  • enableAuthorizeForRestore boolean
  • expirationTime object
  • time integer
  • ownerCapabilities object
  • storageDevice object
  • networkAgents integer
  • softwareCompression integer
  • throttleNetworkBandwidth integer
  • dataBackupStoragePolicy object
  • _type_ integer
  • storagePolicyName string
  • storagePolicyId integer
  • deDuplicationOptions object
  • enableDeduplication boolean
  • generateSignature integer
  • logBackupStoragePolicy object
  • _type_ integer
  • storagePolicyName string
  • storagePolicyId integer
  • performanceMode object
  • perfSPName string
  • multiplexingValid boolean
  • enableMultiplexing boolean
  • perfCopyName string
  • perfClientName string
  • streamsOverMux boolean
  • pipelineBufferSize integer
  • numOfPipelineBuffers integer
  • muxFactor integer
  • lookAheadReaderSlots integer
  • perfCRCDetails object[]
  • crcOverMedia boolean
  • perfMaId integer
  • crcOverNetwork boolean
  • perfMa string
  • UNCScriptCredentialinfo object
  • credentialId integer
  • credentialName string
  • vmBackupValidationSettings object
  • isAppValidationEnabled boolean
  • backupValidationThreadCount integer
  • subTaskId integer
  • isCustomAppEnabled boolean
  • runAsDevTestGroup boolean
  • taskId integer
  • useSourceVMEsxToMount boolean
  • uncScriptImpersonateUser object
  • userName string
  • prepostCredentialinfo object
  • credentialId integer
  • credentialName string
  • associatedPolicy object
  • subclientPolicyId integer
  • guestCredentialinfo object
  • credentialId integer
  • credentialName string
  • allowMultipleDataReaders boolean
  • lastBackupJobInfo object
  • jobID integer
  • failureReasonIds string
  • commCellID integer
  • failureReasonMessageEnglish string
  • status integer
  • startTime object
  • time integer
  • endTime object
  • time integer
  • analyticsSubclientProp object
  • content object[]
  • db2Content object
  • db2TableSpace string
  • db2DataFile string
GET /subclient

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
instanceId — query required
backupsetId — query
propertyLevel — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'