Obtaining All the Job Information

GET /job

Introduction

Obtains the information about the Job of the current User.

Caution

Job information is retained for 30 minutes after a Job state is changed to Success, Error, Partial_Error, or Canceled, and then automatically deleted.

Request Examples

  • This is an example of getting the Job ID and Status for a Job with a Status of Success.

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.."-X GET "https://192.168.1.1:5665/api/v1/job?status=Success&fields=status"

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "job_list": [
    {
      "job_id": 8192001,
      "job_href": "/api/v1/job/8192001",
      "description": "POST /api/v1/tpp {"name" : "tpp_raid5","level" : "RAID5",...}",
      "status": "Success",
      "created_time": "2020-01-06T12:20:00Z",
      "modified_time": "2020-01-06T12:30:00Z",
      "resource_href_list": [
        "/api/v1/tpp/0"
      ],
      "operation_list": [
        {
          "result": "Succeeded",
          "operation": "create thin-pro-pool -rg-mode manual -attribute nearline -name tpp#0 -level 1 -disks 0004,0005"
        },
        {
          "result": "Succeeded",
          "operation": "expand thin-pro-pool -rg-mode manual -pool-name tpp#0 -disks 006,007"
        }
      ]
    }
  ]
}

Parameters

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and retrieved.

For details about the specification methods, see Property Filter.
job_id

Array of integers

Job ID.

Specify the Job ID for which you want information.

Input criteria:

  • You can specify up to 512 values.
status

Array of strings

Status.

Specify the status of the Job for which you want information.
Item Description
Queued The queued Job.
Running This is a running Job.
Success Job that completed successfully.
Error Job that abended.
Partial_Error Job with some or all processing aborted.
Canceled The Job that was canceled.

Input criteria:

  • You can specify up to 6 values.
max_records

integer

The maximum number of resources for which you want information.

Specify this parameter when you want to limit the number of pieces of information that can be answered.

Input criteria:

  • The range of allowed values is 1 to 512.
last_get_id

integer

The identifier of the resource for which to retrieve further information.

If all resources matching the response conditions cannot be answered at once, next_href is returned.

The last_get_id is the information given to next_href to retrieve further information.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

total_count

integer

The total number of Resources present in the device.

If a filter is applied, this is the total number of Resources that meet the criteria.
list_count

integer

Number of Lists to respond.
job_list

Array of objects

The information that can be retrieved with GET /job/job_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining Job Information.
next_href

string

Link to get more information.

This item is returned only when it is not possible to respond all information at once.

For example, this item is responded if there are more Resources that match the response condition than the number specified by max_records.