Spectra Logic

1-800-833-1132 : 1-303-449-6400

Create Data Persistence Rule

Description

Create a data persistence rule for a data policy. Each data policy must have one or more permanent persistence rules. Each persistence rule targets a specified storage domain. Data is persisted to every storage domain for which there is a persistence rule with type PERMANENT or TEMPORARY at the time the data is written.

The same storage domain cannot be specified multiple times in different persistence rules applied to the same data policy. The same storage domain can be referred to across different data policies.

The data policy and storage domain must be created before the persistence rule. See Create Data Policy and Create Storage Domain.

Note:

If a temporary persistence rule is added to a data policy already applied to a bucket, the data is not necessarily copied to the specified storage domain even if there is existing data within the rule's retention period.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/data_persistence_rule/?data_policy_id={string}&isolation_level=STANDARD|BUCKET_ISOLATED| SECURE_BUCKET_ISOLATED&storage_domain_id={string}&type=PERMANENT| TEMPORARY[&minimum_days_to_retain={unsigned 32-bit integer}]

Request Parameters 

Parameter	Description	Required
data_policy_id	Data policy UUID or other unique attribute.	yes
isolation_level	The level of physical isolation required for the data retention. The STANDARD isolation level provides the best capacity utilization and overall performance. Note: BUCKET_ISOLATED and SECURE_BUCKET_ISOLATED allocate an entire tape or pool to a bucket when needed. Allocating an entire pool to a bucket may use up resources quickly and is not recommended. Values: § STANDARD — Data is isolated according to the standard Storage Domain isolation requirements. § BUCKET_ISOLATED — Data from different buckets can not be mixed on the same physical storage media. § SECURE_BUCKET_ISOLATED — Data from different buckets can not be mixed on the same physical storage media and media cannot be reclaimed into the general pool once assigned to a bucket; it can only be reclaimed for use within the same bucket. Note: This mode should only be used when the user must be certain which media ever contained any data for the bucket, for compliance purposes (usually, to physically destroy the media once the data is no longer needed).	yes
storage_domain_id	Storage domain UUID or other unique attribute.	yes
type	The type of persistence rule. Values: § PERMANENT — A copy of the data is placed in the specified storage domain initially and maintained there permanently. § TEMPORARY — A copy of the data is placed in the specified storage domain initially and maintained there at least until the specified retention period expires. Note: This value is not allowed for a persistence rule targeting a storage domain with a tape partition member.	yes
minimum_days_to_retain	The minimum number of days the data should be retained based on a TEMPORARY persistence rule. Note: The minimum_days_to_retain for a persistence rule targeting a storage domain with a NEARLINE pool (ArcticBlue) storage domain member must be 90 days or greater.	required if type is TEMPORARY

Responses

Response Elements

<Data>
   <DataPolicyId>{string}</DataPolicyId>
   <Id>{string}</Id>
   <IsolationLevel>
      STANDARD|BUCKET_ISOLATED|SECURE_BUCKET_ISOLATED
   </IsolationLevel>
   <MinimumDaysToRetain>{32-bit integer}</MinimumDaysToRetain>
   <State>NORMAL</State>
   <StorageDomainId>{string}</StorageDomainId>
   <Type>PERMANENT|TEMPORARY</Type>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
DataPolicyId	The UUID for the data policy.
Id	The UUID for the persistence rule.
IsolationLevel	The level of physical isolation required for the data retention. Values: STANDARD, BUCKET_ISOLATED, SECURE_BUCKET_ISOLATED See isolation_level for descriptions.
MinimumDaysTo Retain	The minimum number of days the data should be retained based on a TEMPORARY persistence rule.
State	The state of the persistence rule. Values: § NORMAL — The persistence rule is in a normal, included state.
StorageDomainId	The UUID for the storage domain.
Type	The type of persistence rule. Values: PERMANENT, TEMPORARY See type for descriptions.

Example

Sample Request

This request creates a permanent persistence rule with standard isolation level for the data policy with the UUID 044854c9-7557-4136-a374-dddf7c29e370, using the storage domain with the UUID 8ed43978-846a-44c9-8e14-f34179e33a33.

POST http[s]://blackpearl-hostname/_rest_/data_persistence_rule/?data_policy_id={044854c9-7557-4136-a374-dddf7c29e370}&isolation_level=STANDARD&storage_domain_id={8ed43978-846a-44c9-8e14-f34179e33a33}&type=PERMANENT HTTP/1.1

Sample Response

HTTP/1.1 201 OK
<Data>
   <DataPolicyId>
      044854c9-7557-4136-a374-dddf7c29e370
   </DataPolicyId>
   <Id>d8716fda-c2e5-44c6-8bea-713bb147e5e0</Id>
   <IsolationLevel>STANDARD</IsolationLevel>
   <MinimumDaysToRetain/>
   <State>NORMAL</State>
   <StorageDomainId>
      8ed43978-846a-44c9-8e14-f34179e33a33
   </StorageDomainId>
   <Type>PERMANENT</Type>
</Data>