Obtaining Job Information

GET /job/{job_id}

Introduction

Obtains information about the Job for the specified job_id.

Caution

You cannot obtain Job information created by another User. Even if the specified Job ID exists, if you are not the creator of that job, the HTTP status code will be 404.

Request Examples

  • This is an example of obtaining the Job ID and Status for Job ID 8192001.

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

Response Examples

{
  "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

PATH PARAMETERS

job_id

(required)

integer

Job ID.

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

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

For details about the specification methods, see Property Filter.

Responses

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

RESPONSE BODY

job_id

integer

Job ID.
job_href

string

Resource link of the job.
description

string

Job overview.
status

string

The Job state.
Items 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.

The difference between Error and Partial_Error is as follows.

  • If the Job Status is Partial_Error, the process may have completed for some Resources.

  • The error information to respond is different.

    • For Error, error_code, internal_code, error_message, and operation_list are responded.

    • For Partial_Error, succeeded_resource_href_list, failed_resource_info_list, and operation_list are responded.
created_time

string

Job creation time.

Respond to the date and time the Job was created (ISO 8601 extended format).

Format is as follows:

The time zone is UTC.

YYYY-MM-DDThh:mm:ssZ
modified_time

string

Job state change time.

Respond the date and time (ISO 8601 extended format) when the Status of Job changed.

Format is as follows:

The time zone is UTC.

YYYY-MM-DDThh:mm:ssZ
resource_href_list

Array of strings

Link to the created Resource.

Respond to a Link to a Resource when it is created.

This Parameter responds only when all of the following conditions are satisfied.

  • If the Method of the API that created the Job is "POST" and you created a Resource with a URI.

  • Job Status must be Success
error_code

string

Error code.

Respond when Status becomes Error.

Respond to the error code when the Job failed.

See error_message and Appendix A "Error Messages/Error Codes" in "CLI User's Guide" for more information about the error and how to deal with it.
internal_code

string

Error Internal Code.

Respond when Status becomes Error.

Information for technical support.
error_message

string

Error Message.

Respond when Status becomes Error.

Respond with error details.

Format is as follows:

"Description(Factor)"

  • Description - the description of the error content corresponding to error_code.

  • Factor - parameter that caused the factor-error. Review the Parameter setting referring to Description.
operation_list

Array of objects

The list of actions that Job performs.

Respond only when Status becomes Error or Partial_Error.
result

string

The result of the Operation.
Items Description
Succeeded Success
Failed Failed
Unexecuted Not Executed
Executed Executed
operation

string

Operation details.
progress_href_list

Array of strings

Link to Resource to receive progress.

Respond if a Job has a Status of Success and requires additional progress receipt outside of GET /job.

If this List is answered, use the GET + Progress Href to verify that the operation is complete.
succeeded_resource_href_list

Array of strings

Link to the succeeded Resource.

If the Job Status is Partial_Error, the Failed operation may have completed for some Resources even though it is Failed on operation_list.

If the Job has a Status of Partial_Error, it responds with a Link to some of the Resources for which the operation was successful.
failed_resource_info_list

Array of objects

Information about the Resource that failed the operation.

Respond only when Status becomes Partial_Error.