Spectra Logic

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

Get Jobs

Description

Get a list of all jobs currently running. Use the full_details parameter to include jobs completed or canceled in the last 30 days. Use the bucket parameter to return only the jobs involving the specified bucket.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/job[?bucket_id={string}]​[&full_details]

Request Parameters

Parameter	Description	Required
bucket_id a	The UUID, name, or other unique identifier for the bucket on which the job is operating.	no
full_details	If included, the response includes information about jobs completed or canceled in the last 30 days.	no

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

Responses

Response Elements

<Jobs>
   <Job
      Aggregating="TRUE|FALSE"
      BucketName="{string}"
      CachedSizeInBytes="{64‑bit integer}"
      ChunkClientProcessingOrderGuarantee="IN_ORDER|NONE"
      CompletedSizeInBytes="{64‑bit integer}"
      EntirelyInCache="TRUE|FALSE"
      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="CANCELED|COMPLETED|IN_PROGRESS"
      UserId="{string}"
      UserName="{string}">

      <Nodes>
         <Node EndPoint="{string}" Id="{string}"/>
      </Nodes>
   </Job>

   ...
</Jobs>

where the response elements are defined as follows:

Parameter	Description
Jobs	The container for the response.
Job	The container for information about a single job.
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
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 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.
EntirelyInCache	Whether all objects in the job are in the BlackPearl cache. Values: TRUE, FALSE
JobId	The UUID for the job.
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
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.

Example

Sample Request

This request gets a list of all jobs currently running on the BlackPearl Converged Storage System.

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

Sample Response

HTTP/1.1 200 OK
<Jobs>
   <Job
      Aggregating="FALSE"
      BucketName="bucket_name"    
      CachedSizeInBytes="0"
      ChunkClientProcessingOrderGuarantee="IN_ORDER"
      CompletedSizeInBytes="0"
      EntirelyInCache="FALSE"
      JobId="1615f0cf-afee-44e5-9185-640912e4595a"
      Naked="FALSE"
      Name="Untitled"
      OriginalSizeInBytes="0"    
      Priority="URGENT"
      RequestType="GET"
      StartDate="2014-10-02T11:40:11.000Z"
      Status="IN_PROGRESS"
      UserId="91b0c685-a728-4d59-b504-2e53f29a5e70"
      UserName="user_name"
      WriteOptimization="CAPACITY">
      <Nodes>
         <Node    
            EndPoint="blackpearl-hostname"
            Id="08faa8c4-ae11-4c6a-bc02-8986e674b175"/>
      </Nodes>
   </Job>
   ...
</Jobs>