Get Object Store Plan Details

Select

SaaS

Customer Managed

Get Object Store Plan details

Path Parameters

planId int32 required
Id of the object store plan to fetch details

Responses

Success

application/json

Schema
Example (from schema)

Schema

plan object
id int32
name string
backupDestinationIds int32[]
Primary Backup Destination Ids associated to this plan.
backupDestinations object[]
Backup destinations for the plan
planBackupDestination object
id int32
name string
backupDestinationName string
Backup destination name
storagePool object
id int32
Id of Storage Pool
name string
Name of Storage Pool
type
Possible values: [DEDUPLICATION, SECONDARY_COPY, NON_DEDUPLICATION, SCALE_OUT]
Type of Storage Pool
retentionPeriodDays int32
Retention period of pool in days
wormStoragePoolFlag int32
Bit 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 object
id int32
Device Type Id of the storage.
name string
Possible values: [DEFAULT, MAGNETIC, AMAZON_S3, MICROSOFT_AZURE_STORAGE, NIRVANIX_MFS, RACKSPACE_CLOUD_FILES, IRON_MOUNTAIN_ARCHIVE, EMC_ATMOS, ATT_SYNAPTIC, CV_OBJECT_SERVER, HITACHI_CONTENT_PLATFORM, MEZEO_CS, OPENSTACK_OBJECT_STORAGE, AMPLIDATA, CHINA_MOBILE_ONEST, HDFS, VERIZON_CLOUD, GOOGLE_CLOUD_STORAGE, VMWARE_CLOUD, ORACLE_STORAGE_CLOUD_SERVICE, ORACLE_STORAGE_CLOUD_ARCHIVE_SERVICE, ALIBABA_CLOUD_OBJECT_STORAGE_SERVICE, HUAWEI_OBJECT_STORAGE, ORACLE_CLOUD_INFRASTRUCTURE_OBJECT_STORAGE_S3, ORACLE_CLOUD_INFRASTRUCTURE_OBJECT_STORAGE, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, ORACLE_CLOUD_INFRASTRUCTURE_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_STORAGE, CARINGO_CASTOR, DELL_DX_OBJECTSTORAGE, AMAZON_GLACIER, DDN_WOS, GENERIC_HARDWARE_DEDUPE_DEVICE, BOOST_HARDWARE_DEDUPE_DEVICE, HPE_CATALYST_STORAGE, 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_CLOUD_PLATOFORM_CLOUD_SCALE, IBM_CLOUD_OBJECT_STORAGE_S3, NETAPP_STORAGEGRID, CCL_VAULT_V2, SCALITY_RING, WASABI_HOT_CLOUD_STORAGE, NUTANIX_OBJECTS, NETAPP_ONTAP_S3, HITACHI_CLOUD_SCALE, PURE_STORAGE_FLASHBLADE, VAST_DATA, METALLIC_RECOVERY_RESERVE, METALLIC_RECOVERY_RESERVE_AZURE_HOT, METALLIC_RECOVERY_RESERVE_AZURE_COOL, METALLIC_RECOVERY_RESERVE_OCI_STANDARD, METALLIC_RECOVERY_RESERVE_OCI_INFREQUENT_ACCESS, METALLIC_BUNDLED_STORAGE_O365, METALLIC_BUNDLED_STORAGE_ENDPOINT, METALLIC_BUNDLED_STORAGE__SALESFORCE, METALLIC_BUNDLED_STORAGE_D365, METALLIC_BUNDLED_STORAGE_AZURE_AD, METALLIC_BUNDLED_STORAGE_AZURE_MAAS, MICROSOFT_AZURE_MANAGEMENT, MICROSOFT_AZURE_MANAGEMENT_BLOB, MICROSOFT_AZURE_MANAGEMENT_FILE]
Device type of the storage.
storageClass string
Possible 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 class of the Storage Pool
isArchiveStorage boolean
Flag indicating whether the storage tier is archive.
region object
id int32
name string
displayName string
storageType StorageType
Possible values: [ALL, DISK, CLOUD, HYPERSCALE, TAPE]
retentionPeriodDays int32
Possible values: >= 1 and <= 9999
Retention period in days. -1 can be specified for infinite retention.
enableDataAging boolean
Tells if this copy has data aging enabled
copyPrecedence int32
Order of backup destination copy created in storage policy
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.
isDefault boolean
Is this a default backup destination?
isSnapCopy boolean
Is this a snap copy?
useExtendedRetentionRules boolean
Use extended retention rules
extendedRetentionRules object
If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.
firstExtendedRetentionRule object
isInfiniteRetention boolean
If this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32
If this is set, no need to specify isInfiniteRetention as false.
type 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.
secondExtendedRetentionRule object
isInfiniteRetention boolean
If this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32
If this is set, no need to specify isInfiniteRetention as false.
type 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.
thirdExtendedRetentionRule object
isInfiniteRetention boolean
If this is set as true, no need to specify retentionPeriodDays.
retentionPeriodDays int32
If this is set, no need to specify isInfiniteRetention as false.
type 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.
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
schedules object[]
scheduleId int32
Id of the schedule if available, required for modifying, deleting schedule
scheduleName string
Name of the schedule, for modify
policyId int32
Schedule policy Id to which the schedule belongs
scheduleOperation string
Possible values: [ADD, DELETE, MODIFY]
Default value: MODIFY
Operation being performed on schedule
vmOperationType string
Possible values: [PLANNED_FAILOVER, TEST_BOOT]
Type of DR operation (only applicable for Failover groups)
backupType string
Possible values: [FULL, INCREMENTAL, DIFFERENTIAL, SYNTHETICFULL, TRANSACTIONLOG]
Schedule Backup level
forDatabasesOnly boolean
Default value: false
Boolean to indicate if schedule is for database agents
isRetentionBasedSyntheticFull boolean
Default value: false
Boolean to indicate if synthetic full schedule is based on retention rules
schedulePattern object
Used to describe when the schedule runs
scheduleFrequencyType string
Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY, AUTOMATIC]
schedule frequency type
frequency int32
Possible values: >= 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 int32
Possible values: >= 1 and <= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth string
Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]
Specific week of a month
dayOfWeek string
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]
monthOfYear string
Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]
repeatIntervalInMinutes int32
Possible values: >= 1
How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.
repeatUntilTime int32
Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes
timezone object
id int32
name string
startTime int32
Default value: 75600
start time of schedule in seconds
startDate int32
start date of schedule in epoch format
endDate int32
Schedule end date in epoch format
noOfTimes int32
The number of times you want the schedule to run.
exceptions object[]
Exceptions to when a schedule should not run, either in dates or week of month and days
onDates int32[]
Possible values: >= 1 and <= 31
list of dates in a month. For ex: 1, 20
onWeekOfTheMonth string[]
Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]
On which week of month, for ex: FIRST, LAST
onDayOfTheWeek string[]
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]
On which days, for ex: MONDAY, FRIDAY
daysBetweenSyntheticFulls int32
Possible values: >= 6
No of days between two synthetic full jobs
maxBackupIntervalInMins int32
Default value: 240
The number of mins to force a backup on automatic schedule.
scheduleOption object
Specific options to be set on schedules
useDiskCacheForLogBackups boolean
Used to enable disk caching feature on databases for automatic schedules on server plan
commitFrequencyInHours int32
Commit frequency in hours for disk cache backups from automatic schedules
daysBetweenAutoConvert int32
Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan
o365ItemSelectionOption string
Possible values: [SELECT_ALL, SELECT_NEVER_PROCESSED, SELECT_MEETING_SLA, SELECT_NOT_MEETING_SLA_PROCESSED_ATLEAST_ONCE, SELECT_FAILED_LAST_ATTEMPT, SELECT_PROCESSED_ATLEAST_ONCE, SELECT_NOT_MEETING_SLA, SELECT_MEETING_SLA_NOT_RECENTLY_BACKED_UP]
item backup option for O365 V2 backup jobs
jobRunningTimeInMins int32
total job running time in minutes
minBackupIntervalInMins int32
Default value: 15
The min number of mins to check for file activity on automatic schedule.
logFilesThreshold int32
Default value: 50
The min number of archived log files before a backup job should start
logsDiskUtilizationPercent int32
Default value: 80
The min log destination disk threshold percentage
additionalInfo string
operationType string
Possible values: [ADD, MODIFY, DELETE, NONE, OVERWRITE]
Operation type for the list
fullBackupWindow object[]
Backup window for full backup
dayOfWeek string[]
Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
startTime int64
Time in seconds since the beginning of the day
endTime int64
Time 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 boolean
Flag to set to use System Default Service Level Agreement
inheritedSLAPeriod int32
Inherited SLA Period in Days
inheritedFrom string
Possible values: [COMMCELL]
Tells us from where SLA Period was inherited
SLAPeriod int32
SLA Period in Days
excludeFromSLA boolean
Flag to set to exclude plan from SLA
enableAfterDelay int32
Time provided in Unix format. Give 0 to reset any existing delay.
exclusionReason string
Reason for exclusion from SLA
logSLAMinutes int32
Database log SLA period in Minutes
permissions object[]
id int32
name string

