Task Runの作成

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

Task Model Runを新規作成します。

Runの作成をリクエストすると、次の順序で作成が行われます。

順序	作成状態	説明
Step 1	`registered`: 登録完了	作成作業が NCLUEシステムに登録された状態作業開始前の状態で、Runを削除すると作業をキャンセルできる
Step 2	`pending`: 待機中	作成作業がシステムキューに登録された状態
Step 3	`in_progress`: 作成中	作成作業がサーバで実行中の状態
Step 4	`complete`: 使用可能 `failed`: 失敗	作成作業が完了した状態作成に成功すると`complete`状態になり、正常に使用可能作業中に発生したエラーにより作成できなかった場合は`failed`状態になり、使用不可エラーメッセージの確認: Task Runの照会を参照エラーの解決方法: NCLUEのトラブルシューティングを参照

参考

Runの作成にかかる時間は、データ量と利用可能なリソースの状況によります。作成の進行状況は、Task Runの照会 APIを呼び出すとレスポンスボディのstatusフィールドで確認できます。

リクエスト

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

メソッド	URI
POST	/task-runs

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	Task名 1~100文字
`task_id`	String	Required	適用対象の Task ID
`feature_id`	String	Required	Taskに適用された Feature ID Taskの照会を通じて確認
`result_bucket`	String	Optional	作業結果を保存する Object Storageのバケット名
`result_file_path`	String	Optional	`result_bucket`内の作業結果を保存するファイルパス次の記号を含むファイルパスは入力不可 &$@=;:+,?*\{}^%`[]<>~#\|"' ASCIIコードが0~31、128~255の文字

リクエスト例

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

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/task-runs' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
    "name": "YOUR_RUN_NAME",
    "task_id": "3179664c-****-****-****-af6354344018",
    "feature_id": "e48585fd-****-****-****-754aa0b7ba82",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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名
`created_at`	String	-	Taskの作成リクエスト日時(ISO 8601形式)
`result_bucket`	String	-	作業結果を保存する Object Storageのバケット名
`result_file_path`	String	-	作業結果を保存する Object Storageバケットのファイルパス

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

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",
    "created_at": "2024-11-26T14:53:32+09:00",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename"
}

この記事は役に立ちましたか?

リクエスト
レスポンス