Fetch SAP HANA subclient properties
Select
SaaS
Customer Managed
Get SAP HANA subclient properties
Path Parameters
- subclientid string required
Subclient Id of the subclient whose properties need to be read
Responses
- 200
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
subClientProperties object[]
status integeruseLocalContent booleanuseLocalArchivalRules booleancanChangeEncryptionSetting booleanplanEntity object
planType integerplanName stringplanSubtype integerplanId integercassandraProps object
splunkProps object
sapHANASubclientProp object
numberOfBackupStreams integerproxyClient object
dcPlanEntity object
subClientEntity object
clientName stringinstanceName stringdisplayName stringbackupsetId integer_type_ integercommCellName stringinstanceId integercsGUID stringsubclientGUID stringsubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringentityInfo object
companyId integercompanyName stringdfsSubclientProp object
oracleSubclientProp object
dataThresholdStreams integerregion object
commonProperties object
nextBackupTime integerslaStatus integerisAdAppAwareSubclient booleandisableArchivingTurboRule booleanfirstBackupTime integerlastBackupTime integerindexingBackupSubClient booleanallowVssForSnapbackup booleanisActivityDisabledFromPolicy booleanisETCDSubclient booleanenableBackupAfterDelay booleanrunAs integerslaCategoryDescription stringonBoardCompanyId integersizeOnMedia integerenableBackup booleanencryptionFlag integernumberOfBackupStreams integeridaType integerrunTrueUpJobAfterDays integertotalBackupSize integerdedupeRatio integerisTrueUpOptionEnabled booleanslaCategory integersubClientPropertiesFlag integerlastBackupSize integerallowMultipleDataReaders booleansecurityAssociations object
ownerAssociations object
tagWithCompany object
providerId integerproviderDomainName stringassociatedSnapShotSCId object
_type_ integersnapCopyInfo object
IsOracleSposDriverEnabled booleanisRMANEnableForTapeMovement booleanuseProxyForSQLIntegrity object
sybaseUser object
snapToTapeSelectedEngine object
_type_ integersqlUser object
vmApplicationUser object
snapToTapeProxyToUse object
_type_ integerquiesceImpersonateUser object
separateProxyForSnapToTape object
_type_ integersshKey object
configuredSybaseInstance object
_type_ integersubclientPolicy object
_type_ integersubclientPolicyName stringimpersonateUserCredentialinfo object
credentialId integercredentialName stringenableBackupAtDateTime object
TimeZoneID integertime integerturboNASClient object
_type_ integerprepostProcess object
runPostScan integerrunPostBackup integerrunPostLog integerprepostUserName object
security object
associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringadvancedPrivacySettings object
isPasskeyFeatureEnabled booleanauthType integerisPrivacyFeatureEnabled booleanpasskeySettings object
enableAuthorizeForRestore booleanexpirationTime object
time integerownerCapabilities object
storageDevice object
networkAgents integersoftwareCompression integerthrottleNetworkBandwidth integerdataBackupStoragePolicy object
_type_ integerstoragePolicyName stringstoragePolicyId integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature integerlogBackupStoragePolicy object
_type_ integerstoragePolicyName stringstoragePolicyId 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": {},
"splunkProps": {},
"sapHANASubclientProp": {
"numberOfBackupStreams": 0
},
"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": "string",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string"
}
},
"dfsSubclientProp": {},
"oracleSubclientProp": {
"dataThresholdStreams": 0
},
"region": {},
"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,
"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": "test",
"planSubtype": 33554437,
"planId": 1
},
"cassandraProps": {},
"splunkProps": {},
"sapHANASubclientProp": {
"numberOfBackupStreams": 4
},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "sdehana02_NET",
"instanceName": "NET",
"displayName": "sdehana02_NET",
"backupsetId": 58,
"_type_": 7,
"commCellName": "sp17mycs",
"instanceId": 30,
"csGUID": "A9F456C5-75D7-4561-B704-B70B662FD221",
"subclientGUID": "89F2DB84-AC3E-4714-9F7A-2EFBE65A6A77",
"subclientId": 312,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "NET",
"applicationId": 135,
"subclientName": "testnp12",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"oracleSubclientProp": {
"dataThresholdStreams": 4
},
"region": {},
"commonProperties": {
"nextBackupTime": 1700321400,
"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,
"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": "test",
"storagePolicyId": 5
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "test",
"storagePolicyId": 5
},
"performanceMode": {
"perfSPName": "test",
"multiplexingValid": false,
"enableMultiplexing": false,
"perfCopyName": "Primary",
"perfClientName": "sdehana02_NET",
"streamsOverMux": false,
"pipelineBufferSize": 64,
"numOfPipelineBuffers": 180,
"muxFactor": 0,
"lookAheadReaderSlots": 4,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 2,
"crcOverNetwork": true,
"perfMa": "sp17mycs"
}
]
}
},
"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 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Input XML has invalid subclient name in association.",
"errorCode": 587204334
}
Loading...