Skip to main content

Fetch all Backupsets of a DB2 Instance​

Select

SaaS
Customer Managed

This operation returns a list of all backup sets and their properties of a DB2 Instance.

Query Parameters
  • clientId integer required

    ID of the client

  • applicationId integer required

    Possible values: [62, 37]

    Application ID for DB2 Unix is 62 and application ID for DB2 windows is 37

  • instanceId integer required

    ID of the DB2 Instance

  • propertyLevel integer

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

    Higher the property level more properties of Backupset are fetched

  • excludeHidden integer

    Possible values: [0, 1]

    Default value: 1

    Pass 1 to hide default dummy backupset

Responses

OK

Schema
  • backupsetProperties object[]

    DB2 backupset properties

  • modifiedTime integer
  • applicationSize integer
  • totalBackupSize integer
  • lastBackupTime integer
  • firstBackupTime integer
  • scIdxEnabled integer
  • sizeOnMedia integer
  • dedupeRatio integer
  • securityAssociations object
  • ownerAssociations object
  • tagWithCompany object
  • providerId integer
  • providerDomainName string
  • indexSettings object
  • indexRetCycle integer
  • overrideIndexPruning integer
  • indexRetDays integer
  • isPruningEnabled integer
  • indexPruningType integer
  • currentIndexServer object
  • qualifyingIndexServers object[]
  • clientId integer
  • clientName string
  • content object[]
  • backupsetSecurity 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
  • db2BackupSet object

    Backup set specific properties

  • dB2DBStatus integer
  • dB2AutoStorage boolean
  • useSQLConnect boolean
  • dB2CatalogPartitionNumber integer
  • dB2DefaultIndexSP object
  • storagePolicyName string
  • storagePolicyId integer
  • dB2DefaultCommandSP object
  • storagePolicyName string
  • storagePolicyId integer
  • db2SqlConnectInfo object
  • userName string
  • planEntity object

    plan associations to backupset

  • planType integer
  • planName string
  • planSubtype integer
  • planId integer
  • commonBackupSet object

    common backupset properties

  • dataMigratorILMCLASS boolean
  • newBackupSetName string
  • onDemandBackupset boolean
  • slaStatus integer
  • isDeleted boolean
  • isFanInBackupSet boolean
  • isLegalHoldBackupset boolean
  • decompressData boolean
  • isNasTurboBackupSet boolean
  • isArchivingEnabled boolean
  • isWildCardContentBackupSet boolean
  • cDRFSDMBackupset boolean
  • userDescription string
  • associatedsubclientPolicy integer
  • isDedupBackupset boolean
  • isMyBackupSet boolean
  • siloCopyId integer
  • isDefaultBackupSet boolean
  • isHidden boolean
  • isMining boolean
  • isUSeDCForBackup boolean
  • backupSetEntity object

    Backupset general properties

  • clientName string
  • instanceName string
  • backupsetId integer
  • _type_ integer
  • instanceId integer
  • backupsetGUID string
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
Loading...