Skip to main content

Fetch Oracle subclient properties​

Select

SaaS
Customer Managed

This operation is used to fetch subclient properties

Path Parameters
  • subclientId integer required

    Subclient Id of the subclient whose properties need to be read

Responses

OK

Schema
  • subClientProperties object[]
  • status integer
  • useLocalContent boolean
  • useLocalArchivalRules boolean
  • canChangeEncryptionSetting boolean
  • planEntity object
  • cassandraProps object
  • splunkProps object
  • proxyClient object
  • dcPlanEntity object
  • subClientEntity object

    Subclient General Properties

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • _type_ integer
  • commCellName string
  • instanceId integer
  • csGUID string
  • subclientGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • subclientName string
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • dfsSubclientProp object
  • oracleSubclientProp object

    Subclient Oracle properties

  • imageCopyDir string
  • oracleTag string
  • data boolean
  • archiveDelete boolean
  • skipOffline boolean
  • useSQLConntect boolean
  • dbSubclientType integer
  • mergeIncImageCopies boolean
  • skipReadOnly boolean
  • warning boolean
  • archiveDeleteAll boolean
  • triesNumber integer
  • selectArchiveLogDestForDelete boolean
  • startupPFile string
  • checkLogical boolean
  • sleepTimeinMin integer
  • backupArchiveLogOption integer
  • protectBackupRecoveryArea boolean
  • sleepTimeinSec integer
  • delayTimeinMin integer
  • lightsOutScript boolean
  • logThresholdStreams integer
  • selectArchiveLogDestForBackup boolean
  • maxOpenFiles integer
  • maxBackupSetSizeInKB integer
  • backupSPFile boolean
  • snapImageCopy boolean
  • backupControlFile boolean
  • skipInaccessible boolean
  • backupMode integer
  • disableSwitchCurrentLog boolean
  • backupArchiveLog boolean
  • resyncCatalog boolean
  • validate boolean
  • useRmanForLogBackup boolean
  • dataFilesPerBFS integer
  • enableTableBrowse boolean
  • dataThresholdStreams integer
  • archiveFilesPerBFS integer
  • sectionSizeInKB integer
  • dgInfo object
  • isDataGuardClient boolean
  • logPolicy integer
  • dataPolicy integer
  • archiveOptions object
  • databaseName object
  • historyConnectUserAccount object
  • client object
  • region object
  • commonProperties object

    Subclient Advanced Options

  • nextBackupTime integer
  • slaStatus integer
  • isAdAppAwareSubclient boolean
  • disableArchivingTurboRule boolean
  • firstBackupTime integer
  • lastBackupTime integer
  • indexingBackupSubClient boolean
  • allowVssForSnapbackup boolean
  • isActivityDisabledFromPolicy boolean
  • isETCDSubclient boolean
  • enableBackupAfterDelay boolean
  • runAs integer
  • slaCategoryDescription string
  • onBoardCompanyId integer
  • sizeOnMedia integer
  • enableBackup boolean
  • encryptionFlag integer
  • numberOfBackupStreams integer
  • idaType integer
  • runTrueUpJobAfterDays integer
  • totalBackupSize integer
  • dedupeRatio integer
  • isTrueUpOptionEnabled boolean
  • slaCategory integer
  • subClientPropertiesFlag integer
  • lastBackupSize integer
  • securityAssociations object
  • ownerAssociations object
  • tagWithCompany object
  • providerId integer
  • providerDomainName string
  • associatedSnapShotSCId object
  • _type_ integer
  • snapCopyInfo object
  • backupCopyInterface integer
  • IsOracleSposDriverEnabled boolean
  • isRMANEnableForTapeMovement boolean
  • useProxyForSQLIntegrity object
  • sybaseUser object
  • snapToTapeSelectedEngine object
  • _type_ integer
  • sqlUser object
  • vmApplicationUser object
  • snapToTapeProxyToUse object
  • _type_ integer
  • quiesceImpersonateUser object
  • separateProxyForSnapToTape object
  • _type_ integer
  • sshKey object
  • configuredSybaseInstance object
  • _type_ integer
  • subclientPolicy object
  • _type_ integer
  • subclientPolicyName string
  • impersonateUserCredentialinfo object
  • credentialId integer
  • credentialName string
  • enableBackupAtDateTime object
  • TimeZoneID integer
  • time integer
  • turboNASClient object
  • _type_ integer
  • prepostProcess object
  • runPostScan integer
  • runPostBackup integer
  • runPostLog integer
  • prepostUserName object
  • security object
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • advancedPrivacySettings object
  • isPasskeyFeatureEnabled boolean
  • authType integer
  • isPrivacyFeatureEnabled boolean
  • passkeySettings object
  • enableAuthorizeForRestore boolean
  • expirationTime object
  • time integer
  • ownerCapabilities object
  • storageDevice object
  • networkAgents integer
  • softwareCompression integer
  • throttleNetworkBandwidth integer
  • dataBackupStoragePolicy object
  • _type_ integer
  • deDuplicationOptions object
  • enableDeduplication boolean
  • generateSignature integer
  • logBackupStoragePolicy object
  • _type_ integer
  • storagePolicyName string
  • storagePolicyId integer
  • performanceMode object
  • perfSPName string
  • perfCopyName string
  • perfClientName string
  • pipelineBufferSize integer
  • numOfPipelineBuffers integer
  • muxFactor integer
  • lookAheadReaderSlots integer
  • perfCRCDetails object[]
  • crcOverMedia boolean
  • perfMaId integer
  • crcOverNetwork boolean
  • perfMa string
  • UNCScriptCredentialinfo object
  • credentialId integer
  • credentialName string
  • vmBackupValidationSettings object
  • isAppValidationEnabled boolean
  • backupValidationThreadCount integer
  • subTaskId integer
  • isCustomAppEnabled boolean
  • runAsDevTestGroup boolean
  • taskId integer
  • useSourceVMEsxToMount boolean
  • uncScriptImpersonateUser object
  • userName string
  • prepostCredentialinfo object
  • credentialId integer
  • credentialName string
  • associatedPolicy object
  • subclientPolicyId integer
  • guestCredentialinfo object
  • credentialId integer
  • credentialName string
  • lastBackupJobInfo object
  • jobID integer
  • failureReasonIds string
  • commCellID integer

    Default value: 2

  • failureReasonMessageEnglish string
  • status integer

    Default value: 1

  • startTime object
  • time integer
  • endTime object
  • time integer
  • analyticsSubclientProp object
GET /subclient/:subclientid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
subclientId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'