Create feature

Prev Next

Available in VPC

Create a new feature.

When you request to create a feature, the creation process will proceed according to the following sequence.

Order Creation status Description
Step 1 registered: registered Status where the creation job is registered in the NCLUE system
  • It is the status before the start of the job, and you can Delete feature to cancel the job
Step 2 pending: pending Status where the creation job is queued in the system
Step 3 in_progress: creating Status where the creation job is running on the server
Step 4
  • complete: available
  • failed: failure
 Status where the creation job has been completed
  • If the creation is successful, the status will be complete, and it can be used normally
  • If the creation fails due to an error that occurred during the operation, the status will be failed and it can't be used
Note

The duration of each job when creating a feature depends on the amount of data and service's available resources. To check the progress of the creation, call the Get feature API and check the status field in the response body.

Request

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

Method URI
POST /features

Request headers

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

Request body

You can include the following data in the body of your request:

Field Type Required Description
name String Required Feature name
  • 1-100 characters
source_bucket String Required Bucket name of Object Storage where the sequence dataset file is stored
source_file_path String Required Sequence dataset file path in source_bucket
  • File paths containing the following special characters can't be entered
    • &$@=;:+,?*\{}^%`[]<>~#|"'
    • Characters with ASCII codes 0 to 31 and 128 to 255

Request example

The request example is as follows:

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/features' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
    "name": "YOUR_FEATURE_NAME",
    "source_bucket": "YOUR_BUCKET_NAME",
    "source_file_path": "path/filename"
}'

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
created_at String - Feature creation request date and time (ISO 8601 format)
source_bucket String - Bucket name of Object Storage where the sequence dataset file is stored
source_file_path String - Path of the sequence dataset file in source_bucket

Response status codes

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

Response example

The response example is as follows:

{
    "feature_id": "848c80c1-****-****-****-120a617b1f2e",
    "feature_name": "YOUR_FEATURE_NAME",
    "created_at": "2024-11-26T10:24:22+09:00",
    "source_bucket": "YOUR_BUCKET_NAME",
    "source_file_path": "path/filename"
}