Retrieve Internal Job listing using the Nexfs Management API

Returns details of upto 200 jobs from the internal Nexfs general Job queue, the back ground migrations queue, or the deletions queue. The number of entries returned may be less than 200, depending on the size of job data or if JobID or ShowMax is passed.

Action: GetJobQueue

Request a list of jobs from one of the internal queues

Permissions

To retrieve the nexfs system status a requesting session must have the nexfs/ManageJobs role enabled.

Request Parameters

A request must be made against the nexfs management console api with the GetJobQueue action.

The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.

Action

GetJobDetails

Mode (Optional)

The queue to be returned, one of Standard, Migration, Deletion

Defaults to Standard

StartList (Optional)

The QSlot Entry to start from

ShowMax (Optional)

Return upto this many queue entries

JobID (Optional)

If included only return this specific Job

Request Body

The request does not have a request body.

Response  Syntax

HTTP1/1 200

{

"Jobs": [{

"JobID": integer,

"QSlot": integer,

"State": "string",

"Owner": integer,

"Task": "string",

"Abort": integer,

  "Mode": integer,

  "Stype": integer,

                        "GSID": "string",

                        "GSCID": "string",

                        "Owner": integer,

                        "Stage": "string",

},

...

],

"Truncated": true/false

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in json format by the service.

JobId

  The Jobs Internal Identifier

Abort  (Migrations Queue Only)

  The Job is to be Aborted

GSID  (Migrations Queue Only)

  Object Life-Time identifier

GSID  (Migrations Queue Only)

  Object Version identifier

Mode  (Migrations Queue Only)

  0 - Protect and Tier

1 - Protect Only

2 - Tier Only

Owner

The Nexfs Job Worker Thread that has been assigned the job

QSlot

  The Job Queue Entry Slot

Stage (Deletions Queue Only)

"de" - First Stage or "df" - Final Stage.

State

  The Status of the Job

Stype (Migrations Queue Only)

  Nexfs Internal

Task

The type of Job

   Truncated

true if there are more jobs in the queue than returned

Errors

Also See Rest Error Responses

400 InvalidArgument The Request Parms are Invalid

401 Unauthorized The request cannot be authenticated

403 Forbidden Session does not have the rights to perform the requested action

Example Request

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=GetJobQueue&JobID=1&Mode=Standard

Authorization: AWS4-HMAC-SHA256 Credential=add3d829e6c04cd79df2574933b3fe8a/20220823/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=b06e15a80a5f12d396077c97211f77876fc6fbf305c133f84e949bd283aa9e1c

content-type: application/x-www-form-urlencoded; charset=utf-8

host: nexfs.example.com

x-amz-date: 20220823T124614Z

Example Response

Standard Jobqueue Response

{

"Jobs": [{

"JobID": 1,

"QSlot": 0,

"State": "Failed",

"Owner": 0,

"Task": "MovetoTier3"

}],

"Truncated": false

}