Spectra Logic

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

Get Job

Description

Get information about a specified job. The Status parameter designates whether the job is IN_PROGRESS, COMPLETED, or CANCELED. Jobs that have completed or been canceled are automatically cleared after 30 days. A user can explicitly cancel a job or the gateway can automatically cancel a job when internal timeouts are reached due to client inactivity. If you want to update the heartbeat for a job, so that it does not timeout, use Modify Job.

Requests

Syntax

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

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

Responses

Response Elements

<MasterObjectList
   Aggregating="TRUE|FALSE"
   BucketName="{string}"
   CachedSizeInBytes="{64-bit integer}"    ChunkClientProcessingOrderGuarantee="IN_ORDER|NONE"    CompletedSizeInBytes="{64-bit integer}"
   JobId="{string}"
   Naked="TRUE|FALSE"
   Name="{string}"
   OriginalSizeInBytes="{64-bit integer}"
   Priority="CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND"
   RequestType="GET|PUT|VERIFY"
   StartDate="YYYY-MM-DDThh:mm:ss.xxxZ"
   Status="IN_PROGRESS|COMPLETED|CANCELED"
   UserId="{string}"
   UserName="{string}">
   <Nodes>
      <Node EndPoint="{string}" Id="{string}"/>
   </Nodes>

   <Objects
      ChunkId="{string}"
      ChunkNumber="{32-bit integer}">
      <Object InCache="TRUE|FALSE" Latest="TRUE|FALSE"          Length="{64-bit integer}" Name="{string}"
          Offset="{64-bit integer}" Version="{64-bit integer}"/>
      ...
   </Objects>
   ...
</MasterObjectList>

where the response elements are defined as follows:

Parameter	Description
MasterObjectList	The container for the response.
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
BucketName	The name 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.
JobId	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
RequestType	Type of job request. Values: GET, PUT, VERIFY
StartDate	The date and time the job was started in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Status	The current status of the job. Values: § IN_PROGRESS — The job is currently running. § COMPLETED — The job completed. § CANCELED — The job was canceled by the user or automatically due to internal timeouts.
UserId	The UUID for the user who initiated the job.
UserName	The username of the user who initiated the job.
Nodes	A container for information about all BlackPearl nodes.
Node	A container for information about a single BlackPearl node.
EndPoint	The IP address or DNS name of the BlackPearl node.
Id	The UUID for the node.
Objects	Container for information about the objects in one chunk.
ChunkId	The UUID for the job chunk.
ChunkNumber	The position of the chunk within the job.
Object	The container for information about a single object.
InCache	Indicates if the object is currently in cache on the BlackPearl Deep Storage Gateway. Values: TRUE, FALSE
Latest	Whether this version of the object is the latest. Values: TRUE, FALSE
Length	The length in bytes of the object.
Name	The name of the object.
Offset	The offset in bytes from the start of the object.
Version	The version number of the object.

Example

Sample Request

This request GETs the parameters for the job with the UUID 7761fe8b-0bdc-4ce0-839e-4b1fa3c50cf4.

GET http://blackpearl-hostname/_rest_/job/7761fe8b-0bdc-4ce0-839e-4b1fa3c50cf4 HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<MasterObjectList
   Aggregating="FALSE"
   BucketName="default_bucket_name"
   CachedSizeInBytes="0"
   ChunkClientProcessingOrderGuarantee="IN_ORDER"
   CompletedSizeInBytes="0"
   JobId="b5604de7-904e-4577-987b-4b65c24096e6"
   Naked="FALSE"
   Name="Untitled"
   OriginalSizeInBytes="0" Priority="URGENT" RequestType="PUT"
   StartDate="2015-10-07T22:33:27.000Z" Status="IN_PROGRESS"
   UserId="4c8fc543-e33b-494c-adfb-870747296bd0"
   UserName="default_user_name">
   <Nodes>
      <Node EndPoint="blackpearl-hostname"
      Id="b145fe8d-7019-4beb-b2b7-76d3994516be"/>
   </Nodes>
   <Objects ChunkId="a846352f-1936-4a63-b8a5-17f497847795"
      ChunkNumber="1">
        <Object InCache="FALSE" Latest="TRUE" Length="10"            Name="o1" Offset="0" Version="1"/>
   </Objects>
</MasterObjectList>