Feature 목록 조회

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

Classic/VPC 환경에서 이용 가능합니다.

생성한 Feature의 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/features

요청 헤더

NCLUE API에서 공통으로 사용하는 헤더 정보는 NCLUE 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`index`	Integer	Optional	Feature 목록의 시작 위치 기본값: 0
`limit`	Integer	Optional	Feature 목록 출력 제한값 1~100 (기본값: 20)

요청 예시

요청 예시는 다음과 같습니다.

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}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`index`	Integer	-	페이지 Index (0~N)
`limit`	Integer	-	Feature 목록 출력 제한값 (1~100)
`total`	Integer	-	사용자가 생성한 Feature 전체 개수
`features.feature_id`	String	-	Feature ID
`features.feature_name`	String	-	사용자가 입력한 Feature 이름
`features.status`	String	-	생성 유형 `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: 등록됨 `pending`: 대기 중 `in_progress`: 생성 중 `completed`: 사용 가능 `failed`: 실패
`features.created_at`	String	-	Feature 생성 요청 날짜 (ISO 8601 형식)
`features.completed_at`	String	-	Feature 생성 작업완료 날짜 (ISO 8601 형식)
`features.source_bucket`	String	-	입력 데이터의 Object Storage 버킷명
`features.source_file_path`	String	-	source_bucket 버킷의 입력 데이터 파일 경로
`features.user_count`	Integer	-	입력 데이터의 유저 수
`features.token_count`	Integer	-	입력 데이터의 토큰 수
`features.disk_usage`	Integer	-	생성된 Feature의 용량 (Byte)
`features.fail_message`	String	-	생성 실패 시 메시지. NCLUE 문제 해결 참조

응답 예시

응답 예시는 다음과 같습니다.

성공

호출이 성공한 경우의 응답 예시는 다음과 같습니다.

{
    "index": 0,
    "limit": 20,
    "total: 172,
    "features": [
        {
            "feature_id":"f07d3344-61bc-4428-bc58-166f890b8c39",
            "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":"userdata",
            "user_count": 1048371,
            "token_count": 83704912,
            "disk_usage": 70295634,
            "fail_message": null
        }
    ]

실패

호출이 실패한 경우의 응답 예시는 응답 상태 코드를 참고해 주십시오.

이 문서가 도움이 되었습니까?

What's Next

Feature 생성

요청
응답