Hitachi

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


3.13 特定のジョブの情報を取得する

ジョブIDを指定して、ユーザが非同期APIから投入したジョブの情報を任意のタイミングで取得します。ストレージ管理者(システムリソース管理)のロールを持つユーザグループに属するユーザの場合、他ユーザが投入したジョブについてもジョブ情報が取得できます。取得した情報からジョブの状態を確認します。

実行権限

このAPIの実行に必要なロールはありません。対象となるストレージシステムに認証が通るユーザで発行します。

リクエストライン

GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/jobs/<オブジェクトID

リクエストメッセージ

オブジェクトID

非同期APIのレスポンスメッセージまたはジョブ一覧から取得したjobIdを指定します。

属性

説明

jobId

long

(必須)ジョブのオブジェクトID

クエリパラメータ

なし。

ボディ

なし。

レスポンスメッセージ

ボディ
{
  "jobId": 3,
  "self": "/ConfigurationManager/v1/objects/storages/836000123456/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/836000123456/services/resource-group-service/actions/lock/invoke",
    "requestMethod": "PUT",
    "requestBody": {
      "parameters": {
        "waitTime": null
      }
    }
  },
  "affectedResources": [
    "/ConfigurationManager/v1/objects/storages/836000123456/resource-groups"
  ]
}

ジョブオブジェクトのスキーマについては、ジョブオブジェクトの説明を参照してください。

ステータスコード

この操作のリクエストに対するステータスコードの意味を次に示します。そのほかのステータスコードについては、HTTPステータスコードの説明を参照してください。

ステータスコード

メッセージ

説明

404

Not Found

  • 指定したジョブIDに該当する情報がない
  • 指定したジョブIDに該当するジョブはAPI発行ユーザが投入したものではない

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/jobs/3