This operation returns the properties associated with a subclient.
Request
Syntax
GET <webservice>/Subclient/{subclientId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
Name | Description | Required |
|---|---|---|
subclientId | The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it. | Yes |
Request Headers
Name | Description |
|---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter | Description | Element | ||
|---|---|---|---|---|
allowMultipleDataReaders | The option to allow multiple data reads for a single Windows physical drive or Unix mount point during backups on the subclient. Valid values are True/False. | commonProperties | ||
description | The description of the subclient. | commonProperties | ||
enableBackup | The option to enable/disable backup. Valid values are True/False. | commonProperties | ||
encryptionFlag | The option to set the encryption points during backups. Valid values are:
| commonProperties | ||
fsFLRReplicationOptions | A value corresponding to the enabled replication settings for the subclient. If multiple replication settings are enabled, then the value is equal to the sum of the individual values of the enabled settings. For example, a value of 7 means that the enabled replication settings for the subclient are Smart replication (1), remote replication (2), and compression (4). Valid values for enabled settings are:
| commonProperties | ||
isKeepItemPastExpiryTime | Valid values are True/False. | commonProperties | ||
numberOfBackupStreams | The option to set the number of backup streams. | commonProperties | ||
readBuffersize |
|
| ||
runPostBackup | The option to run a process after the backup completes. Valid values are Yes/No. | prepostProcess | ||
_type_ | The CommCell objects associated with the snap to tape proxy host. Valid value is CLIENT_ENTITY. | snapToTapeProxyHost | ||
clientId | The system-generated ID assigned to the client. | snapToTapeProxyHost | ||
applicableReadSize | The amount of application data backup jobs will read for each unit transferred to the MediaAgent. Valid kilobyte values are 64, 128, 256, 512, 1024, 2048, or 4096. | storageDevice | ||
networkAgents | The option to specify the number of processes the subclient uses to transfer data over a network. Valid values are 1-4 on Windows computers or 1-2 on UNIX computers. | storageDevice | ||
softwareCompression | The option to enable compression on the client or the MediaAgent computer. Valid values are:
| storageDevice | ||
throttleNetworkBandwidth | The maximum network bandwidth per network agent (in megabytes per hour). Valid values are 2-2147483647. | storageDevice | ||
_type_ | The CommCell objects associated with the backup storage policy. Valid value is STORAGE_POLICY_ENTITY. | dataBackupStoragePolicy | ||
storagePolicyId | The system-generated ID assigned to the storage policy associated with the subclient backup. | dataBackupStoragePolicy | ||
enableDeduplication | The option to enable deduplication on the subclient. Valid values are True/False. | deDuplicationOptions | ||
generateSignature | A component of deduplication performed on the client or MediaAgent computer. Valid values are:
| deDuplicationOptions | ||
path | The location of the content to back up. | content | ||
excludePath | The location of the content to exclude from the backup. | content | ||
includePath | The location of the content to back up if the excludePath parameter is used but exceptions exist. | content | ||
backupSystemState | The option to enable/disable backing up the system state. This option should not be enabled in more than one subclient per backup set to avoid system state backup failures. Valid values are True/False. | fsSubClientProp | ||
backupSystemStateforFullBkpOnly | The option to backup the system state only during full backups. This parameter is available when the backupSystemState parameter is set to True. Valid values are True/False. | fsSubClientProp | ||
daysToKeepItems | The number days to keep files deleted by a user. This parameter is available when the retentionRule parameter is set to AFTER. | fsSubClientProp | ||
retentionRule | The option to prune files deleted by a user. When the synthetic full backup is run at the end of specified retention period, the deleted files will be dropped from the synthetic full backup. Valid values are:
| fsSubClientProp | ||
useGlobalFilters | The option to enable global filters. Valid values are:
| fsSubClientProp | ||
useVSS | The option to enable/disable VSS (Volume Shadow Copy Service) to back up the file system data. Valid values are True/False. | fsSubClientProp | ||
_type_ | The CommCell objects associated with the subclient. Valid value is SUBCLIENT_ENTITY. | subClientEntity | ||
appName | The name of the application. Valid values are:
| subClientEntity | ||
applicationId | The ID of the application. Valid values are:
| subClientEntity | ||
backupsetName | The name of the backup set. | subClientEntity | ||
backupsetId | The system-generated ID assigned to the backup set. | subClientEntity | ||
clientName | The name of the client. | subClientEntity | ||
clientId | The system-generated ID assigned to the client. | subClientEntity | ||
instanceName | The name of the instance, for example: DefaultInstanceName. | subClientEntity | ||
instanceId | The system-generated ID assigned to the instance. | subClientEntity | ||
subclientName | The name of the subclient. | subClientEntity | ||
subclientId | The system-generated ID assigned to the subclient. | subClientEntity |
Examples
Example Request
GET <webservice>/Subclient/6 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Example Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GetSubClientPropertiesResponse>
<subClientProperties>
<commonProperties enableBackup="true" description="compliance" encryptionFlag="ENC_NETWORK_AND_MEDIA" fsFLRReplicationOptions="540672" isKeepItemPastExpiryTime="true" numberOfBackupStreams="2" readBuffersize="256">
<prepostProcess runPostBackup="NO"/>
<snapCopyInfo>
<snapToTapeProxyHost _type_="CLIENT_ENTITY" clientId="2"/>
</snapCopyInfo>
<storageDevice applicableReadSize="4096" networkAgents="2" softwareCompression="USE_STORAGE_POLICY_SETTINGS" throttleNetworkBandwidth="-1">
<dataBackupStoragePolicy _type_="STORAGE_POLICY_ENTITY" storagePolicyId="7"/>
<deDuplicationOptions enableDeduplication="true" generateSignature="ON_CLIENT"/>
</storageDevice>
</commonProperties>
<content path="C:\\DOC_folder"/>
<fsSubClientProp backupSystemState="false" backupSystemStateforFullBkpOnly="false" retentionRule="IMMEDIATELY" useGlobalFilters="OFF" useVSS="true"/>
<impersonateUser/>
<subClientEntity _type_="SUBCLIENT_ENTITY" applicationId="33" backupsetId="3" clientId="2" instanceId="1" subclientId="6"/>
</subClientProperties>
</App_GetSubClientPropertiesResponse>