全Job情報の取得

概要説明

自Userの Jobについての情報を取得します。

注意

Job情報はJob状態がSuccess、Error、Partial_Error、Canceledとなってから30分間保持されますが、その後自動で削除されます。

リクエスト例

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

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

レスポンス例

{
  "total_count": 512,
  "list_count": 1,
  "job_list": [
    {
      "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

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

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

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

job_id

Array of integers

Job ID。

情報を取得したいJob IDを指定します。

入力条件：

512個まで指定可能です。

status

Array of strings

ステータス。

情報を取得したいJobのステータスを指定します。

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

入力条件：

6個まで指定可能です。

max_records

integer

情報を取得したいリソースの最大数。

応答する情報数を制限したい場合に指定してください。

入力条件：

指定可能な範囲は1～512です。

last_get_id

integer

続きの情報を取得するためのリソースの識別子。

一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_hrefが返却されます。

last_get_idはnext_hrefに付与される、続きの情報を取得するための情報です。

Responses

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

RESPONSE BODY

total_count	integer 装置に存在するResourceの総数。フィルタリングしている場合は、条件に合致するResourceの総数です。
list_count	integer 応答するListの個数。
job_list	Array of objects GET /job/job_idで取得できる情報を、list_count数分出力します。詳細は、Job情報の取得の「Responses」を参照してください。
next_href	string 続きの情報を取得するためのLink。一度にすべての情報を応答しきることができなかった場合に限り応答します。例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。