Oracle Analytics CloudのためのREST API

機械翻訳について

データセットの最新のリロード履歴を取得します

get

/api/20210901/catalog/datasets/{datasetId}/history/latest

データセットの最新のリロード履歴を取得します

リクエスト

パス・パラメータ

datasetId(required): string(byte)

Base64エンコーディングのデータセットのオブジェクトID。たとえば、データセットにオブジェクトID 'Admin'.'dataSet124'がある場合は、Base64でエンコードされた値J0FkbWluJy4nZGF0YVNldDEyNCcを入力します。

問合せパラメータ

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"
    ]
}

先頭に戻る

例

この例では、特定の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/latest' \

リクエスト本文の例

Not applicable.

レスポンス本文の例

[
    {
    "jobName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'",
    "jobIdentifier":"1234ABCD5678EFGH9012IJKL3456MNOP",
    "jobStartTimestamp":"2024-06-06T21:23:47.0+0000",
    "jobExecutionStartTimestamp":"2024-06-06T21:24:02.0+0000",
    "jobEndTimestamp":"2024-06-06T21:24:26.0+0000",
    "jobStatus":"SUCCEEDED",
    "jobRunType":"DATASET",
    "jobNumberOfSuccessfulRows":"72",
    "jobQueuedDuration":"PT39S",
    "jobRunDuration":"PT24S",
    "jobOriginOfRequest":"Manual",
    "jobNumberOfTasks":"1",
    "jobTasks":[
        {"taskName":"DSET : MySalesDataSet 1",
        "taskStartTimestamp":"2024-06-06T21:24:14.0+0000",
        "taskEndTimestamp":"2024-06-06T21:24:22.0+0000",
        "taskStatus":"SUCCEEDED",
        "taskSourceName":"'john.smith@mycompany.com'.'MySalesDataSet - Set 1'",
        "taskTargetName":"Data Set Storage",
        "taskAverageReadThroughput":"1220",
        "taskDataSizeInBytes":"65536",
        "taskNumberOfSuccessfulRows":"72",
        "taskDuration":"PT8S"}]
    }
]

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

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

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

先頭に戻る