Fetch database group properties
Select
SaaS
Customer Managed
This operation is used to fetch the database group properties.
Path Parameters
- subclientId integer required
Id of the subclient
Responses
- 200
- 404
OK
- application/json
- Schema
- Example (from schema)
- Maria D B
Schema
subClientProperties object[]
{
"subClientProperties": [
{
"status": 0,
"useLocalContent": true,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": true,
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cassandraProps": {},
"taPlanEntity": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"mySqlSubclientProp": {
"numberOfTransactionLogStreams": 0,
"numberOfBackupStreams": 0,
"fullInstanceXtraBackup": true,
"proxySettings": {
"proxyInstance": {
"instanceId": 0
}
}
},
"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",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"region": {},
"content": [
{
"mySQLContent": {
"databaseName": "string",
"creationTime": 0,
"databaseSize": 0,
"discoverFlag": 0,
"engineName": "string"
}
}
],
"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"
},
"lastBackupJobInfo": {
"jobID": 0,
"failureReasonIds": "string",
"commCellID": 0,
"failureReasonMessageEnglish": "string",
"status": 0,
"startTime": {
"time": 0
},
"endTime": {
"time": 0
}
},
"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": "sudheer_plan",
"planSubtype": 33554437,
"planId": 5
},
"cassandraProps": {},
"taPlanEntity": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"mySqlSubclientProp": {
"numberOfTransactionLogStreams": 1,
"numberOfBackupStreams": 4,
"fullInstanceXtraBackup": false,
"proxySettings": {
"proxyInstance": {
"instanceId": 0
}
}
},
"subClientEntity": {
"clientName": "ApI-TEST",
"instanceName": "mariadb/enctest6[ap-south-1]",
"displayName": "ApI-TEST",
"backupsetId": 950,
"_type_": 7,
"commCellName": "dbrocky",
"instanceId": 76,
"csGUID": "ED9B8D5F-C874-4433-ADC4-10D6B85FAFCA",
"subclientGUID": "B46D509F-ABF6-4E5E-BAAC-9A6642F7F0D7",
"subclientId": 140,
"clientId": 99,
"appName": "MySQL",
"backupsetName": "defaultDummyBackupSet",
"applicationId": 104,
"subclientName": "sub3",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"region": {},
"content": [
{
"mySQLContent": {
"databaseName": "/enctest",
"creationTime": 0,
"databaseSize": 0,
"discoverFlag": 0,
"engineName": "UNKNOWN"
}
},
{
"mySQLContent": {
"databaseName": "/enctest2",
"creationTime": 0,
"databaseSize": 0,
"discoverFlag": 0,
"engineName": "UNKNOWN"
}
},
{
"mySQLContent": {
"databaseName": "/enctest3",
"creationTime": 0,
"databaseSize": 0,
"discoverFlag": 0,
"engineName": "UNKNOWN"
}
}
],
"commonProperties": {
"nextBackupTime": 1705419000,
"slaStatus": 3,
"isAdAppAwareSubclient": false,
"disableArchivingTurboRule": false,
"firstBackupTime": 1705400461,
"lastBackupTime": 1705400461,
"indexingBackupSubClient": false,
"allowVssForSnapbackup": false,
"isActivityDisabledFromPolicy": false,
"isETCDSubclient": false,
"enableBackupAfterDelay": false,
"runAs": 0,
"slaCategoryDescription": "Recently Installed with No Finished Job",
"onBoardCompanyId": 0,
"sizeOnMedia": 869328,
"enableBackup": true,
"encryptionFlag": 2,
"numberOfBackupStreams": 1,
"idaType": 0,
"runTrueUpJobAfterDays": 30,
"totalBackupSize": 6255,
"dedupeRatio": -13798.13,
"isTrueUpOptionEnabled": false,
"slaCategory": 10,
"subClientPropertiesFlag": 0,
"lastBackupSize": 6255,
"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": ""
},
"lastBackupJobInfo": {
"jobID": 110623,
"failureReasonIds": "",
"commCellID": 2,
"failureReasonMessageEnglish": "",
"status": 1,
"startTime": {
"time": 1705400461
},
"endTime": {
"time": 1705400495
}
},
"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": "sudheer_plan",
"storagePolicyId": 19
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "sudheer_plan",
"storagePolicyId": 19
},
"performanceMode": {
"perfSPName": "sudheer_plan",
"multiplexingValid": false,
"enableMultiplexing": false,
"perfCopyName": "Primary",
"perfClientName": "ApI-TEST",
"streamsOverMux": false,
"pipelineBufferSize": 64,
"numOfPipelineBuffers": 180,
"muxFactor": 0,
"lookAheadReaderSlots": 4,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 4,
"crcOverNetwork": true,
"perfMa": "mysqlperftest"
}
]
}
},
"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": {}
}
]
}
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
}
GET /subclient/:subclientid
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'