機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

データ・フローの指定されたjobIdの実行情報を取得します

get

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

データ・フローの指定されたjobIdの実行情報を取得します

リクエスト

パス・パラメータ

• dataflowId(required): string(byte)
  Base64エンコーディングによるデータ・フローのオブジェクトID。 たとえば、データ・フローのオブジェクトIDが'User1'の場合、'dataflow1'は、Base64エンコード値J1VzZXIxJy4nZGF0YWZsb3cxJw== を入力します。
• jobId(required): string(byte)

問合せパラメータ

• includeTasks: boolean(byte)
  指定可能な値:\\ trueまたはfalse。 デフォルト値はtrueです。 trueの場合、すべてのタスク履歴がジョブ履歴に含まれます。 falseの場合、ジョブ履歴のみが返されます。

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功した操作。

本文()

ルート・スキーマ: schema

Type: array

ソースを表示

• Array of: object JobInformation

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

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

{
    "properties":{
        "jobName":{
            "type":"string",
            "description":"job run name"
        },
        "jobIdentifier":{
            "type":"string",
            "description":"job run identifier"
        },
        "jobRunType":{
            "type":"string",
            "description":"type of job"
        },
        "jobStatus":{
            "type":"string",
            "description":"status of job"
        },
        "jobStartTimestamp":{
            "type":"string",
            "description":"time when job is requested"
        },
        "jobExecutionTimestamp\"":{
            "type":"string",
            "description":"time when job starts running"
        },
        "jobEndTimestamp":{
            "type":"string",
            "description":"time when job finishes running"
        },
        "jobQueuedDuration":{
            "type":"string",
            "description":"time the job stayed in queue"
        },
        "jobRunDuration":{
            "type":"string",
            "description":"time takes for job to run"
        },
        "jobOriginOfRequest":{
            "type":"string",
            "description":"source where job is requested from Manual, or Schedule"
        },
        "jobNumberOfTasks":{
            "type":"number",
            "description":"number of tasks in this job"
        },
        "jobTasks":{
            "items":{
                "type":"array",
                "$ref":"#/components/schemas/TaskInformation"
            }
        }
    }
}

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

Type: array

ソースを表示

• Array of: object TaskInformation

{
    "items":{
        "type":"array",
        "$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
  タスクのステータス
• taskTargetName: string
  ターゲット接続名

{
    "properties":{
        "taskName":{
            "type":"string",
            "description":"task run name"
        },
        "taskSourceName":{
            "type":"string",
            "description":"source connection name"
        },
        "taskTargetName":{
            "type":"string",
            "description":"target connection name"
        },
        "taskStatus":{
            "type":"string",
            "description":"status of task"
        },
        "taskDataSizeInBytes":{
            "type":"number",
            "description":"total data processed by task in bytes"
        },
        "taskStartTimestamp\"":{
            "type":"string",
            "description":"task start time"
        },
        "taskEndTimestamp":{
            "type":"string",
            "description":"task end time"
        },
        "taskAverageReadThroughput":{
            "type":"number",
            "description":"average read throughput for task"
        },
        "taskRunDuration":{
            "type":"string",
            "description":"time takes for task to run"
        },
        "taskNumberOfSuccessfulRows":{
            "type":"number",
            "description":"number of successful rows processed in 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は'[e-mail]'.'MySalesDataFlow: Base64URLセーフでエンコードされたdataflowID値J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhRmxvdzogRW5yaWNoIE15U2FsZXMgUmVwb3J0Jwを持つMySalesレポートのエンリッチ。

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":"'[e-mail]'.'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' \

先頭に戻る