Featureの作成

Prev Next

VPC環境で利用できます。

Featureを新規作成します。

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

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

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

リクエスト

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

メソッド URI
POST /features

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
name String Required Feature名
  • 1~100文字
source_bucket String Required シーケンスデータセットファイルが保存された Object Storageのバケット名
source_file_path String Required source_bucket内のシーケンスデータセットのファイルパス
  • 次の記号を含むファイルパスは入力不可
    • &$@=;:+,?*\{}^%`[]<>~#|"'
    • ASCIIコードが0~31、128~255の文字

リクエスト例

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

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/features' \
--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_FEATURE_NAME",
    "source_bucket": "YOUR_BUCKET_NAME",
    "source_file_path": "path/filename"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
feature_id String - Feature ID
feature_name String - Feature名
created_at String - Featureの作成リクエスト日時(ISO 8601形式)
source_bucket String - シーケンスデータセットファイルが保存された Object Storageのバケット名
source_file_path String - source_bucketのシーケンスデータセットのファイルパス

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

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

レスポンス例

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

{
    "feature_id": "848c80c1-****-****-****-120a617b1f2e",
    "feature_name": "YOUR_FEATURE_NAME",
    "created_at": "2024-11-26T10:24:22+09:00",
    "source_bucket": "YOUR_BUCKET_NAME",
    "source_file_path": "path/filename"
}