3.12　ジョブの情報の一覧を取得する

ユーザがREST APIから投入したジョブの情報の一覧を取得します。ストレージ管理者（システムリソース管理）のロールを持つユーザグループに属するユーザの場合、登録されているすべてのジョブについて情報を取得できます。ジョブの情報は発行したAPIの内容を確認したり、ストレージシステムで発生した問題の原因を特定する情報として利用したりします。

実行権限

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

リクエストライン

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/jobs

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ

クエリパラメータを指定しない場合、ユーザが参照できるジョブ情報のうちジョブの投入時刻が新しいものから100件を取得します。

パラメータ	型	フィルタ条件
startCreatedTime	ISO8601string	（任意）取得するジョブ投入時刻の始点をYYYY-MM-DDThh:mm:ssZ形式で指定します。指定された時刻以降（指定時刻を含む）に投入されたジョブ情報を取得します。
endCreatedTime	ISO8601string	（任意）取得するジョブ投入時刻の終点をYYYY-MM-DDThh:mm:ssZ形式で指定します。指定された時刻より前（指定時刻を含まない）に投入されたジョブ情報を取得します。
count	int	（任意）取得するジョブの件数を`1`～`100`の値で指定します。指定された件数を上限としてジョブ情報を取得します。省略した場合、`100`が指定されます。
status	string	（任意）取得するジョブの状態（Status）として、次の値を指定します。 `Initializing`：初期化中同時にstateを指定する場合、stateには`Queued`を指定します。 `Running`：実行中同時にstateを指定する場合、stateには`Started`を指定します。 `Completed`：実行完了同時にstateを指定する場合、stateには`Succeeded`、`Failed`、`Unknown`のどれかを指定します。
state	string	（任意）取得するジョブの状態（State）として、次の値を指定します。 `Queued`：ジョブがキューイングされた状態 `Started`：ジョブが開始された状態 `Succeeded`：ジョブが成功した状態 `Failed`：ジョブが失敗した状態 `Unknown`：ジョブの状態が不明

例として、2015/05/01 08:00:00以降2015/05/31 23:59:59以前のジョブ情報のうち正常終了したものをジョブ投入時刻の新しいものから30件を上限として取得する場合を次に示します。

?startCreatedTime=2015-05-01T08:00:00Z&endCreatedTime=2015-05-31T23:59:59Z&count=30&state=Succeeded

ボディ: なし。

レスポンスメッセージ

ボディ

{
  "data": [
    {
      "jobId": 2,
      "self": "/ConfigurationManager/v1/objects/storages/836000123456/jobs/2",
      "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"
      ]
    },
    {
      "jobId": 1,
      "self": "/ConfigurationManager/v1/objects/storages/836000123456/jobs/1",
      "userId": "rest-test",
      "status": "Completed",
      "state": "Failed",
      "createdTime": "2015-09-14T02:04:11Z",
      "updatedTime": "2015-09-14T02:04:12Z",
      "completedTime": "2015-09-14T02:04:12Z",
      "request": {
        "requestUrl": "/ConfigurationManager/v1/836000123456/services/resource-group-service/actions/lock/invoke",
        "requestMethod": "PUT",
        "requestBody": {
          "parameters": {
            "waitTime": null
          }
        }
      },
      "error": {
        "errorSource": "/ConfigurationManager/v1/836000123456/services/resource-group-service/actions/lock/invoke",
        "message": "An error occurred in the storage system. (message =  Access denied with Lock/Unlock)",
        "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.",
        "messageId": "KART30000-E",
        "errorCode": {
          "errorCode": "EX_EACCES"
        }
      }
    }
  ]
}

属性	型	説明
data	object[]	ユーザがREST APIから作成したジョブの情報（ジョブオブジェクト） 1度に最大で100件のジョブ情報を取得します。

属性

型

説明

data

object[]

ユーザがREST APIから作成したジョブの情報（ジョブオブジェクト）

1度に最大で100件のジョブ情報を取得します。

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

ステータスコード

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

コード例

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.12 ジョブの情報の一覧を取得する

3.12　ジョブの情報の一覧を取得する