MENU
      Get feature list

        Get feature list


        Article summary

        Available in VPC

        Get the list of created features. You can check the detailed information of all retrieved features.

        Request

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

        MethodURI
        GET/features

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        indexIntegerOptionalStart location of the list
        • Default: 0
        limitIntegerOptionalList output limit value
        • 1-100 (default: 20)

        Request example

        The request example is as follows:

        curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/features?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}'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        indexInteger-Start location of the list
        limitInteger-List output limit value
        totalInteger-Number of retrieved features
        featuresArray-Feature list

        features

        The following describes features.

        FieldTypeRequiredDescription
        feature_idString-Feature ID
        feature_nameString-Feature name
        statusString-Feature status
        • registered | pending | in_progress | completed | failed
          • registered: registered
          • pending: pending
          • in_progress: creating
          • completed: available
          • failed: failed
        created_atString-Feature creation request date and time (ISO 8601 format)
        completed_atString-Feature creation completion date and time (ISO 8601 format)
        source_bucketString-Bucket name of Object Storage where the sequence dataset file is stored
        source_file_pathString-Path of the sequence dataset file in source_bucket
        user_countInteger-Number of users of the sequence dataset
        token_countInteger-Number of tokens of the sequence dataset
        disk_usageInteger-Capacity (byte) of the feature
        fail_messageString-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": 6,
            "features": [
                {
                    "feature_id": "e48585fd-****-****-****-754aa0b7ba82",
                    "feature_name":"YOUR_FEATURE_NAME",
                    "status":"completed",
                    "created_at": "2024-10-08T08:08:08",
                    "completed_at": "2024-10-08T08:37:12",
                    "source_bucket":"YOUR_BUCKET_NAME",
                    "source_file_path":"path/filename",
                    "user_count": 1048371,
                    "token_count": 83704912,
                    "disk_usage": 70295634,
                    "fail_message": null
                },
                // (Omitted)
            ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        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.