Custom Attributesの照会

Prev Next

VPC環境で利用できます。

特定の Custom Attributes Profileの詳細情報を照会します。作成リクエストした Profileの進行状況、Profileの作成時に使用した Feature、プロファイリング結果を保存する Object Storageのバケット名とファイルパスを確認できます。作成失敗時にはエラーメッセージを確認できます。

リクエスト

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

メソッド URI
GET /profile/custom-attributes/{profile_id}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
profile_id String Required Profile ID

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "profile_id": "4d4522c7-****-****-****-a453cb89f055",
    "profile_name": "YOUR_PROFILE_NAME",
    "feature_id": "28bd06bb-****-****-****-9f2d6a9c3313",
    "feature_name": "YOUR_FEATURE_NAME",
    "keyword_set": "走り,ランニング,屋外ランニング,漢江ランニング,マラソン,ランニングサークル,10kmランニング,5kmランニング",
    "status": "completed",
    "created_at": "2024-10-18T01:33:06",
    "completed_at": "2024-10-18T01:34:20",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename",
    "line_count": 93734,
    "fail_message": null
}