MENU
      Login
          Login
          目次 x
          Custom Attributesの照会
            目次

            Custom Attributesの照会

              記事の要約

              VPC環境で利用できます。

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

              リクエスト

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

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

              リクエストヘッダ

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

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

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

              フィールドタイプ必須の有無説明
              profile_idStringRequiredProfile 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}'
              Shell

              レスポンス

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

              レスポンスボディ

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

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

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

              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
}
              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