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}​​[&always_force_put_job_creation=TRUE|​​FALSE]​​[&always_minimize_spanning_across_media=TRUE|​​FALSE]​​[&blobbing_enabled=TRUE|​​FALSE]​[&checksum_type=CRC_32|​​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_after_write=TRUE|​​FALSE]​[&default_verify_job_priority=URGENT|​​HIGH|​​NORMAL|​​LOW]​​[&end_to_end_crc_required=TRUE|​​FALSE]​​[&max_versions_to_keep={32-bit integer}]​[&rebuild_priority=URGENT|​​HIGH|​​NORMAL|​​LOW]​[&versioning=NONE|​​KEEP_LATEST|​​KEEP_MULTIPLE_VERSIONS]

Request Parameters 

Parameter	Description	Required
name	The name for the data policy.	yes
always_minimize_ spanning_across_media	Whether all PUT jobs created using this data policy are configured to minimize spanning across tape media. Minimizing spanning across media is useful when you plan to eject tapes and it is likely that you will retrieve all objects from the PUT job in a single GET job. With this setting, you may only need to import one ejected tape, rather than many tapes, when servicing a GET job. Notes:   § This setting only applies to tape partitions. § For jobs less than or equal to 1 TB in size, there is an absolute guarantee that the data from the job will never span across multiple tapes. For larger jobs, spanning is minimized, but not completely prevented. You can further reduce the probability of spanning across media by using the CAPACITY write optimization for the storage domains. § Minimizing spanning across media may reduce capacity utilization and performance. Values: TRUE, FALSE (default)	no
always_force_put_ job_creation	Whether all PUT jobs created for this data policy are created even if one or more replication targets the BlackPearl system must PUT to are unavailable, or if there are global issues that would likely prevent the completion of the job. Note: Using this parameter is discouraged, and using it for jobs on both the source and target BlackPearl systems at the same time is extremely discouraged. Running jobs on both systems when they are not able to communicate with each other can create replication conflicts that must be manually resolved. Values: TRUE, FALSE (default)	no
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_32, CRC_32C, MD5 (default), SHA_256, SHA_512 Notes:   § CRC_32, MD5, and SHA-512 perform the best for their corresponding cryptographic strengths on the BlackPearl system. § Using SHA-256 or SHA-512 will reduce single stream performance and may reduce throughput capabilities of the BlackPearl system.	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: 100 GB	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_ after_write	Whether data is verified by default after it is written. Values: TRUE, FALSE	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. Verify jobs can be interrupted every 30 minutes if a job with a higher priority is received. 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 (default)	no
max_versions_to_ keep	The number of versions of an object to keep if versioning=KEEP_MULTIPLE_VERSIONS. The default is 1000.	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 . § 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 written in compliance with the data policy, and then the old version is deleted. § KEEP_MULTIPLE_VERSIONS — Multiple versions of the object, up to the number specified by max_versions_to_ keep are retained. 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 system 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>
   <AlwaysForcePutJobCreation>
      TRUE|FALSE
   </AlwaysForcePutJobCreation>
   <AlwaysMinimizeSpanningAcrossMedia>
      TRUE|FALSE
   </AlwaysMinimizeSpanningAcrossMedia>
   <BlobbingEnabled>TRUE|FALSE</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>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
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 default preferred 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
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
DefaultVerifyAfterWrite	Whether data is verified by default after it is written. Values: TRUE, FALSE
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 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>
   <AlwaysForcePutJobCreation>FALSE</AlwaysForcePutJobCreation>
   <AlwaysMinimizeSpanningAcrossMedia>
      FALSE
   </AlwaysMinimizeSpanningAcrossMedia>
   <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>
   <MaxVersionsToKeep>1000</MaxVersionsToKeep>
   <Name>policy1</Name>
   <RebuildPriority>LOW</RebuildPriority>
   <Versioning>NONE</Versioning>
</Data>