16.20 - ジョブの表示(RESTful API) - Teradata Data Mover

Teradata® Data Mover ユーザー ガイド

Product
Teradata Data Mover
Release Number
16.20
Published
2021年11月
Content Type
ユーザー ガイド
Publication ID
B035-4101-107K-JPN
Language
日本語 (日本)

目的

Data Moverでは、ジョブの表示で次のような各種フィルタを利用できます。
  • 開始時刻、終了時刻、ステータスなど、指定した条件を満たすジョブ
  • 開始時刻、終了時刻、ステータス、優先順位など、指定した条件を満たす実行済みのジョブ
  • 開始時刻、ステータス、優先順位など、指定した条件を満たす、現在実行中のジョブ
  • ステップが停止しているジョブ
アイテム 説明
URL

/datamover/jobs

/datamover/executedJobs

/datamover/executingJobs

/datamover/jobs?freezeJobStepsOnly=value

メソッド GET

要求のパラメータ(/datamover/jobs)

このバリエーションでは、開始時刻、終了時刻、ステータスなど指定された条件を満たすジョブ名のリストを返します。パラメータを指定しない場合は、新規ジョブと完了したジョブのリストが返されます。

startTimeAfter
説明: 指定時刻よりも後で開始したジョブ
制限: endTimeAfterでは使用できません。
URL: /datamover/jobs?startTimeAfter=value
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
必須: いいえ
endTimeBefore
説明: 指定時刻よりも前で終了したジョブ。
制限: endTimeAfterでは使用できません。
URL: /datamover/jobs?endTimeBefore=value
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
必須: いいえ
endTimeAfter
説明: 指定時刻よりも後で終了したジョブ。
制約: endTimeBeforeまたはstartTimeAfterと使用することはできません。
URL: /datamover/jobs?endTimeAfter=value
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
必須: いいえ
freezeJobStepsOnly
説明: trueに設定されたfreezeJobStepsOnlyを持つジョブのみを表示します。
URL: /datamover/jobs?freezeJobStepsOnly=value
指定可能な値: TrueまたはFalse
  • true = ジョブ ステップが停止しているジョブを表示
  • false = ステップの停止に関係なく、すべてのジョブを表示
JSONデータ型: ブール
必須: いいえ
jobName
説明: ジョブ名
JSONデータ型: 文字列
必須: いいえ
latestJobsOnly
説明: デーモンで実行された最新のジョブを表示します。
URL: /datamover/jobs?latestJobsOnly=value
指定可能な値: TrueまたはFalse
  • true = 最後に実行されたジョブのみを表示
  • false = すべてのジョブを表示
JSONデータ型: ブール
必須: いいえ
status
説明: 最後の開始ステータスが次のいずれかと一致するジョブ。
  • NEW: 新規のすべてのジョブ
  • INITIALIZING: 初期化中のすべてのジョブ
  • RUNNING: 実行中のすべてのジョブ
  • BLOCKED: ブロックされたすべてのジョブ
  • COMPLETED: 正常に完了したすべてのジョブ
  • FAILED: 失敗したすべてのジョブ
  • RESTARTING: 再起動中のすべてのジョブ
  • CANCELLED: ユーザーがキャンセルしたすべてのジョブ
  • QUEUED: 実行待ちのすべてのジョブ
URL: /datamover/jobs?status=value
JSONデータ型: 文字列
必須: いいえ

応答パラメータ(/datamover/jobs)

jobExecutionName
説明: 開始済みのジョブ名
JSONデータ型: 文字列
jobName
説明: ジョブ名(最大文字数: 237)
JSONデータ型: 文字列
startTime
説明: ジョブが開始されている場合は開始時刻、ジョブが開始されていない場合はnull
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
endTime
説明: ジョブが開始されている場合は終了時刻、ジョブが開始されていない場合はnull
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
status
説明: ジョブのステータス(最大文字数: 12)。使用可能な値は、要求のパラメータ セクションで指定されます。
JSONデータ型: 文字列
Priority
説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSONデータ型: 文字列

