MENU
      Login
          Login
          目次 x
          Task Runの照会
            目次

            Task Runの照会

              記事の要約

              VPC環境で利用できます。

              作成した Task Model Runの詳細情報を照会します。作成リクエストした Runの進行状況、Runに適用された Taskと Taskに適用された Feature、作業結果が保存された Object Storageのバケット名とファイルパスを確認できます。作成失敗時にはエラーメッセージを確認できます。

              リクエスト

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

              メソッドURI
              GET/task-runs/{run_id}

              リクエストヘッダ

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

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

              リクエストパスパラメータの説明は次の通りです。

              フィールドタイプ必須の有無説明
              run_idStringRequiredRun ID

              リクエスト例

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

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

              レスポンス

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

              レスポンスボディ

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

              フィールドタイプ必須の有無説明
              run_idString-Run ID
              run_nameString-Run名
              task_idString-適用対象の Task ID
              task_nameString-適用対象の Task名
              feature_idString-Taskに適用された Feature ID
              feature_nameString-Taskに適用された Feature名
              statusString-Runの状態
              • registered | pending | in_progress | completed | failed
                • registered: 登録完了
                • pending: 待機中
                • in_progress: 作成中
                • completed: 使用可能
                • failed: 失敗
              created_atString-Runの作成リクエスト日時(ISO 8601形式)
              completed_atString-Runの作成完了日時(ISO 8601形式)
              result_bucketString-作業結果が保存されている Object Storageのバケット名
              result_file_pathString-作業結果が保存されている result_bucketのファイルパス
              line_countInteger-Taskに適用された Featureのライン数
              fail_messageString-作成失敗メッセージ

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

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

              レスポンス例

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

              {
    "run_id": "f475197f-****-****-****-faf3dd580179",
    "run_name": "YOUR_RUN_NAME",
    "task_id": "3179664c-****-****-****-af6354344018",
    "task_name": "YOUR_TASK_NAME",
    "feature_id": "e48585fd-****-****-****-754aa0b7ba82",
    "feature_name": "YOUR_FEATURE_NAME",
    "status": "completed",
    "created_at": "2024-11-26T14:53:33",
    "completed_at": "2024-11-26T14:54:01",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename",
    "line_count": 9370,
    "fail_message": null
}
              JSON
              この記事は役に立ちましたか?
              Change password!
              Changing your password will log you out immediately. Use the new password to log back in.
              Change profile
              Success!
              First name must have atleast 2 characters. Numbers and special characters are not allowed.
              Last name must have atleast 1 characters. Numbers and special characters are not allowed.
              Enter a valid email
              Enter a valid password
              Your profile has been successfully updated.
              Logout