Getting job information

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request gets, at a specific timing, information about a specified job that was submitted by the user from the asynchronous API. Only a user who belongs to a user group with the Storage Administrator (System Resource Management) role can also obtain information about jobs submitted by other users. The obtained information can be used to check the job status.

Execution permission

No role is required to run this API request. Only the users authenticated by the storage system can issue this API request.

Request line

GET base-URL/v1/objects/jobs/object-ID

Request message

Object ID

Specify the jobId value obtained by getting information about the job list or the response message of the asynchronous API.

Attribute

Type

Description

jobId

long

(Required) Job object ID

Query parameters

None.

Body

None.

Response message

Body
{
  "jobId": 3,
  "self": "/ConfigurationManager/v1/objects/jobs/3",
  "userId": "rest-test",
  "status": "Completed",
  "state": "Succeeded",
  "createdTime": "2015-09-14T02:08:13Z",
  "updatedTime": "2015-09-14T02:08:13Z",
  "completedTime": "2015-09-14T02:08:13Z",
  "request": {
    "requestUrl": "/ConfigurationManager/v1/services/resource-group-service/actions/lock/invoke",
    "requestMethod": "POST",
    "requestBody": {
      "parameters": {
        "waitTime": null
      }
    }
  },
  "affectedResources": [
    "/ConfigurationManager/v1/objects/resource-groups"
  ]
}

For details on the job object schema, see the description on job objects.

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the section explaining HTTP status codes.

Status codes

Message

Description

404

Not Found

  • There is no information corresponding to the specified job ID.
  • The user who issued the API request is not the user who submitted the job corresponding to the specified job ID.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/jobs/3