Task Runリストの照会

Prev Next

VPC環境で利用できます。

作成した Task Model Runのリストを照会します。照会されたすべての Runの詳細情報を確認できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /task-runs

リクエストヘッダ

NCLUE APIで共通して使用されるヘッダの詳細は、NCLUEのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
index Integer Optional リストのスタート位置
  • デフォルト: 0
limit Integer Optional リストの出力制限値
  • 1~100(デフォルト: 20)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/task-runs?index=0&limit=20' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
index Integer - リストのスタート位置
limit Integer - リストの出力制限値
total Integer - 照会された Run数
runs Array - Runリスト

runs

runsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
run_id String - Run ID
run_name String - Run名
task_id String - 適用対象の Task ID
task_name String - 適用対象の Task名
feature_id String - Taskに適用された Feature ID
feature_name String - Taskに適用された Feature名
status String - Runの状態
  • registered | pending | in_progress | completed | failed
    • registered: 登録完了
    • pending: 待機中
    • in_progress: 作成中
    • completed: 使用可能
    • failed: 失敗
created_at String - Runの作成リクエスト日時(ISO 8601形式)
completed_at String - Runの作成完了日時(ISO 8601形式)
result_bucket String - 作業結果が保存されている Object Storageのバケット名
result_file_path String - 作業結果が保存されている result_bucketのファイルパス
line_count Integer - Taskに適用された Featureのライン数
fail_message String - 作成失敗メッセージ

レスポンスステータスコード

NCLUEで共通して使用されるレスポンスステータスコードの詳細は、NCLUEのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "index": 0,
    "limit": 20,
    "total": 3,
    "runs": [
        {
            "run_id": "ef667a87-****-****-****-88fb69a9aff7",
            "run_name": "YOUR_RUN_NAME",
            "task_id": "3179664c-****-****-****-af6354344018",
            "task_name": "YOUR_TASK_NAME",
            "feature_id": "28bd06bb-****-****-****-9f2d6a9c3313",
            "feature_name": "YOUR_FEATURE_NAME",
            "status": "completed",
            "created_at": "2024-11-22T08:54:46",
            "completed_at": "2024-11-22T08:55:22",
            "result_bucket": "YOUR_BUCKET_NAME",
            "result_file_path": "path/filename",
            "line_count": 93734,
            "fail_message": null
        },
        // (省略)
    ]
}