1. Oracle Analytics ServerのためのREST API
  2. タスク
  3. カタログ
  4. データ・フロー

データ・フローの実行履歴の取得

get

/api/20210901/catalog/dataflows/{dataflowId}/history

指定されたデータ・フローの実行履歴を返します。ジョブ・ステータスおよび開始時刻で結果をフィルタし、タスク履歴を除外し、返されるジョブ数を制限するオプションが含まれます。ジョブ履歴には、ジョブ名、ジョブID、ステータス、タイプ、開始時間、終了時間、実行期間、キュー期間、起点、タスク数などの詳細が含まれます。タスク履歴には、タスク名、ステータス、ソースとターゲット、開始時間、終了時間、実行期間、処理済データのサイズ、読取り時間、成功した行数などの詳細が含まれます。

リクエスト

パス・パラメータ
  • Base64URLエンコーディングを使用したデータ・フローのオブジェクトID。たとえば、データ・フローにオブジェクトID 'User1'.'dataflow1'がある場合、Base64URLでエンコードされた値J1VzZXIxJy4nZGF0YWZsb3cxJw== を入力します。
問合せパラメータ
  • この時間値の後に開始するジョブを返します。許容される日時書式: yyyy-MM-dd'T'HH:mm:ss.SZ、yyyy-MM-dd HH:mm:ss、yyyy-MM-dd。
  • 履歴タスクおよびジョブ情報を返すか、ジョブ履歴のみを返すかを指定します。可能な値はtrueまたはfalseです。trueを指定すると、タスク履歴とジョブ履歴の両方が返されます。ジョブ履歴のみを返すには、falseを指定します。デフォルト値はtrueです。
  • 返されるジョブのステータス。有効なステータス値は、ACCEPTED、IN_PROGRESS、FAILED、SUCCEEDED、CANCELING、CANCELEDです。
  • 最新のものから返されるジョブ履歴の最大数。指定した値が、使用可能なジョブ履歴の合計数を超えると、指定されたオブジェクトのすべてのジョブが返されます。
  • この時間値より前に開始するジョブを返します。許容される日時書式: yyyy-MM-dd'T'HH:mm:ss.SZ、yyyy-MM-dd HH:mm:ss、yyyy-MM-dd。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

成功した操作。
本文()
ルート・スキーマ: schema
Type: array
ソースを表示
ネストされたスキーマ: jobInformation
Type: object
ソースを表示
ネストされたスキーマ: jobTasks
Type: array
ソースを表示
ネストされたスキーマ: taskInformation
Type: object
ソースを表示

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

404レスポンス

見つかりません。リクエストされたリソースが見つかりませんでした。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示
先頭に戻る

例

この例では、特定のdataflowIDのジョブ実行の詳細な履歴を返します。データ・フローのオブジェクトIDは'john.smith@mycompany.com'.'MySalesDataFlow: Enrich MySales Report'で、Base64URLでエンコードされたdataflowID値はJ2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhRmxvdzogRW5yaWNoIE15U2FsZXMgUmVwb3J0Jwです。

cURLの例:

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET 'https://<hostname>/api/20210901/catalog/dataflows/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhRmxvdzogRW5yaWNoIE15U2FsZXMgUmVwb3J0Jw/history' \

この例では、データ・フローのすべての履歴を返します。

ノート: numberOfJobsパラメータを使用すると、返されるジョブの数を制限できます。パラメータを省略するか、0に設定すると、すべてのジョブが返されます(numberOfJobs=0)。

リクエスト本文の例

Not applicable.

レスポンス本文の例

[
    {"jobName":"'john.smith@mycompany.com'.'MySalesDataFlow: Enrich MySales Report'",
    "jobIdentifier":"1234ABCD5678EFGH9012IJKL3456MNOP",
    "jobStartTimestamp":"2024-05-14T18:30:50.0+0000",
    "jobExecutionStartTimestamp":"2024-05-14T18:31:07.0+0000",
    "jobEndTimestamp":"2024-05-14T18:31:25.0+0000",
    "jobStatus":"SUCCEEDED",
    "jobRunType":"DATAFLOW",
    "jobQueuedDuration":"PT35S",
    "jobRunDuration":"PT18S",
    "jobOriginOfRequest":"Manual",
    "jobNumberOfTasks":"1",
    "jobTasks":[
        {"taskName":"DFLW : john.smith@mycompany.com'.'MySalesDataFlow: Enrich MySales Report",
        "taskStartTimestamp":"2024-05-14T18:31:10.0+0000",
        "taskEndTimestamp":"2024-05-14T18:31:25.0+0000",
        "taskStatus":"SUCCEEDED","taskDuration":"PT15S"
        }
    ]},
    {"jobName":"'john.smith@mycompany.com'.'MySalesDataFlow: Enrich MySales Report'",
    "jobIdentifier":"2345ABCD6789EFGH0123IJKL4567MNOP",
    "jobStartTimestamp":"2024-05-14T18:23:35.0+0000",
    "jobExecutionStartTimestamp":"2024-05-14T18:23:50.0+0000",
    "jobEndTimestamp":"2024-05-14T18:24:08.0+0000",
    "jobStatus":"SUCCEEDED",
    "jobRunType":"DATAFLOW",
    "jobQueuedDuration":"PT33S",
    "jobRunDuration":"PT18S",
    "jobOriginOfRequest":"Manual",
    "jobNumberOfTasks":"1",
    "jobTasks":[
        {"taskName":"DFLW : MySalesDataFlow: Enrich MySales Report",
        "taskStartTimestamp":"2024-05-14T18:23:53.0+0000",
        "taskEndTimestamp":"2024-05-14T18:24:08.0+0000",
        "taskStatus":"SUCCEEDED",
        "taskDuration":"PT15S"}
    ]},
    ...

パラメータを使用したcURLの例:

特定の実行履歴を返す場合は、1つ以上の問合せパラメータを適用して、ジョブ・ステータスまたは開始時刻で結果をフィルタし、タスク履歴を除外し、返されるジョブ数を制限できます。たとえば、特定の日付(2024-05-01)から成功したジョブのみを返し、タスク情報を除外できます。

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET 'https://<hostname>/api/20210901/catalog/dataflows/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhRmxvdzogRW5yaWNoIE15U2FsZXMgUmVwb3J0Jw/history?jobStatus=SUCCEEDED&fromStartTime=2024-05-01&includeTasks=false'
先頭に戻る