データセットのリロード履歴の取得
get
/api/20210901/catalog/datasets/{datasetId}/history
指定されたデータセットのリロード履歴を返します。 ジョブ・ステータスおよび開始時刻で結果をフィルタし、タスク履歴を除外し、返されるジョブ数を制限するオプションが含まれます。 ジョブ履歴には、ジョブ名、ジョブID、ステータス、タイプ、開始時間、終了時間、実行期間、キュー期間、起点、タスク数などの詳細が含まれます。 タスク履歴には、タスク名、ステータス、ソースとターゲット、開始時間、終了時間、実行期間、処理済データのサイズ、読取り時間、成功した行数などの詳細が含まれます。
リクエスト
パス・パラメータ
- datasetId(必須): string(byte)
Base64URLエンコーディングを持つデータセットのオブジェクトID。 たとえば、データセットにオブジェクトID'Admin'dataSet124'がある場合、Base64URLでエンコードされた値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を指定すると、タスク履歴とジョブ履歴の両方が返されます。 ジョブ履歴のみを返すには、falseを指定します。 デフォルト値はtrueです。
- 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: 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' \
この例では、データ・セットのすべての履歴を返します。
ノート: 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'