Job情報の取得

GET /job/{job_id}

概要説明

指定されたjob_idの Jobについての情報を取得します。

注意

ほかのUserが作成したJob情報を取得することはできません。Job IDで指定したJobが存在しても、自身が作成したJobでなければHTTPステータスコード 404で応答します。

リクエスト例

  • Job ID 8192001 について、Job IDとStatusを取得する場合の例です。

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

レスポンス例

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

指定したParameter名(Response Body Parameter)の情報のみを抜き出して取得します。

指定方法の詳細は、表示する項目の絞り込みを参照してください。

Responses

正常に取得できた場合、HTTPステータスコードが200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

job_id

integer

Job ID。
job_href

string

JobのResourceへのLink。
description

string

Jobの概要。
status

string

Jobの状態。
項目 説明
Queued キューイングされたJobです。
Running 実行中のJobです。
Success 正常終了したJobです。
Error 異常終了したJobです。
Partial_Error 一部またはすべての処理が異常終了したJobです。
Canceled CancelされたJobです。

ErrorとPartial_Errorの違いは以下です。

  • Partial_Errorの場合、一部のResourceについては処理が成功していることがあります。

  • 応答するエラー情報が異なります。

    • Errorの場合、error_code, internal_code, error_message, operation_listを応答します。

    • Partial_Errorの場合、succeeded_resource_href_list, failed_resource_info_list, operation_listを応答します。
created_time

string

Job作成時間。

Jobが作成された日時(ISO8601拡張形式)を応答します。

Formatは以下です。

タイムゾーンはUTCです。

YYYY-MM-DDThh:mm:ssZ
modified_time

string

Job状態変更時間。

JobのStatusが変わったときの日時(ISO8601拡張形式)を応答します。

Formatは以下です。

タイムゾーンはUTCです。

YYYY-MM-DDThh:mm:ssZ
resource_href_list

Array of strings

作成されたResourceへのLink。

Resourceが作成された場合に、そのResourceへのLinkを応答します。

本Parameterは以下の条件をすべて満たした場合に限り応答します。

  • Jobを作成したAPIのMethodが"POST"で、URIを持つResourceを作成した場合

  • JobのStatusがSuccessであること
error_code

string

エラーコード。

StatusがErrorとなった場合に応答します。

Jobが失敗したときのエラーコードを応答します。

エラーの詳細、対応方法についてはerror_messageと『CLI ユーザーズガイド』の付録A「エラーメッセージ/エラーコード」を参照ください。
internal_code

string

Error Internal Code。

StatusがErrorとなった場合に応答します。

技術サポート向けの情報です。
error_message

string

Error Message。

StatusがErrorとなった場合に応答します。

エラーの詳細を応答します。

Formatは以下です。

"Description(Factor)"

  • Description- error_codeに対応するError内容の説明文です。

  • Factor- Errorの要因となったParameter。Descriptionを参考にしてParameterの設定を見直してください。
operation_list

Array of objects

Jobで実行される処理一覧。

JobのStatusがErrorまたはPartial_Errorとなった場合に限り応答します。
result

string

Operationの結果。
項目 説明
Succeeded 成功
Failed 失敗
Unexecuted 未実行
Executed 実行済み
operation

string

Operationの詳細。
progress_href_list

Array of strings

進捗受け取り用のResourceへのLink。

JobのStatusがSuccessとなった、かつGET /job以外で追加の進捗受け取りが必要なJobの場合に応答します。

このListが応答された場合は、GET + Progress Hrefを使用して処理が完了したかどうかを確認してください。
succeeded_resource_href_list

Array of strings

操作に成功したResourceへのLink。

JobのStatusがPartial_Errorの場合、operation_listでFailedになっているときでも、一部のResourceについてはFailedとなった操作が完了していることがあります。

JobのStatusがPartial_Errorの場合、操作が成功している一部のResourceへのLinkを応答します。
failed_resource_info_list

Array of objects

操作に失敗したResourceの情報。

JobのStatusがPartial_Errorとなった場合に限り応答します。