Spectra Logic

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

Get Active Job

Description

Get information about the specified active job.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/active_job/{job UUID or other unique identifier}/

To determine the UUID for a job, see Get Active Jobs.

Responses

Response Elements

<Data>
   <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>
   <ImplicitJobIdResolution>TRUE|FALSE</ImplicitJobIdResolution>
   <MinimizeSpanningAcrossMedia>
      TRUE|FALSE
   </MinimizeSpanningAcrossMedia>
   <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>
</Data>

 

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Aggregating	Whether the job can have additional PUTs or GETs appended to it. Jobs aggregate if created with the aggregating request parameter set to TRUE, or if created by the BlackPearl system in response to Amazon S3 PUT and GET requests. 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 Converged Storage System 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.
ImplicitJobId Resolution	Whether GET or PUT requests that are part of this job determine the job ID implicitly (TRUE), or must specify the job ID (FALSE). Values: TRUE, FALSE
MinimizeSpanningAcrossMedia	Whether the PUT job was configured to minimize spanning across media. Values: TRUE, FALSE.
Naked	Whether the job was created as the result of a native S3 command (TRUE) or a Create Bulk 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 assigned resources and processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
Rechunked	The date and time, in the format YYYY-MM-DDThh:mm:ss.xxxZ, 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 BlackPearl system determines that some of the blobs cannot be retrieved (for example, all media containing a blob has been ejected), in which case the system 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 information about the active job with the UUID 874735d1-3526-4e22-ae21-c3203b03745c.

GET http://blackpearl-hostname/_rest_/active_job/874735d1-3526-4e22-ae21-c3203b03745c HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Aggregating>FALSE</Aggregating>
   <BucketId>cf8f4bf7-9bf0-4355-b6a7-94d928bf939e</BucketId>
   <CachedSizeInBytes>0</CachedSizeInBytes>
   <ChunkClientProcessingOrderGuarantee>
      IN_ORDER
   </ChunkClientProcessingOrderGuarantee>
   <CompletedSizeInBytes>0</CompletedSizeInBytes>
   <CreatedAt>2016-05-19T00:48:10.000Z</CreatedAt>
   <ErrorMessage/>
   <Id>874735d1-3526-4e22-ae21-c3203b03745c</Id>
   <ImplicitJobIdResolution>FALSE</ImplicitJobIdResolution>
   <MinimizeSpanningAcrossMedia>
      FALSE
   </MinimizeSpanningAcrossMedia>
   <Naked>FALSE</Naked>
   <Name>Untitled</Name>
   <OriginalSizeInBytes>0</OriginalSizeInBytes>
   <Priority>URGENT</Priority>
   <Rechunked/>
   <RequestType>PUT</RequestType>
   <Truncated>FALSE</Truncated>
   <UserId>e53eb0fe-21bd-42d3-817c-a3810bc72af3</UserId>
</Data>