データセットのリロード履歴の取得
get
/api/20210901/catalog/datasets/{datasetId}/history
データセットのリロード履歴の取得
リクエスト
パス・パラメータ
- datasetId(required): string(byte)
Base64エンコーディングのデータセットのオブジェクトID。 たとえば、データセットにオブジェクトID 'Admin'.'dataSet124'がある場合は、Base64でエンコードされた値J0FkbWluJy4nZGF0YVNldDEyNCcを入力します。
問合せパラメータ
- fromStartTime: string(byte)
この値の後に開始時間を持つジョブを取得します。 使用可能な形式は、yyyy-MM-dd'T'HH:mm:ss.SZ、yyyy-MM-dd HH:mm:ss、yyyy-MM-ddです。
- includeTasks: boolean(byte)
指定可能な値:\\ trueまたはfalse。 デフォルト値はtrueです。 trueの場合、すべてのタスク履歴がジョブ履歴に含まれます。 falseの場合、ジョブ履歴のみが返されます。
- jobStatus: string(byte)
取得するジョブのステータス値。 使用可能な値の例:\\ ACCEPTED、IN_PROGRESS、FAILED、SUCCEEDED、CANCELING、CANCELED。
- numberOfJobs: number(byte)
最新から取得するジョブ履歴の数。 存在しない場合は、オブジェクトのすべてのジョブが返されます。
- toStartTime: string(byte)
この値の前に開始時間を持つジョブを取得します。 使用可能な形式は、yyyy-MM-dd'T'HH:mm:ss.SZ、yyyy-MM-dd HH:mm:ss、yyyy-MM-ddです。
この操作のリクエスト本文がありません。
先頭に戻るレスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功した操作。
ネストされたスキーマ: JobInformation
Type:
ソースを表示
object-
jobEndTimestamp: string
ジョブの実行が終了する時間
-
jobExecutionTimestamp: 文字列
ジョブの実行を開始する時間
-
jobIdentifier: string
ジョブ実行識別子
-
jobName: string
ジョブ実行名
-
jobNumberOfTasks: number
このジョブのタスク数
-
jobOriginOfRequest: string
手動またはスケジュールからジョブが要求されるソース
-
jobQueuedDuration: string
ジョブがキューに留まった時間
-
jobRunDuration: string
ジョブの実行にかかる時間
-
jobRunType: string
ジョブのタイプ
-
jobStartTimestamp: string
ジョブがリクエストされる時間
-
jobStatus: string
ジョブのステータス
-
jobTasks: jobTasks
ネストされたスキーマ: TaskInformation
Type:
ソースを表示
object-
taskAverageReadThroughput: number
タスクの平均読取りスループット
-
taskDataSizeInBytes: number
タスクで処理された合計データ(バイト)
-
taskEndTimestamp: string
タスク終了時間
-
taskName: string
タスク実行名
-
taskNumberOfSuccessfulRows: number
このタスクで処理された成功した行数
-
taskRunDuration: string
タスクの実行にかかる時間
-
taskSourceName: string
ソース接続名
-
taskStartTimestamp: string
タスク開始時間
-
taskStatus: string
タスクのステータス
-
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' \
この例では、データ・セットのすべての履歴を返します。
ノート: numberOfJobsパラメータを使用すると、返されるジョブの数を制限できます。 パラメータを省略するか0 ( numberOfJobs=0)に設定すると、すべてのジョブが返されます。
リクエスト本文の例
Not applicable.
レスポンス本文の例
[
{
"jobName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'",
"jobIdentifier":"1234ABCD5678EFGH9012IJKL3456MNOP",
"jobStartTimestamp":"2024-06-24T16:08:44.0+0000",
"jobExecutionStartTimestamp":"2024-06-24T16:09:14.0+0000",
"jobEndTimestamp":"2024-06-24T16:09:45.0+0000",
"jobStatus":"SUCCEEDED",
"jobRunType":"DATASET",
"jobNumberOfSuccessfulRows":"29796",
"jobQueuedDuration":"PT1M1S",
"jobRunDuration":"PT31S",
"jobOriginOfRequest":"External",
"jobNumberOfTasks":"1",
"jobTasks":[{
{"taskName":"DSET : MySalesDataSet: Enrich MySales Report",
"taskStartTimestamp":"2024-06-06T21:24:14.0+0000",
"taskStatus":"IN_PROGRESS",
"taskSourceName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'",
"taskTargetName":"Data Set Storage",
"taskAverageReadThroughput":"1220",
"taskDuration":"PT7.691S"},
{"taskName":"DSET : MySalesDataSet 2",
"taskStatus":"ACCEPTED",
"taskSourceName":"Internal Data Set Storage",
"taskTargetName":"Data Set Storage",
"taskDuration":"PT477141H24M21.691S"}]
},
{"jobName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'",
"jobIdentifier":"2345ABCD6789EFGH0123IJKL4567MNOP",
"jobStartTimestamp":"2024-04-17T15:19:47.0+0000",
"jobExecutionStartTimestamp":"2024-04-17T15:20:04.0+0000",
"jobEndTimestamp":"2024-04-17T15:20:28.0+0000",
"jobStatus":"SUCCEEDED",
"jobRunType":"DATASET",
"jobNumberOfSuccessfulRows":"144",
"jobQueuedDuration":"PT41S",
"jobRunDuration":"PT24S",
"jobOriginOfRequest":"Manual",
"jobNumberOfTasks":"3",
"jobTasks":[{
{"taskName":"DSET : MySalesDataSet: Enrich MySales Report",
"taskStartTimestamp":"2024-04-17T15:20:16.0+0000",
"taskEndTimestamp":"2024-04-17T15:20:24.0+0000",
"taskStatus":"SUCCEEDED",
"taskSourceName":"'john.smith@mycompany.com'.'MySalesDataSet - Set 1'",
"taskTargetName":"Data Set Storage",
"taskAverageReadThroughput":"1714",
"taskDataSizeInBytes":"65536",
"taskNumberOfSuccessfulRows":"72",
"taskDuration":"PT8S"},
{"taskName":"DSET : MySalesDataSet 2",
"taskStartTimestamp":"2024-04-17T15:20:25.0+0000",
"taskEndTimestamp":"2024-04-17T15:20:28.0+0000",
"taskStatus":"SUCCEEDED",
"taskSourceName":"Internal Data Set Storage",
"taskTargetName":"Data Set Storage",
"taskAverageReadThroughput":"6545",
"taskDataSizeInBytes":"13486",
"taskNumberOfSuccessfulRows":"72",
"taskDuration":"PT3S"}
]
},
...
]
cURLパラメータを使用した例:
特定のリロード履歴を戻す場合は、1つ以上の問合せパラメータを適用して、ジョブ・ステータスまたは開始時間で結果をフィルタし、タスク履歴を除外して、返されるジョブ数を制限できます。 たとえば、特定の日付(2024-05-01)から成功したジョブのみを返し、タスク情報を除外できます。
curl -i \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--request GET 'https://<hostname>/api/20210901/catalog/datasets/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw/history?jobStatus=SUCCEEDED&fromStartTime=2024-05-01&includeTasks=false'