目的
Data Moverでは、ジョブの表示で次のような各種フィルタを利用できます。
- 開始時刻、終了時刻、ステータスなど、指定した条件を満たすジョブ
- 開始時刻、終了時刻、ステータス、優先順位など、指定した条件を満たす実行済みのジョブ
- 開始時刻、ステータス、優先順位など、指定した条件を満たす、現在実行中のジョブ
- ステップが停止しているジョブ
アイテム | 説明 | ||
---|---|---|---|
URL | /datamover/jobs /datamover/executedJobs /datamover/executingJobs /datamover/jobs?freezeJobStepsOnly=value |
||
メソッド | GET |
要求のパラメータ(/datamover/jobs)
このバリエーションでは、開始時刻、終了時刻、ステータスなど指定された条件を満たすジョブ名のリストを返します。パラメータを指定しない場合は、新規ジョブと完了したジョブのリストが返されます。
- startTimeAfter
- 説明: 指定時刻よりも後で開始したジョブ
- endTimeBefore
- 説明: 指定時刻よりも前で終了したジョブ。
- endTimeAfter
- 説明: 指定時刻よりも後で終了したジョブ。
- freezeJobStepsOnly
- 説明: trueに設定されたfreezeJobStepsOnlyを持つジョブのみを表示します。
- jobName
- 説明: ジョブ名
- latestJobsOnly
- 説明: デーモンで実行された最新のジョブを表示します。
- status
- 説明: 最後の開始ステータスが次のいずれかと一致するジョブ。
- NEW: 新規のすべてのジョブ
- INITIALIZING: 初期化中のすべてのジョブ
- RUNNING: 実行中のすべてのジョブ
- BLOCKED: ブロックされたすべてのジョブ
- COMPLETED: 正常に完了したすべてのジョブ
- FAILED: 失敗したすべてのジョブ
- RESTARTING: 再起動中のすべてのジョブ
- CANCELLED: ユーザーがキャンセルしたすべてのジョブ
- QUEUED: 実行待ちのすべてのジョブ
応答パラメータ(/datamover/jobs)
- jobExecutionName
- 説明: 開始済みのジョブ名
- jobName
- 説明: ジョブ名(最大文字数: 237)
- startTime
- 説明: ジョブが開始されている場合は開始時刻、ジョブが開始されていない場合はnull
- endTime
- 説明: ジョブが開始されている場合は終了時刻、ジョブが開始されていない場合はnull
- status
- 説明: ジョブのステータス(最大文字数: 12)。使用可能な値は、要求のパラメータ セクションで指定されます。
- Priority
- 説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
- UNSPECIFIED
- LOW
- MEDIUM
- HIGH
応答の例(/datamover/jobs)
次の例では、指定時刻よりも開始時刻が後のジョブの配列を表示します。ジョブが見つからない場合は、空の配列を返します。
[ { "jobName" : "runningJob" , "startTime" : "2015-07-16T17:14:13Z", "endTime" : null , "status" : "RUNNING" , "priority" : "MEDIUM" , "links" : [ { "rel" : "status" , "href" : "http://server/datamover/executingJobs/runningJob-1417744247669" }, { "rel" : "past_executions" , "href" : "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>" } { "rel" : "job_steps" , "href" : "http://server/datamover/jobs/runningJob/steps" } ] }, { "jobName" : "successfulJob" , "startTime" : "2015-07-16T17:14:13Z", "endTime" : "2015-07-16T19:14:13Z", "status" : "COMPLETED" , "priority" : "MEDIUM" , "links" : [ { "rel" : "status" , "href" : "http://server/datamover/executedJobs/successfulJob-20141204175020" }, { "rel" : "past_executions" , "href" : "http://server/datamover/executedJobs?jobName=successfulJob &startTimeAfter=<value> " } { "rel" : "job_steps" , "href" : "http://server/datamover/jobs/successfulJob/steps" } ] }, { "jobName" : "failedJob" , "startTime" : 1417744247669, "endTime" : 1417744323437, "status" : "FAILED" , "priority" : "MEDIUM" , "links" : [ { "rel" : "status" , "href" : "http://server/datamover/executedJobs/failedJob-20141204175020" }, { "rel" : "past_executions" , "href" : "http://server/datamover/executedJobs?jobName=failedJob &startTimeAfter=<value> " } { "rel" : "job_steps" , "href" : "http://server/datamover/jobs/failedJob/steps" } ] } ]
要求のパラメータ(/datamover/executedJobs)
このバリエーションは、新規ジョブや実行中のジョブなどの指定された条件を満たすジョブ名のリストを返します。
- startTimeAfter
- 説明: 指定時刻よりも後で開始したジョブ
- endTimeBefore
- 説明: 指定時刻よりも前で終了したジョブ。
- endTimeAfter
- 説明: 指定時刻よりも後で終了したジョブ
- status
- 説明: 最後の実行ステータスが次のいずれかと一致するジョブ。
- 完了:正常に完了したすべてのジョブ
- 失敗:失敗したすべてのジョブ
- キャンセル:ユーザーがキャンセルしたすべてのジョブ
- jobName
- 説明: 指定した名前にマップされている開始済みのジョブ
応答のパラメータ(/datamover/executedJobs)
- jobExecutionName
- 説明: 開始済みのジョブ名
- jobName
- 説明: ジョブ名(最大文字数: 237)
- startTime
- 説明: ジョブが開始されている場合は開始時刻、ジョブが開始されていない場合はnull
- endTime
- 説明: ジョブが開始されている場合は終了時刻、ジョブが開始されていない場合はnull
- status
- 説明: ジョブ ステータス(最大文字数: 11)。使用可能な値は, 要求のパラメータ セクションに一覧表示されます
- Priority
- 説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
- UNSPECIFIED
- LOW
- MEDIUM
- HIGH
RESTful APIの例(/datamover/executedJobs)
次の例では、開始されたジョブを示します。ジョブが見つからない場合は、空の配列を返します。
[ { "jobExecutionName" : "successfulJob-20141204175020" , "jobName" : "successfulJob" , "startTime" :"2015-07-01T17:38:12Z", "endTime" : "2015-07-01T19:38:12Z", "status" : "COMPLETED" , "priority" : "MEDIUM" , "links" : [ { "rel" : "status" , "href" : "http://server/datamover/executedJobs/successfulJob-20141204175020" } { "rel" : "job_steps" , "href" : "http://server/datamover/jobs/successfulJob/steps" } ] }, { "jobExecutionName" : "successfulJob-20141204175111" , "jobName" : "successfulJob" , "startTime" : "2015-07-02T17:38:12Z", "endTime" : "2015-07-02T19:38:12Z", "status" : "COMPLETED" , "priority" : "MEDIUM" , "links" : [ { "rel" : "status" , "href" : "http://server/datamover/executedJobs/successfulJob-20141204175111" } { "rel" : "job_steps" , "href" : "http://server/datamover/jobs/successfulJob/steps" } ] }, { "jobExecutionName" : "failedJob-20141204175020" , "jobName" : "failedJob" , "startTime" : "2015-07-03T17:38:12Z", "endTime" : "2015-07-03T19:38:12Z", "status" : "FAILED" , "priority" : "MEDIUM" , "links" : [ { "rel" : "status" , "href" : "http://server/datamover/executedJobs/failedJob-20141204175020" } { "rel" : "job_steps" , "href" : "http://server/datamover/jobs/failedJob/steps" } ] } ]
要求のパラメータ(/datamover/executingJobs)
このバリエーションは、Data Moverデーモンで現在実行されている、指定の時間より後に開始されたすべてのジョブを返します。ここで、値は次のいずれかです。
- INITIALIZING
- RUNNING
- BLOCKED
- RESTARTING
- QUEUED
次のオプションのパラメータを指定できます。
- startTimeAfter
- 説明: 指定時刻よりも後で開始したジョブ
- status
- 説明: 最後の実行ステータスが次のいずれかと一致するジョブ。
- 完了:正常に完了したすべてのジョブ
- 失敗:失敗したすべてのジョブ
- キャンセル:ユーザーがキャンセルしたすべてのジョブ
応答のパラメータ(/datamover/executingJobs)
- jobExecutionName
- 説明: 開始済みのジョブ名
- jobName
- 説明: ジョブ名(最大文字数: 237)
- startTime
- 説明: ジョブが開始されている場合は開始時刻、ジョブが開始されていない場合はnull
- status
- 説明: ジョブのステータス(最大文字数: 11)。 使用可能な値は、要求のパラメータ リストで指定されます
- Priority
- 説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
- UNSPECIFIED
- LOW
- MEDIUM
- HIGH
RESTful APIの例(/datamover/executingJobs)
次の例では、開始されたジョブを示します。ジョブが見つからない場合は、空の配列を返します。
[ { "jobExecutionName" : "runningJob-1417744247669" , "jobName" : "runningJob" , "startTime" :"2015-07-16T17:14:13Z", "status" : "RUNNING" , "priority" : "MEDIUM" , "links" : [ { "rel" : "status" , "href" : "http://server/datamover/runningJobs/runningJob-1417744247669" }, { "rel" : "history" , "href" : "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>" } { "rel" : "job_steps" , "href" : "http://server/datamover/jobs/runningJob/steps" } ] } ]
リクエストのパラメータ(/datamover/jobs?freezeJobStepsOnly=value)
- freezeJobStepsOnly
- 説明: ジョブ ステップの停止がtrueに設定されているジョブ
応答のパラメータ(/datamover/jobs?freezeJobStepsOnly=value)
- jobExecutionName
- 説明: 開始済みのジョブ名
- jobName
- 説明: ジョブ名(最大文字数: 237)
- links
- 説明: ジョブ ステータス、過去のジョブ実行、およびジョブ ステップへのリンクのリスト
- Priority
- 説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
- UNSPECIFIED
- LOW
- MEDIUM
- HIGH
- startTime
- 説明: ジョブの開始時刻
- status
- 説明: ジョブのステータス(最大文字数: 12)。使用可能な値は、要求のパラメータの説明で指定されます。