Get custom attributes

Prev Next

Available in VPC

Get details of a specific custom attributes profile. You can check the progress of the created profile, the feature used to create the profile, and the name of the bucket and file path in Object Storage where the profiling results will be stored. If the creation fails, you can see the error message.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /profile/custom-attributes/{profile_id}

Request headers

For information about the headers common to all NCLUE APIs, see NCLUE request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
profile_id String Required Profile ID

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
profile_id String - Profile ID
profile_name String - Profile name
feature_id String - Feature ID to apply for profiling
feature_name String - Feature name to apply for profiling
status String - Profile status
  • registered | pending | in_progress | completed | failed
    • registered: registered
    • pending: pending
    • in_progress: creating
    • completed: available
    • failed: failed
created_at String - Profile creation request date and time (ISO 8601 format)
completed_at String - Profile creation completion date and time (ISO 8601 format)
result_bucket String - Name of the Object Storage bucket where the profiling result is stored
result_file_path String - Path of the result_bucket file where the profiling result is stored
line_count Integer - Number of lines of features apply for profiling
fail_message String - Creation failure message

Response status codes

For response status codes common to NCLUE, see NCLUE response status codes.

Response example

The response example is as follows:

{
    "profile_id": "4d4522c7-****-****-****-a453cb89f055",
    "profile_name": "YOUR_PROFILE_NAME",
    "feature_id": "28bd06bb-****-****-****-9f2d6a9c3313",
    "feature_name": "YOUR_FEATURE_NAME",
    "keyword_set": "Running, outdoor running, running along the Han River, marathon, running club, 10 km running, 5 km running",
    "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
}