Get PostgreSQL backupset properties
Select
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[]
{
"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": 1707721940,
"applicationSize": 0,
"totalBackupSize": 86885518,
"lastBackupTime": 1709479813,
"firstBackupTime": 1708961646,
"scIdxEnabled": 0,
"sizeOnMedia": 129576810,
"dedupeRatio": 95,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"indexSettings": {
"indexRetCycle": -1,
"overrideIndexPruning": 0,
"indexPath": "/opt/commvault/MediaAgent/IndexCache/CvIdxDB/B814ED41-CC44-4B2A-B108-8D2F6E0AE8F6/B814ED41-CC44-4B2A-B108-8D2F6E0AE8F6",
"indexRetDays": -1,
"isPruningEnabled": 1,
"indexPruningType": 0,
"currentIndexServer": {
"clientId": 4,
"clientName": "mysqlperftest"
},
"qualifyingIndexServers": [
{
"clientId": 4,
"clientName": "mysqlperftest"
}
]
},
"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": "sudheer_plan",
"planSubtype": 33554437,
"planId": 5
},
"commonBackupSet": {
"dataMigratorILMCLASS": false,
"newBackupSetName": "DumpBasedBackupSet",
"onDemandBackupset": false,
"slaStatus": 1,
"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": "ash-azure-shinchan",
"instanceName": "pgflexibleserver11[eastus]",
"displayName": "ash-azure-shinchan",
"backupsetId": 864,
"_type_": 6,
"instanceId": 684,
"backupsetGUID": "B814ED41-CC44-4B2A-B108-8D2F6E0AE8F6",
"clientId": 183,
"appName": "PostgreSQL",
"backupsetName": "DumpBasedBackupSet",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"postGresBackupSetProps": {
"enableGlobalObjectsBkp": false,
"parallelDumpOpt": {
"enableParallelDump": true,
"jobs": 2,
"stagingPath": "C:\\\\staging"
}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}
GET /backupset/:backupsetid
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/backupset/:backupsetId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'