応答の例(/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
説明: 指定時刻よりも後で開始したジョブ
制限: endTimeAfterでは使用できません。
URL: /datamover/executedJobs
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
必須: いいえ
endTimeBefore
説明: 指定時刻よりも前で終了したジョブ。
制限: endTimeAfterでは使用できません。
URL: /datamover/executedJobs?endTimeBefore=value
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
必須: いいえ
endTimeAfter
説明: 指定時刻よりも後で終了したジョブ
制約: startTimeAfterまたはendTimeBeforeと使用することはできません。
URL: /datamover/executedJobs?endTimeBefore=value
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
必須: いいえ
status
説明: 最後の実行ステータスが次のいずれかと一致するジョブ。
  • 完了:正常に完了したすべてのジョブ
  • 失敗:失敗したすべてのジョブ
  • キャンセル:ユーザーがキャンセルしたすべてのジョブ
URL: /datamover/executedJobs?endTimeBefore=value
JSONデータ型: 文字列
必須: いいえ
jobName
説明: 指定した名前にマップされている開始済みのジョブ
URL: /datamover/executedJobs?jobName=value
JSONデータ型: 文字列
必須: いいえ

応答のパラメータ(/datamover/executedJobs)

jobExecutionName
説明: 開始済みのジョブ名
JSONデータ型: 文字列
jobName
説明: ジョブ名(最大文字数: 237)
JSONデータ型: 文字列
startTime
説明: ジョブが開始されている場合は開始時刻、ジョブが開始されていない場合はnull
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
endTime
説明: ジョブが開始されている場合は終了時刻、ジョブが開始されていない場合はnull
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
status
説明: ジョブ ステータス(最大文字数: 11)。使用可能な値は, 要求のパラメータ セクションに一覧表示されます
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
Priority
説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSONデータ型: 文字列

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
説明: 指定時刻よりも後で開始したジョブ
制限: endTimeAfterでは使用できません。
URL: /datamover/executingJobs
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
必須: いいえ
status
説明: 最後の実行ステータスが次のいずれかと一致するジョブ。
  • 完了:正常に完了したすべてのジョブ
  • 失敗:失敗したすべてのジョブ
  • キャンセル:ユーザーがキャンセルしたすべてのジョブ
URL: /datamover/executingJobs?status=value
JSONデータ型: 文字列
必須: いいえ

応答のパラメータ(/datamover/executingJobs)

jobExecutionName
説明: 開始済みのジョブ名
JSONデータ型: 文字列
jobName
説明: ジョブ名(最大文字数: 237)
JSONデータ型: 文字列
startTime
説明: ジョブが開始されている場合は開始時刻、ジョブが開始されていない場合はnull
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
status
説明: ジョブのステータス(最大文字数: 11)。 使用可能な値は、要求のパラメータ リストで指定されます
JSONデータ型: 文字列
Priority
説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSONデータ型: 文字列

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に設定されているジョブ
JSONデータ型: ブール
必須: いいえ
指定可能な値: TrueまたはFalse
  • true = ジョブ ステップが停止しているジョブを表示
  • false = ステップの停止に関係なく、すべてのジョブを表示

応答のパラメータ(/datamover/jobs?freezeJobStepsOnly=value)

jobExecutionName
説明: 開始済みのジョブ名
JSONデータ型: 文字列
jobName
説明: ジョブ名(最大文字数: 237)
JSONデータ型: 文字列
links
説明: ジョブ ステータス、過去のジョブ実行、およびジョブ ステップへのリンクのリスト
JSONデータ型: JSON配列(LinkType)
Priority
説明: 開始される場合のジョブの優先順位(最大文字数は11)。値は次のいずれかです。
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSONデータ型: 文字列
startTime
説明: ジョブの開始時刻
JSONデータ型: 次のような文字列(ISO 8601 UTC日付形式): 2015-07-01T17:38:12Z
status
説明: ジョブのステータス(最大文字数: 12)。使用可能な値は、要求のパラメータの説明で指定されます。
JSONデータ型: 文字列