Spectra Logic

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

Get Data Persistence Rules

Description

Get information about all data persistence rules. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/data_persistence_rule​[?data_policy_id={string}]​[&isolation_level=STANDARD|BUCKET_ISOLATED][&last_page]​[&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}][&state=NORMAL]​[&storage_domain_id={string}][&type=PERMANENT|TEMPORARY|RETIRED]

Request Parameters 

Parameter	Description	Required
data_policy_id	Data policy UUID or other unique attribute.	no
isolation_level	The level of physical isolation required for the data retention. Values: STANDARD, BUCKET_ISOLATED See isolation_level for descriptions.	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of data persistence rules to list. Default: all items after page_offset.	no
page_offset	The starting point for the first data persistence rule to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
state	The state of the persistence rule. Value: NORMAL — The persistence rule is in a normal, included state.	no
storage_domain_id	Storage domain UUID or other unique attribute.	no
type	The type of persistence rule. Values: PERMANENT, RETIRED, TEMPORARY. See Type for descriptions.	yes

Responses

Response Elements

<Data>
   <DataPersistenceRule>
      <DataPolicyId>{string}</DataPolicyId>
      <Id>{string}</Id>
      <IsolationLevel>STANDARD|BUCKET_ISOLATED</IsolationLevel>
      <MinimumDaysToRetain>{32‑bit integer}</MinimumDaysToRetain>
      <State>NORMAL|INCLSUION_IN_PROGRESS</State>
      <StorageDomainId>{string}</StorageDomainId>
      <Type>PERMANENT|TEMPORARY|RETIRED</Type>
   </DataPersistenceRule>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
DataPersistence Rule	The container for information about one data persistence rule.
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 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. Value: 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, RETIRED. See Type for descriptions.

Example

Sample Request

This request gets information about all data persistence rules on the BlackPearl system.

GET http://blackpearl-hostname/_rest_/data_persistence_rule/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <DataPersistenceRule>
      <DataPolicyId>
         b1b60034-046d-4006-8fb0-dc73188d1d66
      </DataPolicyId>
      <Id>b67587bb-d7a9-4f7a-85e1-f7010760053a</Id>
      <IsolationLevel>STANDARD</IsolationLevel>
      <MinimumDaysToRetain/>
      <State>NORMAL</State>
      <StorageDomainId>
         b843e63a-e718-4350-a8e7-56600b91547a
      </StorageDomainId>
      <Type>PERMANENT</Type>

   </DataPersistenceRule>

   ...
</Data>