List All DB2 MultiNode Instance Backupset Properties
Select
SaaS
Customer Managed
This operation is used to fetch all the backupset 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
- 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
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
backupsetProperties object[]
DB2 MultiNode backupset properties
modifiedTime integerapplicationSize integertotalBackupSize integerlastBackupTime integerfirstBackupTime integerscIdxEnabled integersizeOnMedia integerdedupeRatio integersecurityAssociations object
ownerAssociations objecttagWithCompany object
providerId integerproviderDomainName stringindexSettings object
indexRetCycle integeroverrideIndexPruning integerindexRetDays integerisPruningEnabled integerindexPruningType integercurrentIndexServer objectqualifyingIndexServers object[]
clientId integerclientName stringcontent object[]backupsetSecurity object
associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringadvancedPrivacySettings object
isPasskeyFeatureEnabled booleanauthType integerisPrivacyFeatureEnabled booleanpasskeySettings object
enableAuthorizeForRestore booleanexpirationTime object
time integerownerCapabilities objectdb2BackupSet object
Backup set specific properties
dB2DBStatus integerdB2AutoStorage booleanuseSQLConnect booleandB2CatalogPartitionNumber integerdB2DefaultIndexSP object
storagePolicyName stringstoragePolicyId integerdB2DefaultCommandSP object
storagePolicyName stringstoragePolicyId integerdb2SqlConnectInfo object
userName stringplanEntity object
plan associations to backupset
planType integerplanName stringplanSubtype integerplanId integercommonBackupSet object
common backupset properties
dataMigratorILMCLASS booleannewBackupSetName stringonDemandBackupset booleanslaStatus integerisDeleted booleanisFanInBackupSet booleanisLegalHoldBackupset booleandecompressData booleanisNasTurboBackupSet booleanisArchivingEnabled booleanisWildCardContentBackupSet booleancDRFSDMBackupset booleanuserDescription stringassociatedsubclientPolicy integerisDedupBackupset booleanisMyBackupSet booleansiloCopyId integerisDefaultBackupSet booleanisHidden booleanisMining booleanisUSeDCForBackup booleanbackupSetEntity object
Backupset general properties
clientName stringinstanceName stringbackupsetId integer_type_ integerinstanceId integerbackupsetGUID stringclientId integerappName stringbackupsetName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integer
{
"backupsetProperties": [
{
"modifiedTime": 0,
"applicationSize": 0,
"totalBackupSize": 0,
"lastBackupTime": 0,
"firstBackupTime": 0,
"scIdxEnabled": 0,
"sizeOnMedia": 0,
"dedupeRatio": 0,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "string"
}
},
"indexSettings": {
"indexRetCycle": 0,
"overrideIndexPruning": 0,
"indexRetDays": 0,
"isPruningEnabled": 0,
"indexPruningType": 0,
"currentIndexServer": {},
"qualifyingIndexServers": [
{
"clientId": 0,
"clientName": "string"
}
]
},
"content": [
{}
],
"backupsetSecurity": {
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": 0,
"userGroupName": "string"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": true,
"authType": 0,
"isPrivacyFeatureEnabled": true,
"passkeySettings": {
"enableAuthorizeForRestore": true,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"db2BackupSet": {
"dB2DBStatus": 0,
"dB2AutoStorage": true,
"useSQLConnect": true,
"dB2CatalogPartitionNumber": 0,
"dB2DefaultIndexSP": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"dB2DefaultCommandSP": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"db2SqlConnectInfo": {
"userName": "string"
}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"commonBackupSet": {
"dataMigratorILMCLASS": true,
"newBackupSetName": "string",
"onDemandBackupset": true,
"slaStatus": 0,
"isDeleted": true,
"isFanInBackupSet": true,
"isLegalHoldBackupset": true,
"decompressData": true,
"isNasTurboBackupSet": true,
"isArchivingEnabled": true,
"isWildCardContentBackupSet": true,
"cDRFSDMBackupset": true,
"userDescription": "string",
"associatedsubclientPolicy": 0,
"isDedupBackupset": true,
"isMyBackupSet": true,
"siloCopyId": 0,
"isDefaultBackupSet": true,
"isHidden": true,
"isMining": true,
"isUSeDCForBackup": true
},
"backupSetEntity": {
"clientName": "string",
"instanceName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
}
]
}
{
"backupsetProperties": [
{
"modifiedTime": 1708201251,
"applicationSize": 0,
"totalBackupSize": 0,
"lastBackupTime": 1708201271,
"firstBackupTime": 0,
"scIdxEnabled": 0,
"sizeOnMedia": 0,
"dedupeRatio": 0,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"indexSettings": {
"indexRetCycle": -1,
"overrideIndexPruning": 0,
"indexRetDays": -1,
"isPruningEnabled": 1,
"indexPruningType": 0,
"currentIndexServer": {},
"qualifyingIndexServers": [
{},
{
"clientId": 1227,
"clientName": "vikram-win-man"
}
]
},
"content": [
{}
],
"backupsetSecurity": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": 1,
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"db2BackupSet": {
"dB2DBStatus": 0,
"dB2AutoStorage": false,
"useSQLConnect": false,
"dB2CatalogPartitionNumber": 0,
"dB2DefaultIndexSP": {
"storagePolicyName": "vikram trad dedup regression",
"storagePolicyId": 291
},
"dB2DefaultCommandSP": {
"storagePolicyName": "",
"storagePolicyId": 0
},
"db2SqlConnectInfo": {
"userName": "dpfinst"
}
},
"planEntity": {
"planType": 2,
"planName": "vikram trad dedup regression",
"planSubtype": 33554437,
"planId": 118
},
"commonBackupSet": {
"dataMigratorILMCLASS": false,
"newBackupSetName": "DPFDB",
"onDemandBackupset": false,
"slaStatus": 3,
"isDeleted": false,
"isFanInBackupSet": false,
"isLegalHoldBackupset": false,
"decompressData": false,
"isNasTurboBackupSet": false,
"isArchivingEnabled": false,
"isWildCardContentBackupSet": false,
"cDRFSDMBackupset": false,
"userDescription": "",
"associatedsubclientPolicy": 0,
"isDedupBackupset": false,
"isMyBackupSet": false,
"siloCopyId": 0,
"isDefaultBackupSet": false,
"isHidden": false,
"isMining": false,
"isUSeDCForBackup": false
},
"backupSetEntity": {
"clientName": "vikramdpf",
"instanceName": "dpfinst",
"backupsetId": 8937,
"_type_": 6,
"instanceId": 5419,
"backupsetGUID": "1DAF255C-AE49-403E-B1ED-D62F28BCD292",
"clientId": 1483,
"appName": "DB2 MultiNode",
"backupsetName": "DPFDB",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
}
},
{
"modifiedTime": 1708201828,
"applicationSize": 0,
"totalBackupSize": 0,
"lastBackupTime": 1708201840,
"firstBackupTime": 0,
"scIdxEnabled": 0,
"sizeOnMedia": 0,
"dedupeRatio": 0,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"indexSettings": {
"indexRetCycle": -1,
"overrideIndexPruning": 0,
"indexRetDays": -1,
"isPruningEnabled": 1,
"indexPruningType": 0,
"currentIndexServer": {},
"qualifyingIndexServers": [
{},
{
"clientId": 1227,
"clientName": "vikram-win-man"
}
]
},
"content": [
{}
],
"backupsetSecurity": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": 1,
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"db2BackupSet": {
"dB2DBStatus": 0,
"dB2AutoStorage": false,
"useSQLConnect": false,
"dB2CatalogPartitionNumber": 0,
"dB2DefaultIndexSP": {
"storagePolicyName": "vikram trad dedup regression",
"storagePolicyId": 291
},
"dB2DefaultCommandSP": {
"storagePolicyName": "",
"storagePolicyId": 0
},
"db2SqlConnectInfo": {
"userName": "dpfinst"
}
},
"planEntity": {
"planType": 2,
"planName": "vikram trad dedup regression",
"planSubtype": 33554437,
"planId": 118
},
"commonBackupSet": {
"dataMigratorILMCLASS": false,
"newBackupSetName": "DPF1",
"onDemandBackupset": false,
"slaStatus": 3,
"isDeleted": false,
"isFanInBackupSet": false,
"isLegalHoldBackupset": false,
"decompressData": false,
"isNasTurboBackupSet": false,
"isArchivingEnabled": false,
"isWildCardContentBackupSet": false,
"cDRFSDMBackupset": false,
"userDescription": "",
"associatedsubclientPolicy": 0,
"isDedupBackupset": false,
"isMyBackupSet": false,
"siloCopyId": 0,
"isDefaultBackupSet": false,
"isHidden": false,
"isMining": false,
"isUSeDCForBackup": false
},
"backupSetEntity": {
"clientName": "vikramdpf",
"instanceName": "dpfinst",
"backupsetId": 8938,
"_type_": 6,
"instanceId": 5419,
"backupsetGUID": "C17B3919-F209-4551-8C2F-6DA1B7558075",
"clientId": 1483,
"appName": "DB2 MultiNode",
"backupsetName": "DPF1",
"applicationId": 103,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
}
}
]
}
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
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "User does not have permission on the entity.",
"errorCode": 587205847
}
Loading...