Spectra Logic

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

Get Active Jobs

Description

Get a list of all jobs currently active. Use parameters to return a subset of the jobs.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/active_job/[?aggregating=TRUE|FALSE][&bucket_id={string}] [&chunk_client_processing_order_guarantee=NONE|IN_ORDER] [&last_page][&name={string}][&page_length={32-bit integer}] [&page_offset={32-bit integer}][&page_start_marker={string}] [&priority=CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND] [&rechunked={date}][&request_type=PUT|GET|VERIFY] [&truncated=TRUE|FALSE][&user_id={string}]

Request Parameters

Parameter	Description	Required
aggregating	Whether the job can have additional work appended to it. Jobs can aggregate if they are created with the aggregating request parameter set to TRUE (Naked=FALSE) or if they are created by the BlackPearl gateway in response to Amazon S3 PUT and GET requests (Naked=TRUE). Values: TRUE, FALSE	no
bucket_id a	The UUID, name, or other unique identifier for the bucket on which the job is operating.	no
chunk_client_ processing_order_guarantee	Specifies whether the job chunks must be processed in order. Setting a value of NONE will achieve maximum performance, but requires the client to get chunks as they become available, even if they become available out of order. Values: IN_ORDER, NONE Default: Configured in the data policy for the bucket.	no
last_page	If included, only the last page of results is returned.	no
name	The name assigned to the job.	no
page_length	The maximum number of objects to list. The default is all items after page_offset.	no
page_offset	The starting point for the first object to list. The default is 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page _start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
priority	The priority for processing this job. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND	no
rechunked	The date and time when a chunk of a GET or VERIFY job had to be re-chunked to target other media due to the original target becoming unavailable or corrupt in the format YYYY-MM-DDThh:mm:ss.xxxZ or as the number of seconds that have elapsed since January 1, 1970 at 00:00:00 GM.	no
request_type	Type of job request. Values: GET, PUT, VERIFY	no
truncated	Whether the job was truncated (made smaller) from its original definition. A job is truncated when a PUT job is canceled and objects that haven't been entirely uploaded to cache are deleted from the job so that the job can complete without any further transmission of data from the client. Or, a job is truncated if, when processing a GET or VERIFY job, the gateway determines that some of the blobs cannot be retrieved (for example, all media containing a blob has been ejected), in which case the gateway truncates the parts of the job that it cannot GET or VERIFY. Values: TRUE, FALSE	no
user_id	The UUID, username, or other unique attribute for the user who initiated the job.	no

a.	Parameter values can use wild cards (see Wild Card Syntax).

Responses

Response Elements

<Data>
   <Job>
      <Aggregating>TRUE|FALSE</Aggregating>
      <BucketId>{string}</BucketId>
      <CachedSizeInBytes>{64-bit integer}</CachedSizeInBytes>
      <ChunkClientProcessingOrderGuarantee>
         IN_ORDER|NONE
      </ChunkClientProcessingOrderGuarantee>
      <CompletedSizeInBytes>
         {64-bit integer}
      </CompletedSizeInBytes>
      <CreatedAt>{YYYY-MM-DDThh:mm:ss.xxxZ}</CreatedAt>
      <ErrorMessage>{string}</ErrorMessage>
      <Id>{string}</Id>

      <Naked>TRUE|FALSE</Naked>
      <Name>{string}</Name>
      <OriginalSizeInBytes>{64-bit integer}</OriginalSizeInBytes>
      <Priority>
         CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND
      </Priority>
      <Rechunked>{YYYY-MM-DDThh:mm:ss.xxxZ}</Rechunked>
      <RequestType>GET|PUT|VERIFY</RequestType>
      <Truncated>TRUE|FALSE</Truncated>
      <UserId>{string}</UserId>
   </Job>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Job	The container for information about a single job.
Aggregating	Whether the job can have additional work appended to it. Jobs can aggregate if they are created with the aggregating request parameter set to TRUE (Naked=FALSE) or if they are created by the BlackPearl gateway in response to Amazon S3 PUT and GET requests (Naked=TRUE). Values: TRUE, FALSE
BucketId	The UUID of the bucket that is acted on by the job request.
CachedSizeInBytes	The amount of data that has been transferred to the cache for this job. For RequestType=PUT, this is the amount of data successfully transferred to the BlackPearl Deep Storage Gateway from the client. For RequestType=GET, this the amount of data either in cache originally, or loaded into cache from the permanent data store. For RequestType=VERIFY, this the amount of data loaded into cache from the permanent data store.
ChunkClient ProcessingOrder Guarantee	Specifies whether the job chunks will be processed in order. Values: IN_ORDER, NONE
CompletedSizeIn Bytes	The amount of data that is completely processed for this job. For RequestType=PUT, this indicates the amount of data written to all permanent data stores. For RequestType=GET, this indicates the amount of data that has been read successfully by the client. For RequestType=VERIFY, this indicates the amount of data for which the CRC has been verified.
CreatedAt	The date and time the job was created in the format YYYY-MM-DDThh:mm:ss.xxxZ.
ErrorMessage	A description of the error.
Id	The UUID for the job.
Naked	Whether the job was created as the result of a native S3 command (TRUE) or a Create Get/Put/Verify Job command (FALSE). Values: TRUE, FALSE
Name	The name assigned to the job for tracking.
OriginalSizeInBytes	The full size of the job.
Priority	The priority for processing this job. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
Rechunked	The date and time when a chunk of a GET or VERIFY job had to be re-chunked to target other media due to the original target becoming unavailable or corrupt. If this attribute is null, then the job was not rechunked.
RequestType	Type of job request. Values: GET, PUT, VERIFY
Truncated	Whether the job was truncated (made smaller) from its original definition. A job is truncated when a PUT job is canceled and objects that haven't been entirely uploaded to cache are deleted from the job so that the job can complete without any further transmission of data from the client. Or, a job is truncated if, when processing a GET or VERIFY job, the gateway determines that some of the blobs cannot be retrieved (for example, all media containing a blob has been ejected), in which case the gateway truncates the parts of the job that it cannot GET or VERIFY. Values: TRUE, FALSE
UserId	The UUID for the user who initiated the job.

Example

Sample Request

This request gets a list of all currently active jobs on the BlackPearl Deep Storage Gateway.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <Job>
      <Aggregating>FALSE</Aggregating>
      <BucketId>2e41abd0-e681-4f5f-af2c-724c7b7d60f3</BucketId>
      <CachedSizeInBytes>0</CachedSizeInBytes>
      <ChunkClientProcessingOrderGuarantee>
         IN_ORDER
      </ChunkClientProcessingOrderGuarantee>
      <CompletedSizeInBytes>0</CompletedSizeInBytes>
      <CreatedAt>2015-11-24T02:00:17.000Z</CreatedAt>
      <Id>b053a7a8-8f25-454c-831a-e4d4618a0981</Id>
      <Naked>FALSE</Naked>
      <Name>Untitled</Name>
      <OriginalSizeInBytes>0</OriginalSizeInBytes>
      <Priority>URGENT</Priority>
      <Rechunked/>
      <RequestType>PUT</RequestType>
      <Truncated>FALSE</Truncated>
      <UserId>dc3cf8b0-ab38-4ce9-8d82-789352d71117</UserId>
   </Job>
</Data>