Oracle Analytics ServerのためのREST API

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

get

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

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

リクエスト

パス・パラメータ

dataflowId(必須): string(byte)

Base64URLエンコーディングを使用したデータ・フローのオブジェクトID。たとえば、データ・フローにオブジェクトID 'User1'.'dataflow1'がある場合、Base64URLでエンコードされた値J1VzZXIxJy4nZGF0YWZsb3cxJw== を入力します。
jobId(必須): string(byte)

返すジョブのID。

問合せパラメータ

includeTasks: boolean(byte)

履歴タスクおよびジョブ情報を返すか、ジョブ履歴のみを返すかを指定します。可能な値はtrueまたはfalseです。trueを指定すると、タスク履歴とジョブ履歴の両方が返されます。ジョブ履歴のみを返すには、falseを指定します。デフォルト値はtrueです。

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作。

ルート・スキーマ: schema

Type: array

ソースを表示

Array of: object jobInformation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jobInformation"
    }
}

ネストされたスキーマ: 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

{
    "properties":{
        "jobName":{
            "type":"string",
            "description":"Name of the job."
        },
        "jobIdentifier":{
            "type":"string",
            "description":"Identifier for the job."
        },
        "jobRunType":{
            "type":"string",
            "description":"Type of job. For example: DATASET, DATAFLOW, SEQUENCE.\n"
        },
        "jobStatus":{
            "type":"string",
            "description":"Status of the job. For example: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.\n"
        },
        "jobStartTimestamp":{
            "type":"string",
            "description":"Time job requested."
        },
        "jobExecutionTimestamp":{
            "type":"string",
            "description":"Time job started."
        },
        "jobEndTimestamp":{
            "type":"string",
            "description":"Time job finished."
        },
        "jobQueuedDuration":{
            "type":"string",
            "description":"Length of time (in seconds) that the job spent in the queue."
        },
        "jobRunDuration":{
            "type":"string",
            "description":"Length of time taken (in seconds) for the job to run."
        },
        "jobOriginOfRequest":{
            "type":"string",
            "description":"Source of the job request. Either Manual or Schedule."
        },
        "jobNumberOfTasks":{
            "type":"number",
            "description":"Number of tasks in the job."
        },
        "jobTasks":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/taskInformation"
            }
        }
    }
}

ネストされたスキーマ: jobTasks

Type: array

ソースを表示

Array of: object taskInformation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/taskInformation"
    }
}

ネストされたスキーマ: 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

ターゲット接続の名前

{
    "properties":{
        "taskName":{
            "type":"string",
            "description":"Name of the task."
        },
        "taskSourceName":{
            "type":"string",
            "description":"Name of the source connection."
        },
        "taskTargetName":{
            "type":"string",
            "description":"Name of the target connection."
        },
        "taskStatus":{
            "type":"string",
            "description":"Status of the task. For example: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.\n"
        },
        "taskDataSizeInBytes":{
            "type":"number",
            "description":"Total data processed by the task in bytes."
        },
        "taskStartTimestamp":{
            "type":"string",
            "description":"Time the task started."
        },
        "taskEndTimestamp":{
            "type":"string",
            "description":"Time the task finished."
        },
        "taskAverageReadThroughput":{
            "type":"number",
            "description":"Average read throughput for the task."
        },
        "taskRunDuration":{
            "type":"string",
            "description":"Length of time taken (in seconds) for the task to run."
        },
        "taskNumberOfSuccessfulRows":{
            "type":"number",
            "description":"Number of rows successfully processed by this task."
        }
    }
}

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404レスポンス

見つかりません。リクエストされたリソースが見つかりませんでした。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

先頭に戻る

例

この例では、ID 1234ABCD5678EFGH9012IJKL3456MNOPおよび指定された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/1234ABCD5678EFGH9012IJKL3456MNOP' \

この例では、特定のジョブのジョブ履歴とタスク履歴の両方を返します。

リクエスト本文の例

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 : MySalesDataFlow: Enrich MySales Report",
        "taskStartTimestamp":"2024-05-14T18:31:10.0+0000",
        "taskEndTimestamp":"2024-05-14T18:31:25.0+0000",
        "taskStatus":"SUCCEEDED",
        "taskDuration":"PT15S"}]
    }
]

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

タスク履歴を除外する場合は、問合せパラメータincludeTasks=falseを適用します。

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

先頭に戻る