Spectra Logic

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

Get Data Planner Blob Store Tasks

Description

Get the actively in progress tasks the gateway is processing in the backend. If the full details flag is specified, this also includes all queued work in the backend.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/blob_store_task/[?full_details]

Request Parameters 

Parameter	Description	Required
full_details	If included, all tasks are reported, without it, only tasks that are pending execution or execution in progress are reported.	no

Responses

Response Elements

<Data>
   <Tasks>
      <DateScheduled>{YYYY-MM-DDThh:mm:ss.xxxZ}</DateScheduled>
      <DateStarted>{YYYY-MM-DDThh:mm:ss.xxxZ}</DateStarted>
      <Description>{string}</Description>
      <Id>{64-bit integer}</Id>
      <Name>{string}</Name>
      <Priority>

         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </Priority>
      <State>
         COMPLETED|IN_PROGRESS|NOT_READY|PENDING_EXECUTION|READY
      </State>
      <TapeId>{string}</TapeId>
      <PoolId>{string}</PoolId>
   </Tasks>

   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Tasks	The container for information about one task.
DateScheduled	The date and time the task was scheduled by the data planner in the format YYYY-MM-DDThh:mm:ss.xxxZ.
DateStarted	The date and time the task execution started in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Description	A description of the task.
Id	The ID for the task. This is only useful to the gateway.
Name	The name of the task.
Priority	The task priority. This determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
State	The state of the task. Values: § COMPLETED —The task is complete and its resources may be released and re-used for another task. § IN_PROGRESS — The task is being executed. § NOT_READY — The task is temporarily suspended (likely due to too many failures in a row) or otherwise not ready and cannot be executed at this time. § PENDING_EXECUTION — The task is scheduled for immediate execution, with all required resources locked and provisioned, so that execution may begin imminently. § READY — The task is ready for execution once all required resources are available.
TapeId	The UUID for the tape acted on by the task, if applicable.
PoolId	The UUID for the pool acted on by the task, if applicable.

Example

Sample Request

This request gets information about all data planner blob store tasks.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <Tasks>
      <DateScheduled>2015-11-23T16:29:51.000Z</DateScheduled>

      <DateStarted>2015-11-23T17:12:15.000Z</DateStarted>
      <Description>
          Inspect Tape 3b682d17-3f7b-4f69-9f13-7dd2b7577c7c
      </Description>
      <DriveId>31269ab2-2bca-45c3-b9dd-e13b55cfae86</DriveId>
      <Id>41</Id>
      <Name>InspectTapeTask</Name>
      <Priority>LOW</Priority>
      <State>IN_PROGRESS</State>
      <TapeId>3b682d17-3f7b-4f69-9f13-7dd2b7577c7c</TapeId>
   </Tasks>
</Data>