Spectra Logic

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

Modify Active Job

Description

Modify the priority or the start date of a job that is in process. Executing this request also resets the heartbeat for the job, so that it does not timeout.

Notes:

§	If an optional request parameter is not included, the previous setting is retained.

§	This command is an alias for Modify Job.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/active_job/{job UUID or unique identifier}[?created_at={date}][&name={string}]​[&priority=URGENT|HIGH|NORMAL|LOW]

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

Request Parameters

Parameter	Description	Required
created_at	The date to set as the StartDate 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
name a	A name to assign to the job for tracking.	no
priority	The priority for processing this job. The job priority determines the assigned resources and processing order. Jobs with priority URGENT can use up all of the resources and prevent other jobs from making progress. Use this priority sparingly. Values: URGENT, HIGH, NORMAL, LOW Default: The previously specified priority.	no

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

Responses

Response Elements

<MasterObjectList
   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="IN_PROGRESS|COMPLETED|CANCELED"
   UserId="{string}"
   UserName="{string}">
   <Nodes>
      <Node
         EndPoint="{string}" Id="{string}"/>
      ...
   </Nodes>
   <Objects
      ChunkId="{string}"
      ChunkNumber="{32‑bit integer}">
      <Object
         Id="{string}"
         InCache="TRUE|FALSE"

         Latest="TRUE|FALSE"
         Length="{64‑bit integer}"
         Name="{string}"
         Offset="{64‑bit integer}"
         Version="{64‑bit integer}"/>

      </Object>
      ...
   </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 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.
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.
Id	The UUID for the object.
InCache	Indicates if the object is currently in cache on the BlackPearl Converged Storage System. 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.
Id	The UUID for the object.

Example

Sample Request

This request modifies the priority of the job with the UUID 0123edab-a4ec-4472-927e-c4df0ac9416b to urgent.

PUT http://blackpearl-hostname/_rest_/job/0123edab-a4ec-4472-927e-c4df0ac9416b?priority=URGENT HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<MasterObjectList
   Aggregating="FALSE"
   BucketName="bucket_name"
   CachedSizeInBytes="0"
   ChunkClientProcessingOrderGuarantee="IN_ORDER"
   CompletedSizeInBytes="0"
   EntirelyInCache="FALSE"
   JobId="0123edab-a4ec-4472-927e-c4df0ac9416b"
   Naked="FALSE"
   Name="Untitled"
   OriginalSizeInBytes="12345"
   Priority="URGENT"
   RequestType="PUT"
   StartDate="2014-10-02T11:40:18.000Z"
   UserId="0e48e86a-54ca-4078-af35-40138da7b1a6"
   UserName="user_name"
   WriteOptimization="CAPACITY">
   <Nodes>
      <Node
         EndPoint="blackpearl-hostname"
         Id="ee05bc5f-3a0e-41c3-992d-9ea99ce7552e"/>
   </Nodes>
   <Objects
      ChunkId="d4b8a15a-d635-4854-b746-751edafe5c88"
      ChunkNumber="1">
      <Object
         Id="70f80a64-4da9-42e2-bd0f-ee67cf496bbe" InCache="FALSE"
         Latest="TRUE" Length="12345" Name="object_name"
         Offset="0" Version=1"/>
      </Object>
   </Objects>
</MasterObjectList>