Get custom attributes list
- Print
- PDF
Get custom attributes list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Get the profile list of created custom attributes. You can check the detailed information of all retrieved profiles.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /profile/custom-attributes |
Request headers
For information about the headers common to all NCLUE APIs, see NCLUE request headers.
Request query parameters
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
index | Integer | Optional | Start location of the list
|
limit | Integer | Optional | List output limit value
|
Request example
The request example is as follows:
curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes?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}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
index | Integer | - | Start location of the list |
limit | Integer | - | List output limit value |
total | Integer | - | Number of retrieved profiles |
profiles | Array | - | Profile list |
profiles
The following describes profiles
.
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 |
keyword_set | String | - | Attribute keyword list
|
status | String | - | Profile status
|
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:
{
"index": 0,
"limit": 20,
"total": 2,
"profiles": [
{
"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
},
// (Omitted)
]
}
Was this article helpful?