Get feature list

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get the list of created features.

Request

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

Method	URI
GET	/api/v1/features

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`index`	Integer	Optional	Start location of feature list Default: 0
`limit`	Integer	Optional	Feature list 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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`index`	Integer	-	Page index (0 - N)
`limit`	Integer	-	Feature list output limit value (1 - 100)
`total`	Integer	-	Total number of features created by the user
`features.feature_id`	String	-	Feature ID
`features.feature_name`	String	-	Feature name entered by the user
`features.status`	String	-	Creation type `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: registered `pending`: pending `in_progress`: creating `completed`: available `failed`: failed
`features.created_at`	String	-	Feature creation request date (ISO 8601 format)
`features.completed_at`	String	-	Feature creation job completion date (ISO 8601 format)
`features.source_bucket`	String	-	Object Storage bucket name of the input data
`features.source_file_path`	String	-	source_bucket bucket's input data file path
`features.user_count`	Integer	-	Input data user count
`features.token_count`	Integer	-	Input data token count
`features.disk_usage`	Integer	-	Capacity (byte) of the created feature
`features.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.

{
    "index": 0,
    "limit": 20,
    "total: 172,
    "features": [
        {
            "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?

What's Next

Create feature

Table of contents

Request
Response