Featureリストの照会

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET /features

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/features?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 - 照会された Feature数
features Array - Featureリスト

features

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

フィールド タイプ 必須の有無 説明
feature_id String - Feature ID
feature_name String - Feature名
status String - Featureの状態
  • registered | pending | in_progress | completed | failed
    • registered: 登録完了
    • pending: 待機中
    • in_progress: 作成中
    • completed: 使用可能
    • failed: 失敗
created_at String - Featureの作成リクエスト日時(ISO 8601形式)
completed_at String - Featureの作成完了日時(ISO 8601形式)
source_bucket String - シーケンスデータセットファイルが保存された Object Storageのバケット名
source_file_path String - source_bucketのシーケンスデータセットのファイルパス
user_count Integer - シーケンスデータセットのユーザー数
token_count Integer - シーケンスデータセットのトークン数
disk_usage Integer - Feature容量(Byte)
fail_message String - 作成失敗メッセージ

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

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

レスポンス例

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

{
    "index": 0,
    "limit": 20,
    "total": 6,
    "features": [
        {
            "feature_id": "e48585fd-****-****-****-754aa0b7ba82",
            "feature_name":"YOUR_FEATURE_NAME",
            "status":"completed",
            "created_at": "2024-10-08T08:08:08",
            "completed_at": "2024-10-08T08:37:12",
            "source_bucket":"YOUR_BUCKET_NAME",
            "source_file_path":"path/filename",
            "user_count": 1048371,
            "token_count": 83704912,
            "disk_usage": 70295634,
            "fail_message": null
        },
        // (省略)
    ]
}