機械翻訳について
  1. Oracle Analytics CloudのためのREST API
  2. タスク
  3. カタログ
  4. データ・フロー

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

get

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

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

リクエスト

パス・パラメータ
  • Base64エンコーディングによるデータ・フローのオブジェクトID。 たとえば、データ・フローのオブジェクトIDが'User1'の場合、'dataflow1'は、Base64エンコード値J1VzZXIxJy4nZGF0YWZsb3cxJw== を入力します。
問合せパラメータ
  • この値の後に開始時間を持つジョブを取得します。 使用可能な形式は、yyyy-MM-dd'T'HH:mm:ss.SZ、yyyy-MM-dd HH:mm:ss、yyyy-MM-ddです。
  • 指定可能な値:\\ trueまたはfalse。 デフォルト値はtrueです。 trueの場合、すべてのタスク履歴がジョブ履歴に含まれます。 falseの場合、ジョブ履歴のみが返されます。
  • 取得するジョブのステータス値。 使用可能な値の例:\\ 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: : 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'
先頭に戻る