Get details of a backup destination
Select
Fetch details of a backup destination.
Path Parameters
- BackupDestinationId int32 required
Id of the backupDestination for which details will be fetched.
- 200
- 400
Success
- application/json
- Schema
- Example (from schema)
Schema
- id int32
Id of backup destination
- name string
Name of backup destination
- netAppCloudTarget boolean
Only for snap copy. Tells if the snap copy supports SVM Mapping to NetApp cloud targets only.
- isDefault boolean
Is this a default backup destination?
- isSnapCopy boolean
Is this a snap copy?
- isMirrorCopy boolean
Is this a mirror copy?
- copyType
Possible values: [
SYNCHRONOUS
,SELECTIVE
,PRIMARY
] - copyTypeName
Possible values: [
DEFAULT_MIRROR
,DEFAULT_VAULT_REPLICA
,MIRROR
,VAULT_REPLICA
,SNAPSHOT_PRIMARY
] - copyPrecedence int32
Order of backup destinaion copy created in storage policy
storagePool object
id int32Id of Storage Pool
name stringName of Storage Pool
typePossible values: [
DEDUPLICATION
,SECONDARY_COPY
,NON_DEDUPLICATION
,SCALE_OUT
]Type of Storage Pool
retentionPeriodDays int32Retention period of pool in days
wormStoragePoolFlag int32Bit flag indicating WORM configuration of storage pool. 0 means no lock, 1 means compliance lock, 2 means worm storage lock, 4 means Object worm lock and 8 means bucket worm lock.
deviceType stringPossible values: [
DEFAULT
,MAGNETIC
,AMAZON_S3
,MICROSOFT_AZURE
,NIRVANIX_MFS
,RACKSPACE_CLOUD_FILES
,IRON_MOUNTAIN_ARCHIVE
,EMC_ATMOS
,ATT_SYNAPTIC
,CV_OBJECT_SERVER
,HDS_HCP
,MEZEO_CS
,OPENSTACK
,AMPLIDATA
,CMCC_ONEST
,HDFS
,VERIZON_CLOUD
,GOOGLE_CLOUD
,VMWARE_CLOUD
,ORACLE_STORAGE_CLOUD_SERVICE
,ORACLE_STORAGE_CLOUD_ARCHIVE_SERVICE
,ALICLOUD_OSS
,HUAWEI_OSS
,ORACLE_BAREMETAL_OBJECT_STORAGE_S3
,ORACLE_BAREMETAL_OBJECT_STORAGE
,TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE
,ORACLE_BAREMETAL_ARCHIVE_STORAGE
,INSPUR_CLOUD
,IBM_CLOUD
,AZURE_DATA_LAKE_STORE
,KINGSOFT_KS3
,MICROSOFT_ONEDRIVE
,IRON_MOUNTAIN_CLOUD
,MICROSOFT_FILE_SHARE
,AZURE_DATA_LAKE_STORE_GEN2
,MICROSOFT_AZURE_COMPATIBLE
,S3_COMPATIBLE
,CARINGO_CASTOR
,DELL_DX_OBJECTSTORAGE
,AMAZON_GLACIER
,DDN_WOS
,GENERIC_HARDWARE_DEDUPE_DEVICE
,BOOST_HARDWARE_DEDUPE_DEVICE
,HP_STOREONCE
,ISILON_ONEFS
,LOCAL_FILE
,LOCAL_FILE_WITH_PROP_S3
,LOCAL_FILE_WITH_PROP_AZURE
,CEPH_OBJECT_GATEWAY_S3
,CLOUDIAN_HYPERSTORE
,DELL_EMC_ECS_S3
,FUJITSU_STORAGE_ETERNUS
,HITACHI_VANTARA_HCP_S3
,IBM_CLOUD_S3
,NETAPP_STORAGEGRID
,REVERA_VAULT
,SCALITY_RING
,WASABI_HOT_CLOUD_STORAGE
,NUTANIX_BUCKETS
,NETAPP_ONTAP_S3
,HITACHI_CLOUD_SCALE
,PURE_STORAGE_FLASHBLADE
,VAST_DATA
,METALLIC
,METALLIC_AZURE_HOT
,METALLIC_AZURE_COOL
,METALLIC_OCI_STANDARD
,METALLIC_OCI_IA
,METALLIC_O365
,METALLIC_ENDPOINT
,METALLIC_SALESFORCE
,METALLIC_D365
,METALLIC_AZURE_AD
,METALLIC_AZURE_MAAS
,MICROSOFT_AZURE_MANAGEMENT
,MICROSOFT_AZURE_MANAGEMENT_BLOB
,MICROSOFT_AZURE_MANAGEMENT_FILE
]Device type of the storage.
storageClass stringPossible values: [
DEFAULT
,AWS_STANDARD
,AWS_REDUNDANCY
,AWS_SIA
,AWS_ONEZONE_IA
,AWS_IT
,AWS_GLACIER
,AWS_GLACIER_STANDARD
,AWS_GLACIER_SIA
,AWS_GLACIER_OZIA
,AWS_GLACIER_IT
,AWS_DEEP_ARCHIVE
,AWS_DA_STANDARD
,AWS_DA_SIA
,AWS_DA_OZIA
,AWS_DA_IT
,AWS_GLACIER_IR
,AWS_GLACIER_IR_STANDARD
,AWS_GLACIER_IR_SIA
,AWS_GLACIER_IR_OZIA
,AWS_GLACIER_IR_IT
,AZURE_DEFAULT
,AZURE_HOT
,AZURE_COOL
,AZURE_ARCHIVE
,AZURE_HOT_ARCHIVE
,AZURE_COOL_ARCHIVE
,AZURE_COLD
,AZURE_HOT_COLD
,AZURE_COOL_COLD
,GOOGLE_STANDARD
,GOOGLE_DR_AVAILABILITY
,GOOGLE_NEARLINE
,GOOGLE_COLDLINE
,GOOGLE_ARCHIVE
,GOOGLE_DEFAULT
,ALI_DEFAULT
,ALI_STANDARD
,ALI_IA
,ALI_ARCHIVE
,ALI_ARCHIVE_STANDARD
,ALI_ARCHIVE_IA
,K3S_STANDARD
,K3S_IA
,ORACLE_STANDARD
,ORACLE_IA
,ORACLE_ARCHIVE
,ORACLE_STANDARD_ARCHIVE
,ORACLE_IA_ARCHIVE
]Storage container information of the storage.
isArchiveStorage booleanFlag indicating whether the storage tier is archive.
region object
id int32name stringdisplayName string- storageType StorageType
Possible values: [
ALL
,DISK
,CLOUD
,HYPERSCALE
,TAPE
] sourceCopy object
id int32name stringregion object
id int32name stringdisplayName string- backupsToCopy string
Possible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
- fullBackupTypesToCopy PlanFullBackupTypeToCopy
Possible values: [
FIRST
,LAST
]Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default is LAST while adding new backup destination.
- backupStartTime int32
Backup start time in number of seconds. The time is provided in unix time format.
- enableDataAging boolean
Tells if this copy has data aging enabled
- overrideRetentionSettings boolean
Tells if this copy should use storage pool retention period days or the retention defined for this copy. Set as true to use retention defined on this copy.
- retentionRuleType RententionRuleTypes
Possible values: [
RETENTION_PERIOD
,SNAP_RECOVERY_POINTS
]Which type of retention rule should be used for the given backup destination
- retentionPeriodDays int32
Possible values:
>= 1
and<= 9999
Retention period in days
- snapRecoveryPoints int32
Number of snap recovery points for snap copy for retention
- useExtendedRetentionRules boolean
Should extended retention rules be used
extendedRetentionRules object
If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.
firstExtendedRetentionRule object
isInfiniteRetention booleanIf this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32If this is set, no need to specify isInfiniteRetention as false.
type stringPossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
secondExtendedRetentionRule object
isInfiniteRetention booleanIf this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32If this is set, no need to specify isInfiniteRetention as false.
type stringPossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
thirdExtendedRetentionRule object
isInfiniteRetention booleanIf this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32If this is set, no need to specify isInfiniteRetention as false.
type stringPossible values: [
All_JOBS
,ALL_FULLS
,HOURLY_FULLS
,DAILY_FULLS
,WEEKLY_FULLS
,MONTHLY_FULLS
,QUARTERLY_FULLS
,HALF_YEARLY_FULLS
,YEARLY_FULLS
,ADVANCED
]All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.
mappings object[]
vendorPossible values: [
NETAPP
,AMAZON
,PURE
,AZURE
]Snapshot vendors available for Snap Copy mappings
source object
id int32name stringtarget object
id int32name stringsourceVendor object
id int32name stringtargetVendor object
id int32name string
{
"id": 0,
"name": "string",
"netAppCloudTarget": true,
"isDefault": true,
"isSnapCopy": true,
"isMirrorCopy": true,
"copyType": "SYNCHRONOUS",
"copyTypeName": "DEFAULT_MIRROR",
"copyPrecedence": 0,
"storagePool": {
"id": 0,
"name": "string",
"type": "DEDUPLICATION",
"retentionPeriodDays": 0,
"wormStoragePoolFlag": 0,
"deviceType": "DEFAULT",
"storageClass": "DEFAULT",
"isArchiveStorage": true,
"region": {
"id": 0,
"name": "string",
"displayName": "string"
}
},
"storageType": "ALL",
"sourceCopy": {
"id": 0,
"name": "string"
},
"region": {
"id": 0,
"name": "string",
"displayName": "string"
},
"backupsToCopy": "All_JOBS",
"fullBackupTypesToCopy": "FIRST",
"backupStartTime": 0,
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}
Bad Request