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

Get DS3 Target Data Policies

Description

Get all data policies for the specified DS3 target.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/ds3_target_data_policies/{DS3 target UUID, name, or other unique attribute}/

To determine the UUID for a DS3 target, see Get DS3 Targets.

Responses

Response Elements

<Data>
   <DataPolicy>
      <AlwaysForcePutJobCreation>
         TRUE|FALSE
      </AlwaysForcePutJobCreation>
      <AlwaysMinimizeSpanningAcrossMedia>
         TRUE|FALSE
      </AlwaysMinimizeSpanningAcrossMedia>
      <BlobbingEnabled>TRUE</BlobbingEnabled>
      <ChecksumType>
         CRC_32|CRC_32C|MD5|SHA_256|SHA_512
      </ChecksumType>

      <CreationDate>YYYY-MM-DDThh:mm:ss.xxxZ</CreationDate>
      <DefaultBlobSize>{64‑bit integer}</DefaultBlobSize>
      <DefaultGetJobPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </DefaultGetJobPriority>
      <DefaultPutJobPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </DefaultPutJobPriority>

      <DefaultVerifyAfterWrite>
         TRUE|FALSE
      </DefaultVerifyAfterWrite>
      <DefaultVerifyJobPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </DefaultVerifyJobPriority>

      <EndToEndCrcRequired>TRUE|FALSE</EndToEndCrcRequired>
      <Id>{string}</Id>
      <MaxVersionsToKeep>{32‑bit integer}</MaxVersionsToKeep>
      <Name>{string}</Name>
      <RebuildPriority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </RebuildPriority>
      <Versioning>
         NONE|KEEP_LATEST|KEEP_MULTIPLE_VERSIONS
      </Versioning>

   </DataPolicy>

   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
DataPolicy	The container for information about one data policy.
AlwaysForcePutJobCreation	Whether all PUT jobs created for this data policy are created even if one or more storage domains and/or replication targets the BlackPearl system must PUT to is unavailable, or if there are global issues that would likely prevent the completion of the job. Values: TRUE, FALSE
AlwaysMinimize SpanningAcross Media	Whether all PUT jobs created for this data policy are created to minimize spanning across media. Values: TRUE, FALSE. See always_minimize_ spanning_across_media.
BlobbingEnabled	Whether or not blobbing is enabled.
ChecksumType	Type of checksum used to verify data integrity for any operations involving this data policy. Values: CRC_32, CRC_32C, MD5, SHA_256, SHA_512
CreationDate	The date and time the data policy was created in the format YYYY-MM-DDThh:mm:ss.xxxZ.
DefaultBlobSize	The maximum blob size.
DefaultGetJob Priority	The default GET job priority for the data policy. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
DefaultVerifyAfterWrite	Whether data is verified by default after it is written. Values: TRUE, FALSE
DefaultPutJob Priority	The default PUT job priority for the data policy. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
DefaultVerifyJob Priority	The default verify job priority for the data policy. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
EndToEndCrc Required	Whether or not clients are required to compute and send an end-to-end CRC. Values: TRUE, FALSE
Id	The UUID for the data policy.
MaxVersionsTo Keep	The number of versions of an object to keep if versioning=KEEP_MULTIPLE_VERSIONS.
Name	The name of the data policy.
RebuildPriority	The rebuild priority for the data policy. The rebuild priority determines the relative priority compared to other jobs being processed. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
Versioning	The mode of versioning used by the data policy. Values: NONE, KEEP_LATEST, KEEP_MULTIPLE_VERSIONS see versioning.

Example

Sample Request

This request gets information about all data policies on the target named ‘target1’.

GET http://blackpearl-hostname/_rest_/ds3_target_data_policies/target1 HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <DataPolicy>
      <AlwaysForcePutJobCreation>FALSE</AlwaysForcePutJobCreation>
      <AlwaysMinimizeSpanningAcrossMedia>
         FALSE
      </AlwaysMinimizeSpanningAcrossMedia>
      <BlobbingEnabled>TRUE</BlobbingEnabled>
      <ChecksumType>MD5</ChecksumType>
      <CreationDate>2015-07-29 16:26:12.768</CreationDate>
      <DefaultBlobSize/>
      <DefaultGetJobPriority>HIGH</DefaultGetJobPriority>
      <DefaultPutJobPriority>NORMAL</DefaultPutJobPriority>

      <DefaultVerifyAfterWrite>FALSE</DefaultVerifyAfterWrite>
      <DefaultVerifyJobPriority>LOW</DefaultVerifyJobPriority>
      <EndToEndCrcRequired>FALSE</EndToEndCrcRequired>
      <Id>43d40cce-bb94-4b73-a504-8811f37d8012</Id>
      <MaxVersionsToKeep>1000</MaxVersionsToKeep>
      <Name>policy1</Name>
      <RebuildPriority>LOW</RebuildPriority>
      <Versioning>NONE</Versioning>
   </DataPolicy>
   ...
</Data>