Get feature
- Print
- PDF
Get feature
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Get the details of a created feature.
You can check the progress of the feature you requested to create, the Object Storage bucket and file name of the input data, and the number of lines and tokens of the input data if it has been created. You can also check the error message when the creation fails.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | /api/v1/features/{feature_id} |
Request headers
For information about the headers common to all NCLUE APIs, see Common NCLUE headers.
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
feature_id | String | Required | Feature ID
|
Request example
The request example is as follows:
curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/features/{feature_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 |
|---|---|---|---|
feature_id | String | - | Feature ID |
feature_name | String | - | Feature name entered by the user |
status | String | - | Creation type
|
created_at | String | - | Feature creation request date (ISO 8601 format) |
completed_at | String | - | Feature creation job completion date (ISO 8601 format) |
source_bucket | String | - | Object Storage bucket name of the input data |
source_file_path | String | - | source_bucket bucket's input data file path |
user_count | Integer | - | Input data user count |
token_count | Integer | - | Input data token count |
disk_usage | Integer | - | Capacity (byte) of the created feature |
fail_message | String | - | Message upon creation failure. See Troubleshooting NCLUE |
Response example
The response example is as follows:
Succeeded
The following is a sample response upon a successful call.
{
"feature_id":"f07d3344-61bc-4428-bc58-166f890b8c39",
"feature_name":"Website visit-based user behavior",
"status":"completed",
"created_at": "2024-10-08T08:08:08",
"completed_at": "2024-10-08T08:37:12",
"source_bucket":"your.bucket.name",
"source_file_path":"userdata",
"user_count": 1048371,
"token_count": 83704912,
"disk_usage": 70295634,
"fail_message": null
}
Failure
For examples of responses in the event of a failed call, see Response status codes.
Was this article helpful?