データセットの最新リロード履歴の取得
get
/api/20210901/catalog/datasets/{datasetId}/history/latest
指定されたデータセットの最新のリロード履歴を返します。最新のリロードのジョブ履歴およびタスク履歴を返すか、ジョブ履歴のみを返すオプションが含まれています。ジョブ履歴には、ジョブ名、ジョブID、ステータス、タイプ、開始時間、終了時間、実行期間、キュー期間、起点、タスク数などの詳細が含まれます。タスク履歴には、タスク名、ステータス、ソースとターゲット、開始時間、終了時間、実行期間、処理済データのサイズ、読取り時間、成功した行数などの詳細が含まれます。
リクエスト
パス・パラメータ
- datasetId(必須): string(byte)
Base64エンコーディングを使用したデータセットのオブジェクトID。たとえば、データセットにオブジェクトID 'Admin'.'dataSet124'がある場合、Base64エンコード値J0FkbWluJy4nZGF0YVNldDEyNCcを入力します。
問合せパラメータ
- includeTasks: boolean(byte)
履歴タスクおよびジョブ情報を返すか、ジョブ履歴のみを返すかを指定します。可能な値はtrueまたはfalseです。trueを指定すると、タスク履歴とジョブ履歴の両方が返されます。ジョブ履歴のみを返すには、falseを指定します。デフォルト値はtrueです。
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功した操作。
ネストされたスキーマ: jobInformation
Type:
ソースを表示
object
-
jobEndTimestamp: string
ジョブが終了した時刻。
-
jobExecutionTimestamp: string
ジョブが開始した時刻。
-
jobIdentifier: string
ジョブの識別子。
-
jobName: string
ジョブ名。
-
jobNumberOfTasks: number
ジョブ内のタスク数。
-
jobOriginOfRequest: string
ジョブ・リクエストのソース。「手動」または「スケジュール」のいずれか。
-
jobQueuedDuration: string
ジョブがキューで費やした時間の長さ(秒)。
-
jobRunDuration: string
ジョブの実行にかかった時間の長さ(秒)。
-
jobRunType: string
ジョブのタイプ。例: DATASET、DATAFLOW、SEQUENCE。
-
jobStartTimestamp: string
ジョブがリクエストされた時刻。
-
jobStatus: string
ジョブのステータス。例: ACCEPTED、IN_PROGRESS、FAILED、SUCCEEDED、CANCELING、CANCELED。
-
jobTasks: array jobTasks
ネストされたスキーマ: taskInformation
Type:
ソースを表示
object
-
taskAverageReadThroughput: number
タスクの平均読取りスループット。
-
taskDataSizeInBytes: number
タスクによって処理された合計データ(バイト)。
-
taskEndTimestamp: string
タスクが完了した時刻。
-
taskName: string
タスクの名前。
-
taskNumberOfSuccessfulRows: number
このタスクによって正常に処理された行数。
-
taskRunDuration: string
タスクの実行にかかった時間の長さ(秒)。
-
taskSourceName: string
ソース接続の名前
-
taskStartTimestamp: string
タスクの開始時刻。
-
taskStatus: string
タスクの状態例: ACCEPTED、IN_PROGRESS、FAILED、SUCCEEDED、CANCELING、CANCELED。
-
taskTargetName: string
ターゲット接続の名前
403レスポンス
禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。
ルート・スキーマ: Error
Type:
ソースを表示
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
404レスポンス
見つかりません。リクエストされたリソースが見つかりませんでした。
ルート・スキーマ: Error
Type:
ソースを表示
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
500レスポンス
内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。
ルート・スキーマ: Error
Type:
ソースを表示
object
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列。
例
この例では、特定のdatasetIDの最新のリロード操作の詳細な履歴を返します。データ・セットのオブジェクトIDは'john.smith@mycompany.com'.'MySalesDataset'で、Base64URLでエンコードされたdatasetID値はJ2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw
です。
cURLの例:
この例では、最新のリロードのジョブ履歴とタスク履歴の両方を返します。
curl -i \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --request GET 'https://<hostname>/api/20210901/catalog/datasets/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw/history/latest' \
リクエスト本文の例
Not applicable.
レスポンス本文の例
[ { "jobName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'", "jobIdentifier":"1234ABCD5678EFGH9012IJKL3456MNOP", "jobStartTimestamp":"2024-06-06T21:23:47.0+0000", "jobExecutionStartTimestamp":"2024-06-06T21:24:02.0+0000", "jobEndTimestamp":"2024-06-06T21:24:26.0+0000", "jobStatus":"SUCCEEDED", "jobRunType":"DATASET", "jobNumberOfSuccessfulRows":"72", "jobQueuedDuration":"PT39S", "jobRunDuration":"PT24S", "jobOriginOfRequest":"Manual", "jobNumberOfTasks":"1", "jobTasks":[ {"taskName":"DSET : MySalesDataSet 1", "taskStartTimestamp":"2024-06-06T21:24:14.0+0000", "taskEndTimestamp":"2024-06-06T21:24:22.0+0000", "taskStatus":"SUCCEEDED", "taskSourceName":"'john.smith@mycompany.com'.'MySalesDataSet - Set 1'", "taskTargetName":"Data Set Storage", "taskAverageReadThroughput":"1220", "taskDataSizeInBytes":"65536", "taskNumberOfSuccessfulRows":"72", "taskDuration":"PT8S"}] } ]
パラメータを使用したcURLの例:
タスク履歴を除外する場合は、問合せパラメータincludeTasks=false
を適用します。
curl -i \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --request GET 'https://<hostname>/api/20210901/catalog/datasets/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw/history/latest?includeTasks=false'