Job object

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
A job object represents job information that is returned when an API request for asynchronous processing is issued.

The following table explains the schema of a job object.

Attribute

Data type

Description

jobId

long

Job object ID.

self

link

URL used to access the job information.

userId

string

ID of the user who issued the API request that triggered registration of the job.

status

string

Status of the job.

The following values can be returned:

  • Initializing: The job is being initialized.

  • Running: The job is running.

  • Completed: Execution of the job is finished.

state

string

State of the job.

The following values can be returned:

  • Queued: The job has been queued.

  • Started: The job has been started.

  • StorageAccepted: The request was received by the storage system#.

  • Succeeded: The job finished successfully.

  • Failed: The job failed.

  • Unknown: The state of the job is unknown.

createdTime

ISO8601string

Time when the job was created.

updatedTime

ISO8601string

Time when the state of the job was updated.

completedTime

ISO8601string

Time when the job ended.

request

Request Object

Object that retains information about the request.

affectedResources

link[]

URL used to access the resource targeted by the operation.

If one API request performs operations on multiple resources, the URLs of all those resources are returned. If a job failed, only the URLs of the resources for which processing is confirmed to have been completed are returned.

If the resource is deleted successfully, the URL of the deleted resource is returned. A 404 error occurs if this URL is accessed. This confirms that the resource has been deleted successfully.

The attribute affectedResources is also included in the API response that obtains job information. In this case, the URL used to access the resource targeted by the API command that triggered registration of the job is returned.

error

Error Object

Object that retains error information.

#: The state StorageAccepted is returned only for a job that creates a remote copy pair.

Note:

The maximum number of instances of job information that can be retained is as follows. If the number of instances of job information exceeds the maximum, the instances of the oldest "createdTime" are deleted first.

  • For VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900: 3,000
  • For VSP 5000 series: 100,000

Example of a job object when the job execution starts:

{
  "jobId": 111111,
  "self": "/ConfigurationManager/v1/objects/jobs/111111",
  "userId": "user1",
  "status": "Running",
  "state": "Started",
  "createdTime": "2015-04-01T08:00:00Z",
  "updatedTime": "2015-04-01T08:05:00Z",
  "request": {
    "requestUrl": "/ConfigurationManager/v1/objects/ldevs",
    "requestMethod": "POST",
    "requestBody": "{\"ldevId\" : 112, \"poolId\" : 100, \"blockCapacity\" : 1000}"
  }
}

Example of a job object when the job is finished successfully:

{
  "jobId": 222222,
  "self": "/ConfigurationManager/v1/objects/jobs/222222",
  "userId": "user1",
  "status": "Completed",
  "state": "Succeeded",
  "createdTime": "2015-04-01T08:00:00Z",
  "updatedTime": "2015-04-01T08:10:00Z",
  "completedTime": "2015-04-01T08:10:00Z",
  "request": {
    "requestUrl": "/ConfigurationManager/v1/objects/ldevs",
    "requestMethod": "POST",
    "requestBody": "{\"ldevId\" : 112, \"poolId\" : 100, \"blockCapacity\" : 1000}"
  },
  "affectedResources": [
    "/ConfigurationManager/v1/objects/ldevs/112"
  ]
}

Example of a job object when the job failed:

{
  "jobId": 333333,
  "self": "/ConfigurationManager/v1/objects/jobs/333333",
  "userId": "user1",
  "status": "Completed",
  "state": "Failed",
  "createdTime": "2015-04-01T07:00:00Z",
  "updatedTime": "2015-04-01T07:01:00Z",
  "completedTime": "2015-04-01T07:01:00Z",
  "request": {
    "requestUrl": "/ConfigurationManager/v1/objects/ldevs",
    "requestMethod": "POST",
    "requestBody": "{\"ldevId\" : 112, \"poolId\" : 100, \"blockCapacity\" : 1000}"
  },
  "error": {
    "errorSource": "/ConfigurationManager/v1/objects/ldevs",
    "messageId": "KART30000-E",
    "message": "An error occurred in the storage system. (message = The state of the pool is incorrect.)",
    "cause": "An error occurred during execution of a CCI command.",
    "solution": "See the manual of the CCI and remove the cause of the error.",
    "solutionType": "SEE_ERROR_DETAIL",
    "errorCode": {
      "SSB1": "2E10",
      "SSB2": "6014"
    },
    "detailCode": "30000E-2-2E10-6014"
  }
}