Get PostgreSQL database group properties
This operation is used to get database group properties
Path Parameters
- subclientId string required
ID of database group
Responses
- 200
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Dumpbased backupset Database group properties
- F S Based backupset Database group properties with Snap backup properties enabled
Schema
subClientProperties object[]
status integeruseLocalContent booleanuseLocalArchivalRules booleancanChangeEncryptionSetting booleanplanEntity object
planType integerplanName stringPlan Name
planSubtype integerplanId integerPlan ID
cassandraProps objecttaPlanEntity objectpostgreSQLSubclientProp object
subclientTypeFlag integernumberOfBackupStreams integerNumber of streams to be used for backup and restore
collectObjectListDuringBackup booleanFlag to determine Object list collection during backup
splunkProps objectproxyClient objectProxy client Name
dcPlanEntity objectsubClientEntity object
clientName stringClient Name
instanceName stringInstance Name
displayName stringbackupsetId integerBackupset ID
_type_ integercommCellName stringinstanceId integerInstance ID
csGUID stringsubclientGUID stringsubclientId integerSubclient ID
clientId integerClient ID
appName stringDefault value:
PostgreSQL
Application Name
backupsetName stringBackupset Name
applicationId integerApplication ID
subclientName stringSubclient Name
entityInfo object
companyId integercompanyName stringmultiCommcellId integerdfsSubclientProp objectregion objectcontent object[]
postgreSQLContent object
databaseName stringPostgreSQL database which is part of Database Group content
creationTime integerdatabaseSize integerPostgreSQL database size
commonProperties object
nextBackupTime integerslaStatus integerisAdAppAwareSubclient booleandisableArchivingTurboRule booleanfirstBackupTime integerlastBackupTime integerindexingBackupSubClient booleanallowVssForSnapbackup booleanisActivityDisabledFromPolicy booleanisETCDSubclient booleanenableBackupAfterDelay booleanrunAs integerslaCategoryDescription stringonBoardCompanyId integersizeOnMedia integerenableBackup booleanencryptionFlag integernumberOfBackupStreams integerNumber of backup streams to use
idaType integerrunTrueUpJobAfterDays integertotalBackupSize integerdedupeRatio integerisTrueUpOptionEnabled booleanslaCategory integersubClientPropertiesFlag integerlastBackupSize integerallowMultipleDataReaders booleansecurityAssociations object
ownerAssociations objecttagWithCompany object
providerId integerproviderDomainName stringassociatedSnapShotSCId object
_type_ integersnapCopyInfo object
IsOracleSposDriverEnabled booleanisRMANEnableForTapeMovement booleanuseProxyForSQLIntegrity objectsybaseUser objectsnapToTapeSelectedEngine object
Snap engine name
_type_ integersqlUser objectvmApplicationUser objectsnapToTapeProxyToUse object
Proxy machine to use for backup
_type_ integerquiesceImpersonateUser objectseparateProxyForSnapToTape object
_type_ integersshKey objectconfiguredSybaseInstance object
_type_ integersubclientPolicy object
_type_ integersubclientPolicyName stringimpersonateUserCredentialinfo object
credentialId integercredentialName stringenableBackupAtDateTime object
TimeZoneID integertime integerturboNASClient object
_type_ integerprepostProcess object
runPostScan integerrunPostBackup integerrunAs integerrunPostLog integerprepostUserName objectsecurity object
associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringadvancedPrivacySettings object
isPasskeyFeatureEnabled booleanauthType integerisPrivacyFeatureEnabled booleanpasskeySettings object
enableAuthorizeForRestore booleanexpirationTime object
time integerownerCapabilities objectstorageDevice object
networkAgents integersoftwareCompression integerthrottleNetworkBandwidth integerdataBackupStoragePolicy object
_type_ integerstoragePolicyName stringstoragePolicyId integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature integerlogBackupStoragePolicy object
_type_ integerstoragePolicyName stringLog backup storage policy name
storagePolicyId integerperformanceMode object
perfSPName stringmultiplexingValid booleanenableMultiplexing booleanperfCopyName stringperfClientName stringstreamsOverMux booleanpipelineBufferSize integernumOfPipelineBuffers integermuxFactor integerlookAheadReaderSlots integerperfCRCDetails object[]
crcOverMedia booleanperfMaId integercrcOverNetwork booleanperfMa stringUNCScriptCredentialinfo object
credentialId integercredentialName stringvmBackupValidationSettings object
isAppValidationEnabled booleanbackupValidationThreadCount integersubTaskId integerisCustomAppEnabled booleanrunAsDevTestGroup booleantaskId integeruseSourceVMEsxToMount booleanuncScriptImpersonateUser object
userName stringprepostCredentialinfo object
credentialId integercredentialName stringassociatedPolicy object
subclientPolicyId integerguestCredentialinfo object
credentialId integercredentialName stringanalyticsSubclientProp object
{
"subClientProperties": [
{
"status": 0,
"useLocalContent": true,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": true,
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cassandraProps": {},
"taPlanEntity": {},
"postgreSQLSubclientProp": {
"subclientTypeFlag": 0,
"numberOfBackupStreams": 0,
"collectObjectListDuringBackup": true
},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"csGUID": "string",
"subclientGUID": "string",
"subclientId": 0,
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"region": {},
"content": [
{
"postgreSQLContent": {
"databaseName": "string",
"creationTime": 0,
"databaseSize": 0
}
}
],
"commonProperties": {
"nextBackupTime": 0,
"slaStatus": 0,
"isAdAppAwareSubclient": true,
"disableArchivingTurboRule": true,
"firstBackupTime": 0,
"lastBackupTime": 0,
"indexingBackupSubClient": true,
"allowVssForSnapbackup": true,
"isActivityDisabledFromPolicy": true,
"isETCDSubclient": true,
"enableBackupAfterDelay": true,
"runAs": 0,
"slaCategoryDescription": "string",
"onBoardCompanyId": 0,
"sizeOnMedia": 0,
"enableBackup": true,
"encryptionFlag": 0,
"numberOfBackupStreams": 0,
"idaType": 0,
"runTrueUpJobAfterDays": 0,
"totalBackupSize": 0,
"dedupeRatio": 0,
"isTrueUpOptionEnabled": true,
"slaCategory": 0,
"subClientPropertiesFlag": 0,
"lastBackupSize": 0,
"allowMultipleDataReaders": true,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "string"
}
},
"associatedSnapShotSCId": {
"_type_": 0
},
"snapCopyInfo": {
"IsOracleSposDriverEnabled": true,
"isRMANEnableForTapeMovement": true,
"useProxyForSQLIntegrity": {},
"sybaseUser": {},
"snapToTapeSelectedEngine": {
"_type_": 0
},
"sqlUser": {},
"vmApplicationUser": {},
"snapToTapeProxyToUse": {
"_type_": 0
},
"quiesceImpersonateUser": {},
"separateProxyForSnapToTape": {
"_type_": 0
},
"sshKey": {},
"configuredSybaseInstance": {
"_type_": 0
}
},
"subclientPolicy": {
"_type_": 0,
"subclientPolicyName": "string"
},
"impersonateUserCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
},
"enableBackupAtDateTime": {
"TimeZoneID": 0,
"time": 0
},
"turboNASClient": {
"_type_": 0
},
"prepostProcess": {
"runPostScan": 0,
"runPostBackup": 0,
"runAs": 0,
"runPostLog": 0,
"prepostUserName": {}
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": 0,
"userGroupName": "string"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": true,
"authType": 0,
"isPrivacyFeatureEnabled": true,
"passkeySettings": {
"enableAuthorizeForRestore": true,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"storageDevice": {
"networkAgents": 0,
"softwareCompression": 0,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"_type_": 0,
"storagePolicyName": "string",
"storagePolicyId": 0
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 0
},
"logBackupStoragePolicy": {
"_type_": 0,
"storagePolicyName": "string",
"storagePolicyId": 0
},
"performanceMode": {
"perfSPName": "string",
"multiplexingValid": true,
"enableMultiplexing": true,
"perfCopyName": "string",
"perfClientName": "string",
"streamsOverMux": true,
"pipelineBufferSize": 0,
"numOfPipelineBuffers": 0,
"muxFactor": 0,
"lookAheadReaderSlots": 0,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 0,
"crcOverNetwork": true,
"perfMa": "string"
}
]
}
},
"UNCScriptCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
},
"vmBackupValidationSettings": {
"isAppValidationEnabled": true,
"backupValidationThreadCount": 0,
"subTaskId": 0,
"isCustomAppEnabled": true,
"runAsDevTestGroup": true,
"taskId": 0,
"useSourceVMEsxToMount": true,
"uncScriptImpersonateUser": {
"userName": "string"
}
},
"prepostCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
},
"associatedPolicy": {
"subclientPolicyId": 0
},
"guestCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
}
},
"analyticsSubclientProp": {}
}
]
}
{
"subClientProperties": [
{
"status": 0,
"useLocalContent": false,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": false,
"planEntity": {
"planType": 2,
"planName": "GK_NEW_DB_OPTION_TEST",
"planSubtype": 33554437,
"planId": 57
},
"cassandraProps": {},
"taPlanEntity": {},
"postgreSQLSubclientProp": {
"subclientTypeFlag": 0,
"numberOfBackupStreams": 1,
"collectObjectListDuringBackup": false
},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "gkstandby3_3",
"instanceName": "gk_nisha",
"displayName": "gkstandby3_3",
"backupsetId": 8141,
"_type_": 7,
"commCellName": "dbcs",
"instanceId": 4995,
"csGUID": "DDCEE9FA-7E8C-4C25-AEE2-D498FFA7445B",
"subclientGUID": "8FB9053C-E759-44A5-9D8D-5CC34B7327A0",
"subclientId": 14957,
"clientId": 1296,
"appName": "PostgreSQL",
"backupsetName": "DumpBasedBackupSet",
"applicationId": 125,
"subclientName": "test",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"region": {},
"content": [
{
"postgreSQLContent": {
"databaseName": "/postgres",
"creationTime": 0,
"databaseSize": 0
}
},
{
"postgreSQLContent": {
"databaseName": "/template1",
"creationTime": 0,
"databaseSize": 0
}
}
],
"commonProperties": {
"nextBackupTime": 0,
"slaStatus": 3,
"isAdAppAwareSubclient": false,
"disableArchivingTurboRule": false,
"firstBackupTime": 0,
"lastBackupTime": 0,
"indexingBackupSubClient": false,
"allowVssForSnapbackup": false,
"isActivityDisabledFromPolicy": false,
"isETCDSubclient": false,
"enableBackupAfterDelay": false,
"runAs": 0,
"slaCategoryDescription": "Recently Installed with No Finished Job",
"onBoardCompanyId": 0,
"sizeOnMedia": 0,
"enableBackup": true,
"encryptionFlag": 2,
"numberOfBackupStreams": 1,
"idaType": 0,
"runTrueUpJobAfterDays": 30,
"totalBackupSize": 0,
"dedupeRatio": 0,
"isTrueUpOptionEnabled": false,
"slaCategory": 10,
"subClientPropertiesFlag": 0,
"lastBackupSize": 0,
"allowMultipleDataReaders": true,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"associatedSnapShotSCId": {
"_type_": 7
},
"snapCopyInfo": {
"IsOracleSposDriverEnabled": false,
"isRMANEnableForTapeMovement": false,
"useProxyForSQLIntegrity": {},
"sybaseUser": {},
"snapToTapeSelectedEngine": {
"_type_": 110
},
"sqlUser": {},
"vmApplicationUser": {},
"snapToTapeProxyToUse": {
"_type_": 3
},
"quiesceImpersonateUser": {},
"separateProxyForSnapToTape": {
"_type_": 3
},
"sshKey": {},
"configuredSybaseInstance": {
"_type_": 5
}
},
"subclientPolicy": {
"_type_": 65,
"subclientPolicyName": ""
},
"impersonateUserCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"enableBackupAtDateTime": {
"TimeZoneID": 0,
"time": 0
},
"turboNASClient": {
"_type_": 3
},
"prepostProcess": {
"runPostScan": 0,
"runPostBackup": 0,
"runAs": 1,
"runPostLog": 0,
"prepostUserName": {}
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": 1,
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"storageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "GK_NEW_DB_OPTION_TEST",
"storagePolicyId": 169
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "GK_NEW_DB_OPTION_TEST",
"storagePolicyId": 169
},
"performanceMode": {
"perfSPName": "GK_NEW_DB_OPTION_TEST",
"multiplexingValid": true,
"enableMultiplexing": false,
"perfCopyName": "Primary",
"perfClientName": "gkstandby3_3",
"streamsOverMux": false,
"pipelineBufferSize": 64,
"numOfPipelineBuffers": 180,
"muxFactor": 0,
"lookAheadReaderSlots": 4,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 2,
"crcOverNetwork": true,
"perfMa": "dbcs"
}
]
}
},
"UNCScriptCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"vmBackupValidationSettings": {
"isAppValidationEnabled": false,
"backupValidationThreadCount": 0,
"subTaskId": 0,
"isCustomAppEnabled": false,
"runAsDevTestGroup": false,
"taskId": 0,
"useSourceVMEsxToMount": false,
"uncScriptImpersonateUser": {
"userName": "0"
}
},
"prepostCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"associatedPolicy": {
"subclientPolicyId": 0
},
"guestCredentialinfo": {
"credentialId": 0,
"credentialName": ""
}
},
"analyticsSubclientProp": {}
}
]
}
{
"subClientProperties": [
{
"status": 8,
"useLocalContent": false,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": false,
"planEntity": {},
"cassandraProps": {},
"taPlanEntity": {},
"postgreSQLSubclientProp": {
"subclientTypeFlag": 3,
"numberOfBackupStreams": 1,
"collectObjectListDuringBackup": false
},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "pgtestwindows_1",
"instanceName": "pgtestwindows_1_5594",
"displayName": "pgtestwindows_1",
"backupsetId": 3865,
"_type_": 7,
"commCellName": "dbcs",
"instanceId": 3411,
"csGUID": "DDCEE9FA-7E8C-4C25-AEE2-D498FFA7445B",
"subclientGUID": "94D3278B-2591-49EF-8A4A-162A2E2C5F16",
"subclientId": 6696,
"clientId": 53,
"appName": "PostgreSQL",
"backupsetName": "FSBasedBackupSet",
"applicationId": 125,
"subclientName": "default",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"region": {},
"commonProperties": {
"nextBackupTime": 0,
"slaStatus": 2,
"isAdAppAwareSubclient": false,
"disableArchivingTurboRule": false,
"firstBackupTime": 0,
"lastBackupTime": 0,
"indexingBackupSubClient": false,
"allowVssForSnapbackup": false,
"isActivityDisabledFromPolicy": false,
"isETCDSubclient": false,
"enableBackupAfterDelay": false,
"runAs": 0,
"slaCategoryDescription": "No Schedule",
"onBoardCompanyId": 0,
"sizeOnMedia": 0,
"enableBackup": true,
"encryptionFlag": 2,
"numberOfBackupStreams": 1,
"idaType": 0,
"runTrueUpJobAfterDays": 30,
"totalBackupSize": 0,
"isDefaultSubclient": true,
"dedupeRatio": 0,
"isTrueUpOptionEnabled": false,
"slaCategory": 4,
"subClientPropertiesFlag": 0,
"lastBackupSize": 0,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"associatedSnapShotSCId": {
"_type_": 7
},
"snapCopyInfo": {
"useSeparateProxyForSnapToTape": false,
"isSnapBackupEnabled": true,
"IsOracleSposDriverEnabled": false,
"isRMANEnableForTapeMovement": false,
"useProxyForSQLIntegrity": {},
"sybaseUser": {},
"snapToTapeSelectedEngine": {
"_type_": 110,
"snapShotEngineId": 3,
"snapShotEngineName": "NetApp"
},
"sqlUser": {},
"vmApplicationUser": {},
"snapToTapeProxyToUse": {
"clientId": 0,
"_type_": 3
},
"quiesceImpersonateUser": {},
"separateProxyForSnapToTape": {
"_type_": 3
},
"sshKey": {},
"configuredSybaseInstance": {
"_type_": 5
}
},
"subclientPolicy": {
"_type_": 65,
"subclientPolicyName": ""
},
"lastBackupJobInfo": {
"jobID": 3401908,
"failureReasonIds": "1418833,1418828,",
"commCellID": 2,
"failureReasonMessageEnglish": "Killed by admin. Reason:[].<br>Source: dbcs, Process: JobManager\nDevice not found : [getVolumeInfo failed: Unable to get the volume/device information corresponding to mount point []. Error:[] (MM.60604)]<br>Source: pgtestwindows_1, Process: PostGresBackup",
"status": 4,
"startTime": {
"time": 1693511418
},
"endTime": {
"time": 1693511681
}
},
"impersonateUserCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"enableBackupAtDateTime": {
"TimeZoneID": 0,
"time": 0
},
"turboNASClient": {
"_type_": 3
},
"prepostProcess": {
"runPostScan": 0,
"runPostBackup": 0,
"runPostLog": 0,
"prepostUserName": {}
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": 1,
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"storageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "GK_POLICY",
"storagePolicyId": 19
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "GK_POLICY",
"storagePolicyId": 19
},
"performanceMode": {
"perfSPName": "GK_POLICY",
"multiplexingValid": true,
"enableMultiplexing": false,
"perfCopyName": "Primary",
"perfClientName": "pgtestwindows_1",
"streamsOverMux": false,
"pipelineBufferSize": 64,
"numOfPipelineBuffers": 180,
"muxFactor": 0,
"lookAheadReaderSlots": 4,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 2,
"crcOverNetwork": true,
"perfMa": "dbcs"
}
]
}
},
"UNCScriptCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"vmBackupValidationSettings": {
"isAppValidationEnabled": false,
"backupValidationThreadCount": 0,
"subTaskId": 0,
"isCustomAppEnabled": false,
"runAsDevTestGroup": false,
"taskId": 0,
"useSourceVMEsxToMount": false,
"uncScriptImpersonateUser": {
"userName": "0"
}
},
"prepostCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"associatedPolicy": {
"subclientPolicyId": 0
},
"guestCredentialinfo": {
"credentialId": 0,
"credentialName": ""
}
},
"analyticsSubclientProp": {}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Input XML has invalid subclient name in association.",
"errorCode": 587204334
}
Loading...