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

Get Data Path Backend

Description

Get information about the data path backend.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/data_path_backend/

Responses

Response Elements

<Data>
   <Activated>TRUE|FALSE</Activated>

   <AllowNewJobRequests>TRUE|FALSE</AllowNewJobRequests>
   <AutoActivateTimeoutInMins>
      {32‑bit integer}
   </AutoActivateTimeoutInMins>
   <AutoInspect>DEFAULT|MINIMAL|NEVER</AutoInspect>
   <CacheAvailableRetryAfterInSeconds>
      {32‑bit integer}
   </CacheAvailableRetryAfterInSeconds>
   <DefaultVerifyDataAfterImport>
      URGENT|HIGH|NORMAL|LOW
   </DefaultVerifyDataAfterImport>
   <DefaultVerifyDataPriorToImport>
      TRUE|FALSE
   </DefaultVerifyDataPriorToImport>
   <Id>{string}</Id>
   <InstanceId>{string}</InstanceId>

   <IomEnabled>TRUE|FALSE</IomEnabled>
   <LastHeartbeat>YYYY-MM-DDThh:mm:ss.xxxZ</LastHeartbeat>
   <PartiallyVerifyLastPercentOfTape>
      {32‑bit integer}
   </PartiallyVerifyLastPercentOfTape>
   <UnavailableMediaPolicy>
       ALLOW|DISCOURAGED|DISALLOW
   </UnavailableMediaPolicy>
   <UnavailablePoolMaxJobRetryInMins>
      {32‑bit integer}
   </UnavailablePoolMaxJobRetryInMins>

   <UnavailableTapePartitionMaxJobRetryInMins>
      {32‑bit integer}
   </UnavailableTapePartitionMaxJobRetryInMins>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Activated	Whether the BlackPearl system is allowed to send to the data path backend (pool or tape partitions). Values: TRUE, FALSE
AllowNewJob Requests	Whether the BlackPearl system allows new jobs to be initiated. Values: TRUE, FALSE
AutoActivate TimeoutInMins	The number of minutes allowed for the data planner to take between when it is shut down and when it comes back up, and have the data path back end automatically activate. If the data planner remains shutdown for longer than this number of minutes, the data path backend will not automatically activate. If this parameter is null, the data path backend will never automatically activate.
AutoInspect	Whether tape inspections are automatically scheduled whenever the data planner starts. Values: DEFAULT, MINIMAL, NEVER See auto_inspect.
CacheAvailable RetryAfterIn Seconds	The recommended number of seconds for clients to wait between sending Get Job Chunks Ready for Processing requests.
DefaultVerifyDataAfterImport	The priority for verifying the data after import. This determines the resources assigned and the processing order. Values: URGENT, HIGH, NORMAL, LOW
DefaultVerifyData PriorToImport	Whether the data must be verified before the tape is imported. Values: TRUE, FALSE Note: It is recommended to verify data prior to import whenever it is possible that the tapes being imported contain objects with the same name as objects already in the bucket. Without verifying data prior to import, it is possible for the existing object to be replaced with the one being imported, even if the one being imported is partially corrupt and cannot be read.
Id	The UUID for the record. This is only useful to the BlackPearl system.
InstanceID	The UUID for the BlackPearl system session.
IomEnabled	Whether Intelligent Object Management (IOM) is enabled.
LastHeartbeat	The date and time that the system last sent a heartbeat in the format YYYY-MM-DDThh:mm:ss.xxxZ.
PartiallyVerifyLastPercentOfTapes	The percentage of the overall tape capacity before the EOD marker that the BlackPearl system verifies during data integrity verification. Verifying a percentage of the tape, rather than the entire tape is useful when you only want to verify the most recent data written to the tape. Values: 1-99 Note: To verify the entire tape, see Verify Tape.
UnavailableMedia Policy	Whether new job requests are allowed to use partitions that are currently unavailable. Values: ALLOW, DISCOURAGE, DISALLOW See unavailable_media_policy.
UnavailablePool MaxJobRetryIn Mins	How long job requests using unavailable pools will retry before being re-chunked or failing if re-chunking cannot solve the problem.
UnavailableTape PartitionMaxJob RetryInMins	How long job requests using unavailable tape partitions will retry before being re-chunked or failing if re-chunking cannot solve the problem.

Example

Sample Request

This request gets information about the data path backend.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <Activated>TRUE</Activated>

   <AllowNewJobRequests>TRUE</AllowNewJobRequests>

   <AutoActivateTimeoutInMins>30</AutoActivateTimeoutInMins>

   <AutoInspect>DEFAULT</AutoInspect>
   <CacheAvailableRetryAfterInSeconds>
      300
   </CacheAvailableRetryAfterInSeconds>
   <DefaultVerifyDataAfterImport/>
   <DefaultVerifyDataPriorToImport>
      TRUE
   </DefaultVerifyDataPriorToImport>
   <Id>7d7601d0-4dba-47a4-8235-8a1ceefe91fa</Id>
   <InstanceId>51db3e63-f63a-4503-8d48-6b8b52d6eb98</InstanceId>
   <IomEnabled>TRUE</IomEnabled>
   <LastHeartbeat>2016-01-21T18:53:55.000Z</LastHeartbeat>

   <PartiallyVerifyLastPercentOfTape>
      15
   </PartiallyVerifyLastPercentOfTape>
   <UnavailableMediaPolicy>DISCOURAGED</UnavailableMediaPolicy>
   <UnavailablePoolMaxJobRetryInMins>
      20
   </UnavailablePoolMaxJobRetryInMins>
   <UnavailableTapePartitionMaxJobRetryInMins>
      20
   </UnavailableTapePartitionMaxJobRetryInMins>
</Data>