Get PostgreSQL backupset properties
Select
SaaS
Customer Managed
This operation is used to get backupset properties
Path Parameters
- backupsetId string required
backupsetId of the PostgreSQL Backupset
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
backupsetProperties object[]
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 objectplanEntity object
planType integerplanName stringPlan name
planSubtype integerplanId integerPlan ID
commonBackupSet object
dataMigratorILMCLASS booleannewBackupSetName stringonDemandBackupset booleanslaStatus integerisDeleted booleanisFanInBackupSet booleanisLegalHoldBackupset booleandecompressData booleanisNasTurboBackupSet booleanisArchivingEnabled booleanisWildCardContentBackupSet booleancDRFSDMBackupset booleanuserDescription stringassociatedsubclientPolicy integerisDedupBackupset booleanisMyBackupSet booleansiloCopyId integerisDefaultBackupSet booleanisHidden booleanisMining booleanisUSeDCForBackup booleanbackupSetEntity object
clientName stringClient Name
instanceName stringInstance Name
displayName stringbackupsetId integerBackupset ID
_type_ integerinstanceId integerInstance ID
backupsetGUID stringclientId integerClient ID
appName stringDefault value:
PostgreSQL
backupsetName stringBackupset Name
applicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerpostGresBackupSetProps object
enableGlobalObjectsBkp booleanFlag to determine if Global object backup is enabled or not
parallelDumpOpt object
enableParallelDump booleanFlag to determine if Pa backup is enabled or not
jobs integerNumber of parallel backup jobs
stagingPath stringStaging directory path for Parallel dump backup
{
"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": {}
},
"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",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"backupsetGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"backupsetName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"postGresBackupSetProps": {
"enableGlobalObjectsBkp": true,
"parallelDumpOpt": {
"enableParallelDump": true,
"jobs": 0,
"stagingPath": "string"
}
}
}
]
}
{
"backupsetProperties": [
{
"modifiedTime": 1711365297,
"applicationSize": 0,
"totalBackupSize": 0,
"lastBackupTime": 0,
"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": 4,
"clientName": "mysqlperftest"
},
{
"clientId": 7,
"clientName": "perftestmac1"
}
]
},
"content": [
{}
],
"backupsetSecurity": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": 1,
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"planEntity": {
"planType": 2,
"planName": "common_plan",
"planSubtype": 33554437,
"planId": 2
},
"commonBackupSet": {
"dataMigratorILMCLASS": false,
"newBackupSetName": "DumpBasedBackupSet",
"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": true,
"isHidden": false,
"isMining": false,
"isUSeDCForBackup": false
},
"backupSetEntity": {
"clientName": "GCPtest-1285-cu7",
"instanceName": "pg13db[asia-south1]",
"displayName": "GCPtest-1285-cu7",
"backupsetId": 1320,
"_type_": 6,
"instanceId": 1060,
"backupsetGUID": "D7C12621-0B4A-4115-B73E-5A221F556D7A",
"clientId": 444,
"appName": "PostgreSQL",
"backupsetName": "DumpBasedBackupSet",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"postGresBackupSetProps": {
"enableGlobalObjectsBkp": false,
"parallelDumpOpt": {
"enableParallelDump": false,
"jobs": 1,
"stagingPath": ""
}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}
Loading...