Spectra Logic

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

Create Data Policy

Description

Create a data policy.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/data_policy/?name={string}[&blobbing_enabled=TRUE|FALSE][&checksum_type=CRC| CRC_32C|MD5|SHA_256|SHA_512][&default_blob_size={64-bit integer}] [&default_get_job_priority=URGENT|HIGH|NORMAL|LOW]
[&default_put_job_priority=URGENT|HIGH|NORMAL|LOW] [&default_verify_job_priority=URGENT|HIGH|NORMAL|LOW]

[&end_to_end_crc_required=TRUE|FALSE] [&rebuild_priority=URGENT|HIGH|NORMAL|LOW]
[&versioning=NONE|KEEP_LATEST]

Request Parameters 

Parameter	Description	Required
name	The name for the data policy.	yes
blobbing_enabled	Whether or not to enable blobbing. If enabled, an object can be broken up into multiple blobs (binary large objects). If disabled, an object must always have exactly one blob. Blobbing must be enabled to handle objects larger than 1 TB, to use multi-part upload, or to break up an object into multiple blobs. Disabling blobbing guarantees that an object never spans multiple media (for example, tapes), since a blob cannot span multiple media. Values: TRUE (default), FALSE	no
checksum_type	Specifies the type of checksum used to verify data integrity for data in any bucket using this data policy, and the type of checksum required for end-to-end CRC, if specified. Values: CRC, CRC_32C, MD5 (default), SHA_256, SHA_512 Notes:   § CRC, MD5, and SHA-512 perform the best for their corresponding cryptographic strengths on the BlackPearl gateway. § Using SHA-256 and SHA-512 will reduce single stream performance and may reduce throughput capabilities of the gateway.	no
default_blob_size	Specifies the maximum blob size used when creating bulk PUT jobs. Blob sizes less than 5 MB are strongly discouraged. Blob sizes less than 50 MB are discouraged. The maximum blob size is 1 TB. Default: 100GB	no
default_get_job_ priority	Specifies the default get job priority for the data policy. The job priority determines the resources assigned and the processing order. Jobs with priority URGENT can use up all of the resources and prevent other jobs from making progress. Use this priority sparingly. Values: URGENT, HIGH (default), NORMAL, LOW	no
default_put_job_ priority	Specifies the default put job priority for the data policy. The job priority determines the resources assigned and the processing order. Jobs with priority URGENT can use up all of the resources and prevent other jobs from making progress. Use this priority sparingly. Values: URGENT, HIGH, NORMAL (default), LOW	no
default_verify_job_ priority	Specifies the default verify job priority for the data policy. The job priority determines the resources assigned and the processing order. Jobs with priority URGENT can use up all of the resources and prevent other jobs from making progress. Use this priority sparingly. Values: URGENT, HIGH, NORMAL, LOW (default)	no
end_to_end_crc_ required	Whether or not clients are required to compute and send an end-to-end CRC. Values: TRUE, FALSE	no
rebuild_priority	Specifies the rebuild priority for the data policy. The rebuild priority determines the relative priority compared to other jobs being processed. Values: URGENT, HIGH, NORMAL, LOW (default)	no
versioning	The mode of versioning used by the data policy. Values: § NONE (default) — Only one version of an object may exist at any time and the version number of the object is always 1. § KEEP_LATEST — Only one version of the data is available at a time. When a new version of an object is written, the old version is retained until the new version is fully persisted in compliance with the data policy, and then the old version is deleted. Notes:   § KEEP_LATEST versioning cannot be used for a data policy which uses a storage domain with ltfs_file_naming=OBJECT_NAME (see ltfs_file_naming). § KEEP_LATEST requires that the PUT job for the earlier version of the object complete before the PUT of the latest version of the object with the same name in order for the PUT to succeed. CAUTION: If the PUT of the earlier version is not complete before the PUT of the latest version, the BlackPearl gateway believes the latest version to be the same object as the earlier version and rejects it, so only the earlier version is retained.	no

Responses

Response Elements

<Data>
   <BlobbingEnabled>TRUE|FALSE</BlobbingEnabled>
   <ChecksumType>CRC|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>
   <DefaultVerifyJobPriority>
      CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
   </DefaultVerifyJobPriority>
   <EndToEndCrcRequired>TRUE|FALSE</EndToEndCrcRequired>
   <Id>{string}</Id>
   <LtfsObjectNamingAllowed>TRUE|FALSE</LtfsObjectNamingAllowed>
   <Name>{string}</Name>
   <RebuildPriority>
      CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
   </RebuildPriority>
   <Versioning>NONE|KEEP_LATEST</Versioning>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
BlobbingEnabled	Whether or not to blobbing is enabled.
ChecksumType	Type of checksum used to verify data integrity for any operations involving this data policy. Values: CRC, 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 average 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
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.
LtfsObjectNamingAllowed	Specifies whether the data policy can use storage domains with ltfs_file_naming=OBJECT_NAME (see ltfs_file_naming). If a bucket has objects written into it that violate the LTFS file naming compliance, this is set to FALSE. Values: TRUE, FALSE
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 see versioning.

Example

Sample Request

This request creates a data policy with the name “policy1” that uses all data policy defaults.

POST http://blackpearl-hostname/_rest_/data_policy/?name=policy1 HTTP/1.1

Sample Response

HTTP/1.1 200 OK

<Data>
   <BlobbingEnabled>TRUE</BlobbingEnabled>
   <ChecksumType>MD5</ChecksumType>
   <CreationDate>2015-07-29 16:26:12.305</CreationDate>
   <DefaultBlobSize/>
   <DefaultGetJobPriority>HIGH</DefaultGetJobPriority>
   <DefaultPutJobPriority>NORMAL</DefaultPutJobPriority>
   <DefaultVerifyJobPriority>LOW</DefaultVerifyJobPriority>
   <EndToEndCrcRequired>FALSE</EndToEndCrcRequired>
   <Id>f7eced2d-9080-4722-b866-e8c21271bef9</Id>
   <LtfsObjectNamingAllowed>TRUE</LtfsObjectNamingAllowed>
   <Name>policy1</Name>
   <RebuildPriority>LOW</RebuildPriority>
   <Versioning>NONE</Versioning>
</Data>