Fetch Subclients associated to HANA instance
Select
SaaS
Customer Managed
Fetch Subclients of HANA instance
Query Parameters
- clientName string required
HANA Pseudo client name
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- filterQueryCount integer
subClientProperties object[]
{
"filterQueryCount": 0,
"subClientProperties": [
{
"useLocalContent": true,
"useLocalArchivalRules": true,
"planEntity": {},
"cassandraProps": {},
"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": "string",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
}
]
}
{
"filterQueryCount": 9,
"subClientProperties": [
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "sdehana02_NET",
"instanceName": "NET",
"displayName": "sdehana02_NET",
"backupsetId": 57,
"_type_": 7,
"commCellName": "sp17mycs",
"instanceId": 30,
"csGUID": "A9F456C5-75D7-4561-B704-B70B662FD221",
"subclientGUID": "11FBCD3D-6DE3-423D-AC2C-CADB2FDE0D26",
"subclientId": 126,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "SYSTEMDB",
"applicationId": 135,
"subclientName": "default",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "sdehana02_NET",
"instanceName": "NET",
"displayName": "sdehana02_NET",
"backupsetId": 57,
"_type_": 7,
"commCellName": "sp17mycs",
"instanceId": 30,
"csGUID": "A9F456C5-75D7-4561-B704-B70B662FD221",
"subclientGUID": "1F5E86E6-A19D-4598-910D-24E207BAC494",
"subclientId": 127,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "SYSTEMDB",
"applicationId": 135,
"subclientName": "(command line)",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "sdehana02_NET",
"instanceName": "NET",
"displayName": "sdehana02_NET",
"backupsetId": 57,
"_type_": 7,
"commCellName": "sp17mycs",
"instanceId": 30,
"csGUID": "A9F456C5-75D7-4561-B704-B70B662FD221",
"subclientGUID": "0E4AE4CC-E523-4CF4-8C5B-4E40AF508CE4",
"subclientId": 128,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "SYSTEMDB",
"applicationId": 135,
"subclientName": "(Logcommand line)",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"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": "690FC5AD-748F-40CF-916A-D58EBD31DB86",
"subclientId": 129,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "NET",
"applicationId": 135,
"subclientName": "default",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"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": "1DD2E186-B2AB-4A51-86A6-68A8E0A2102D",
"subclientId": 130,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "NET",
"applicationId": 135,
"subclientName": "(command line)",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"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": "F253E547-095F-4BC6-9A73-A1490761E46B",
"subclientId": 131,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "NET",
"applicationId": 135,
"subclientName": "(Logcommand line)",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"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": "DF481B46-7885-483D-AA28-76A5E6C82E96",
"subclientId": 311,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "NET",
"applicationId": 135,
"subclientName": "testnp1",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"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": {},
"region": {},
"analyticsSubclientProp": {}
},
{
"useLocalContent": false,
"useLocalArchivalRules": false,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"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": "CBC61BC8-FAFC-4F52-94D8-DA09DDC69CD0",
"subclientId": 313,
"clientId": 31,
"appName": "SAP HANA",
"backupsetName": "NET",
"applicationId": 135,
"subclientName": "testnp123",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell"
}
},
"dfsSubclientProp": {},
"region": {},
"analyticsSubclientProp": {}
}
]
}
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
subClientProperties 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": {}
}
]
}
GET /subclient
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://localhost/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://localhost/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://localhost/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://localhost/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://localhost/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://localhost/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://localhost/commandcenter/api/Subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'