Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


2.14 ジョブオブジェクト

ジョブオブジェクトは、非同期処理のAPIを発行したときに返るジョブ情報のオブジェクトです。

ジョブオブジェクトのスキーマを次に示します。

属性

データ型

説明

jobId

long

ジョブのオブジェクトID

self

link

ジョブの情報にアクセスするためのURL

userId

string

ジョブを登録する契機となるAPIを発行したユーザID

status

string

ジョブのステータス

次の値が返ります。

  • Initializing:ジョブが初期化中であることを示す

  • Running:ジョブが実行中であることを示す

  • Completed:ジョブが実行完了したことを示す

state

string

ジョブの状態

次の値が返ります。

  • Queued:ジョブがキューイングされた状態を示す

  • Started:ジョブが開始された状態を示す

  • StorageAccepted:ストレージシステムに要求が受け付けられた状態を示す

  • Succeeded:ジョブが成功した状態を示す

  • Failed:ジョブが失敗した状態を示す

  • Unknown:ジョブの状態が不明なことを示す

createdTime

ISO8601string

ジョブが作成された時刻

updatedTime

ISO8601string

ジョブの状態が更新された時刻

completedTime

ISO8601string

ジョブが終了した時刻

request

Request Object

リクエストの情報を保持するオブジェクト

affectedResources

link[]

操作対象のリソースにアクセスするためのURL

1つのAPIで複数のリソースを操作する場合は、すべての操作対象のリソースのURLが返ります。ジョブが途中で失敗した場合は、処理が完了したことを確認できたリソースのURLだけが返ります。

リソースの削除操作が成功した場合、削除対象のリソースのURLが返ります。このURLにアクセスすると404エラーとなり、正常に削除されたことが確認できます。

ジョブの情報を取得するAPIのレスポンスにもaffectedResourcesが含まれます。この場合、ジョブを登録する契機となったAPIの操作対象のリソースにアクセスするためのURLが返ります。

error

Error Object

エラーの情報を保持するオブジェクト

注※ StorageAcceptedは、リモートコピーペアを作成するジョブの場合にだけ返る状態です。

重要

ジョブの情報の最大保持件数を次に示します。最大保持件数を超えたジョブの情報は、createdTime の古い順に削除されます。

  • VSP E シリーズVSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900の場合:3,000件
  • VSP 5000 シリーズVSP G100、G200、G400、G600、G800VSP G1000VSP G1500VSP F400、F600、F800VSP F1500Virtual Storage PlatformUnified Storage VMの場合:10万件

ジョブが実行を開始したときのジョブオブジェクトの例:

{
  "jobId": 111111,
  "self": "/ConfigurationManager/v1/objects/storages/836000123456/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/storages/836000123456/ldevs",
    "requestMethod": "POST",
    "requestBody": "{\"ldevId\" : 112, \"poolId\" : 100, \"blockCapacity\" : 1000}"
  }
}

ジョブが成功して完了したときのジョブオブジェクトの例:

{
  "jobId": 222222,
  "self": "/ConfigurationManager/v1/objects/storages/836000123456/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/storages/836000123456/ldevs",
    "requestMethod": "POST",
    "requestBody": "{\"ldevId\" : 112, \"poolId\" : 100, \"blockCapacity\" : 1000}"
  },
  "affectedResources": [
    "/ConfigurationManager/v1/objects/storages/836000789123/ldevs/112"
  ]
}

ジョブが失敗して完了したときのジョブオブジェクトの例:

{
  "jobId": 333333,
  "self": "/ConfigurationManager/v1/objects/storages/836000123456/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/storages/836000123456/ldevs",
    "requestMethod": "POST",
    "requestBody": "{\"ldevId\" : 112, \"poolId\" : 100, \"blockCapacity\" : 1000}"
  },
  "error": {
    "errorSource": "/ConfigurationManager/v1/objects/storages/836000123456/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 RAID Manager command.",
    "solution": "See the manual of the RAID Manager and remove the cause of the error.",
    "errorCode": {
      "SSB1": "2E10",
      "SSB2": "6014"
    },
    "detailCode": "30000E-2-2E10-6014"
  }
}