Get Archive Plan details
Select
Get Archive Plan details
Path Parameters
- planId int32 required
Id of the plan
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
plan object
id int32name stringarchivingRules object
Files which meet both time stamp and file size rules will be archived
fileTimestampMethod stringPossible values: [
LAST_ACCESSED
,LAST_MODIFIED
]Default value:
LAST_MODIFIED
fileTimestamp int32Default value:
90
To archive files based on the last accessed or modified date of each file within the folder, specify the number of days. Should be supplied with fileTimestampMethod.
fileSize int32Default value:
1
To archive files based on the size of the file, specify the minimum file size in KB.
afterArchivingPossible values: [
REPLACE_FILE_WITH_STUB
,DELETE_THE_FILE
]After an archive job, replace the file that meets the archiving rules with a stub or delete the file that meets the archiving rules
rpo object
Recovery Point Objective (RPO) is the maximum amount of time that data can be lost during a service disruption. Your RPO determines the frequency of your backup jobs.
backupFrequency object
Used to describe the frequency of backup
scheduleFrequencyType stringPossible values: [
MINUTES
,DAILY
,WEEKLY
,MONTHLY
,YEARLY
]Default value:
DAILY
schedule frequency type
frequency int32Possible values:
>= 1
Default value:
1
Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months
weeklyDays string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
]Days of the week for weekly frequency
dayOfMonth int32Possible values:
>= 1
and<= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth stringPossible values: [
FIRST
,SECOND
,THIRD
,FOURTH
,LAST
]Specific week of a month
dayOfWeek stringPossible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
,DAY
,WEEKDAY
,WEEKEND_DAYS
]monthOfYear stringPossible values: [
JANUARY
,FEBRUARY
,MARCH
,APRIL
,MAY
,JUNE
,JULY
,AUGUST
,SEPTEMBER
,OCTOBER
,NOVEMBER
,DECEMBER
]startTime int32Default value:
75600
start time of schedule in seconds for daily, weekly, monthly, yearly frequency
backupWindow object[]
Archive job will run only in the specified archive window
dayOfWeek string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
]startTime int64Time in seconds since the beginning of the day
endTime int64Time in seconds since the beginning of the day
SLA object
A server meets SLA (Service Level Agreement) when all of its subclients have at least one successful backup during the number of days specified at the CommCell, Server Group or plan level.
useSystemDefaultSLA booleanFlag to set to use System Default Service Level Agreement
inheritedSLAPeriod int32Inherited SLA Period in Days
inheritedFrom stringPossible values: [
COMMCELL
]Tells us from where SLA Period was inherited
SLAPeriod int32SLA Period in Days
excludeFromSLA booleanFlag to set to exclude plan from SLA
enableAfterDelay int32Time provided in Unix format. Give 0 to reset any existing delay.
exclusionReason stringReason for exclusion from SLA
logSLAMinutes int32Database log SLA period in Minutes
- regionsConfigured boolean
Specifies if the destinations are associated to regions
backupDestinations object[]
planBackupDestination object
id int32name stringisDefault booleanIs this a default backup destination?
copyTypePossible values: [
SYNCHRONOUS
,SELECTIVE
,PRIMARY
]copyTypeNamePossible values: [
DEFAULT_MIRROR
,DEFAULT_VAULT_REPLICA
,MIRROR
,VAULT_REPLICA
,SNAPSHOT_PRIMARY
]copyPrecedence int32Order of 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 stringstorageType StorageTypePossible values: [
ALL
,DISK
,CLOUD
,HYPERSCALE
,TAPE
]sourceCopy object
id int32name stringregion object
id int32name stringdisplayName stringenableDataAging booleanTells if this copy has data aging enabled
retentionPeriodDays int32Possible values:
>= 1
and<= 9999
Retention period in days
overrideRetentionSettings booleanTells 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.
- allowPlanOverride boolean
Flag to enable overriding of plan
overrideRestrictions object
To allow the derived plans that use this plan as the base plan to override the settings, property allowPlanOverride must be true, and then select one of the options for Storage pool, RPO and Archiving rules.
storagePool stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]RPO stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]archivingRules stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]inheritSettings object
basePlan object
id int32name stringstoragePool object
overrideBase stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]overridden booleanFlag telling if this setting is currently being overriden
RPO object
overrideBase stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]overridden booleanFlag telling if this setting is currently being overriden
archivingRules object
overrideBase stringPossible values: [
OPTIONAL
,MUST
,NOT_ALLOWED
]overridden booleanFlag telling if this setting is currently being overriden
associatedEntities object[]
id int32name stringcount int32permissions object[]
id int32name stringarchivingServicePolicy object
Create Archiving Service Policy Model for Archive Plan
policyId stringArchiving service policy id
tags stringTag ids
{
"plan": {
"id": 0,
"name": "string"
},
"archivingRules": {
"fileTimestampMethod": "LAST_MODIFIED",
"fileTimestamp": 90,
"fileSize": 1,
"afterArchiving": "REPLACE_FILE_WITH_STUB"
},
"rpo": {
"backupFrequency": {
"scheduleFrequencyType": "DAILY",
"frequency": 1,
"weeklyDays": [
"SUNDAY"
],
"dayOfMonth": 0,
"weekOfMonth": "FIRST",
"dayOfWeek": "SUNDAY",
"monthOfYear": "JANUARY",
"startTime": 75600
},
"backupWindow": [
{
"dayOfWeek": [
"SUNDAY"
],
"startTime": 0,
"endTime": 0
}
],
"SLA": {
"useSystemDefaultSLA": true,
"inheritedSLAPeriod": 0,
"inheritedFrom": "COMMCELL",
"SLAPeriod": 0,
"excludeFromSLA": true,
"enableAfterDelay": 0,
"exclusionReason": "string",
"logSLAMinutes": 0
}
},
"regionsConfigured": true,
"backupDestinations": [
{
"planBackupDestination": {
"id": 0,
"name": "string"
},
"isDefault": 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"
},
"enableDataAging": true,
"retentionPeriodDays": 0,
"overrideRetentionSettings": true
}
],
"allowPlanOverride": true,
"overrideRestrictions": {
"storagePool": "OPTIONAL",
"RPO": "OPTIONAL",
"archivingRules": "OPTIONAL"
},
"inheritSettings": {
"basePlan": {
"id": 0,
"name": "string"
},
"storagePool": {
"overrideBase": "OPTIONAL",
"overridden": true
},
"RPO": {
"overrideBase": "OPTIONAL",
"overridden": true
},
"archivingRules": {
"overrideBase": "OPTIONAL",
"overridden": true
}
},
"associatedEntities": [
{
"id": 0,
"name": "string",
"count": 0
}
],
"permissions": [
{
"id": 0,
"name": "string"
}
],
"archivingServicePolicy": {
"policyId": "string",
"tags": "string"
}
}
Requested Details not found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}