Loading...

REST API - GET Deduplication Database Details

This operation returns the details of a deduplication database (DDB) and its partitions.

Request

Syntax

GET <webservice>/DDBInformation/{ddbStoreId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

ddbStoreId

The system-generated ID of the deduplication database (DDB).

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

commcellId

The CommCell ID for the DDB partition that indicates to which CommCell environment the partition belongs to. This ID applies to CommCell migration.

SubStoreList

timeTakeForRecovery

The time that the DDB reconstruction job takes to complete.

SubStoreList

offlineReason

The reason that the partition is marked offline.

SubStoreList

PruneArchiveFilesAvgTime

The average time that pruning archived files takes.

SubStoreList

maxSIDBPrimaryRecords

The number of primary records in the DDB partition.

SubStoreList

flags

Bit flags for DDB partition.

SubStoreList

freeDiskSpaceMB

The total amount of free space that is available in the volume that the DDB is configured on.

SubStoreList

sottstateaccesspath

Indicates whether the DDB path is accessible by the Commvault service.

SubStoreList

lastSnapTime

The timestamp when the most recent DDB backup completed successfully.

SubStoreList

subStoreClientVersion

The version of the Commvault software that is on the DDB MediaAgent.

SubStoreList

backupInterval

The time interval that DDB backups run at.

SubStoreList

NumRowToPrune

The number of pending rows to prune from the DDB partition.

SubStoreList

maxSIDBAverageQITime

The average query and insertion time for the DDB partition.

SubStoreList

subStoreId

The system-generated ID of the deduplication database partition.

SubStoreList

otherDataMB

 

SubStoreList

SizeOccupied

The amount of space that is occupied by the DDB on the disk.

SubStoreList

Path

The location of the DDB on a MediaAgent.

SubStoreList

DDBManagedSize

The amount of space that is occupied by the backed-up data that is managed by the DDB.

SubStoreList

maxNumOfAFsInSecFile

The maximum number of archive files that are allowed in a DDB secondary file.

SubStoreList

lastRecoveryTime

The timestamp when the most recent DDB reconstruction completed successfully.

SubStoreList

usedSpace

 

SubStoreList

totalCapacity

The total capacity of the volume that the DDB is on.

SubStoreList

avgQITime

The average query and insert time for the deduplication database partition.

SubStoreList

storeId

The system-generated ID of the DDB.

SubStoreList

consumedDataMB

 

SubStoreList

lastSnapJobId

The job ID of the most recent snapshot.

SubStoreList

PrimaryEntries

 

SubStoreList

DiskFreeWarningThresholdMB

The amount of free space on the volume that the DDB is on at which the MediaAgents (Disk Space Low) warning is generated, if configured.

SubStoreList

lastCorruptionTime

The time when the DDB partition was most recently corrupted.

SubStoreList

status

The online or offline status of the deduplication database partition.

SubStoreList

softstate

 

SubStoreList

name

The name of the MediaAgent.

MediaAgent

id

The system-generated ID of the MediaAgent.

MediaAgent

pendingDelRecords

The number of records in the DDB that the dedup blocks are ready to be pruned for.

maxValuesSubStoreStats

avgQITime

The average query and insertion time for the deduplication database partition.

maxValuesSubStoreStats

uniqueBlocks

The number of unique blocks that are managed by the partition.

maxValuesSubStoreStats

secondaryBlocks

The number of secondary blocks that are managed by the partition.

maxValuesSubStoreStats

connections

The total number of connections (jobs such as regular backup jobs, auxiliary copy jobs, recovery jobs, and pruning) that are accessed by this partition.

maxValuesSubStoreStats

pendingDelRecords

The number of records in the DDB that the dedup blocks are ready to be pruned for.

minValuesSubStoreStats

avgQITime

The average query and insertion time for the deduplication database partition.

minValuesSubStoreStats

uniqueBlocks

The number of unique blocks that are accessed by the partition.

minValuesSubStoreStats

secondaryBlocks

The number of secondary blocks that are accessed by the partition.

minValuesSubStoreStats

connections

The total number of connections (jobs such as regular backup jobs, auxiliary copy jobs, recovery jobs, and pruning) that are accessed by this partition.

minValuesSubStoreStats

uniqueBlocksOfStore

The number of unique blocks that are accessed by the partition.

dedupDBDetails

comcellId

The system-generated ID for the CommCell environment.

dedupDBDetails

maxAllowedConnections

The maximum number of connections that are allowed by the DDB.

dedupDBDetails

numberofJobs

The total number of jobs that are associated with the DDB.

dedupDBDetails

storeNameAlias

The Alias of the DDB store.

dedupDBDetails

dedupFlags

Bit flags for the DDB.

dedupDBDetails

baselineApplicationSize

The size of baseline application data.

dedupDBDetails

fragmentedSpaceSize

 

dedupDBDetails

baselineSize

The amount of space that is required on the disk for a new backup data when the existing DDB is sealed.

dedupDBDetails

totalDataSize

The total size of data in the DDB.

dedupDBDetails

storeName

The name of the DDB store.

dedupDBDetails

ddbVersion

The software version of the DDB.

dedupDBDetails

freeSpaceOnLibrary

The amount of free space on the disk that hosts the DDB.

dedupDBDetails

totalAppSize

The total size of application data in the DDB.

dedupDBDetails

primaryRecordsPercentage

The percentage of primary records in the DDB.

dedupDBDetails

prunePending

 

dedupDBDetails

deDupSavingPercent

The percentage of deduplication savings in the DDB.

dedupDBDetails

noOfPartitions

The total number of partitions in the DDB.

dedupDBDetails

storeFlags

 

dedupDBDetails

retentionCyclesForCopy

The retention cycles for the copies.

dedupDBDetails

storeId

The system-generated ID of the DDB.

dedupDBDetails

reservedField6

 

dedupDBDetails

reservedField

 

dedupDBDetails

reservedField8

 

dedupDBDetails

deDupSavingSize

The size of deduplication savings.

dedupDBDetails

sizeOnMedia

The size of the DDB in the media.

dedupDBDetails

sealedTime

If the DDB was sealed, the time it was sealed.

dedupDBDetails

maxAvgQITime

The maximum average query and insert time for the DDB.

dedupDBDetails

creationtime

The time when the DDB was created.

dedupDBDetails

avgQITimeOfStore

The average query and insertion time for the DDB.

dedupDBDetails

reserveField1

 

dedupDBDetails

extendedFlags

 

dedupDBDetails

reserveField2

 

dedupDBDetails

reserveField3

 

dedupDBDetails

reserveField4

 

dedupDBDetails

retentionDaysForCopy

The retention days for the copy.

dedupDBDetails

reserveField5

 

dedupDBDetails

status

The status of the DDB.

dedupDBDetails

EnableTimeZone

Enable time zone for pruning.

enablePruningTime

EnableTime

Enable time for pruning.

enablePruningTime

type

The type of the storage policy.

storagePolicy

storagePolicyName

The name of the storage policy.

storagePolicy

storagePolicyId

The system-generated ID of the storage policy.

storagePolicy

Examples

Sample Request

GET <webservice>/CommCell/DDBInformation/60
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{
"dedupDBInfo": {
"subStoreList": [
{
"commcellId": 2,
"timeTakenForRecovery": 6783,
"offlineReason": "The active DDB of current storage policy copy is not available to use.",
"PruneArchiveFilesAvgTime": 0,
"maxSIDBPrimaryRecords": 1000000000,
"flags": 580063250,
"freeDiskSpaceMB": 98894,
"softstateaccesspath": 0,
"lastSnapTime": 1581489296,
"subStoreClientVersion": 0,
"backupInterval": 0,
"NumRowToPrune": 0,
"maxSIDBAverageQITime": 2000,
"subStoreId": 123,
"otherDataMB": 834,
"SizeOccupied": 280,
"Path": "E:\\ddb\\dedupe_storage_pool\\1\\Files\\60",
"DDBManagedSize": 3347,
"maxNumOfAFsInSecFile": 0,
"lastRecoveryTime": 1584523830,
"usedSpace": 0,
"totalCapacityMB": 99999,
"avgQITime": 0,
"storeId": 60,
"consumedDataMB": 271,
"lastSnapJobId": 314144,
"PrimaryEntries": 20045,
"DiskFreeWarningThreshholdMB": 10240,
"DiskFreeThresholdMB": 5120,
"lastCorruptionTime": 0,
"status": 1,
"softstate": 1,
"MediaAgent": {
"name": "flash",
"id": 2
},
"maxValuesSubStoreStats": {
"pendingDelRecords": 0,
"avgQITime": 0,
"uniqueBlocks": 0,
"secondaryBlocks": 0,
"connections": 0
},
"minValuesSubStoreStats": {
"pendingDelRecords": 0,
"avgQITime": 0,
"uniqueBlocks": 0,
"secondaryBlocks": 0,
"connections": 0
}
}
],
"dedupDBDetails": {
"uniqueBlocksOfStore": 0,
"commcellId": 2,
"maxAllowedConnections": 200,
"numberOfJobs": 4,
"storeNameAlias": "Dedupe_StoragePool_Files_60",
"dedupeFlags": 378273792,
"baselineApplicationSize": 0,
"fragmentedSpaceSize": 22,
"baselineSize": 0,
"totalDataSize": 3509583872,
"storeName": "Dedupe_StoragePool_Files_60",
"ddbVersion": 11,
"freeSpaceOnLibrary": 0,
"totalAppSize": 30243933,
"primaryRecordsPercentage": 0,
"prunePending": 0,
"deDupSavingPercent": "",
"noOfPartitions": 1,
"storeFlags": 580059154,
"retentionCyclesForCopy": 0,
"storeId": 60,
"reserveField6": 0,
"reserveField7": "0 of 1 partitions online",
"reserveField8": "",
"deDupSavingSize": 969800,
"sizeOnMedia": 3509583872,
"sealedTime": 0,
"maxAvgQITime": 0,
"creationtime": 1580708794,
"avgQITimeOfStore": 0,
"reserveField1": 0,
"extendedFlags": 14,
"reserveField2": 0,
"reserveField3": "",
"reserveField4": 1580880619,
"retentionDaysForCopy": 0,
"reserveField5": 1580880619,
"status": 1,
"enablePruningTime": {
"EnableTimeZone": 0,
"EnableTime": 0
}
},
"storagePolicy": {
"_type_": 17,
"storagePolicyName": "Dedupe_StoragePool",
"storagePolicyId": 55
}
}
}

Last modified: 9/10/2020 5:06:49 AM