{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupDestinationIds": [
    0
  ],
  "backupDestinations": [
    {
      "planBackupDestination": {
        "id": 0,
        "name": "string"
      },
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string",
        "type": "DEDUPLICATION",
        "retentionPeriodDays": 0,
        "wormStoragePoolFlag": 0,
        "deviceType": {
          "id": 0,
          "name": "DEFAULT"
        },
        "storageClass": "DEFAULT",
        "isArchiveStorage": true,
        "region": {
          "id": 0,
          "name": "string",
          "displayName": "string"
        }
      },
      "storageType": "ALL",
      "retentionPeriodDays": 0,
      "enableDataAging": true,
      "copyPrecedence": 0,
      "backupsToCopy": "All_JOBS",
      "isDefault": true,
      "isSnapCopy": true,
      "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"
        }
      }
    }
  ],
  "rpo": {
    "backupFrequency": {
      "schedules": [
        {
          "scheduleId": 0,
          "scheduleName": "string",
          "policyId": 0,
          "scheduleOperation": "MODIFY",
          "vmOperationType": "PLANNED_FAILOVER",
          "backupType": "FULL",
          "forDatabasesOnly": false,
          "isRetentionBasedSyntheticFull": false,
          "schedulePattern": {
            "scheduleFrequencyType": "MINUTES",
            "frequency": 0,
            "weeklyDays": [
              "SUNDAY"
            ],
            "dayOfMonth": 0,
            "weekOfMonth": "FIRST",
            "dayOfWeek": "SUNDAY",
            "monthOfYear": "JANUARY",
            "repeatIntervalInMinutes": 0,
            "repeatUntilTime": 0,
            "timezone": {
              "id": 0,
              "name": "string"
            },
            "startTime": 75600,
            "startDate": 0,
            "endDate": 0,
            "noOfTimes": 0,
            "exceptions": [
              {
                "onDates": [
                  0
                ],
                "onWeekOfTheMonth": [
                  "FIRST"
                ],
                "onDayOfTheWeek": [
                  "SUNDAY"
                ]
              }
            ],
            "daysBetweenSyntheticFulls": 0,
            "maxBackupIntervalInMins": 240
          },
          "scheduleOption": {
            "useDiskCacheForLogBackups": true,
            "commitFrequencyInHours": 0,
            "daysBetweenAutoConvert": 0,
            "o365ItemSelectionOption": "SELECT_ALL",
            "jobRunningTimeInMins": 0,
            "minBackupIntervalInMins": 15,
            "logFilesThreshold": 50,
            "logsDiskUtilizationPercent": 80
          },
          "additionalInfo": "string"
        }
      ],
      "operationType": "ADD"
    },
    "fullBackupWindow": [
      {
        "dayOfWeek": [
          "SUNDAY"
        ],
        "startTime": 0,
        "endTime": 0
      }
    ],
    "SLA": {
      "useSystemDefaultSLA": true,
      "inheritedSLAPeriod": 0,
      "inheritedFrom": "COMMCELL",
      "SLAPeriod": 0,
      "excludeFromSLA": true,
      "enableAfterDelay": 0,
      "exclusionReason": "string",
      "logSLAMinutes": 0
    }
  },
  "permissions": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

Get Object Store Plan Details​

Get Object Store Plan Details