Feature 조회

Prev Next

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

특정 Feature의 상세 정보를 조회합니다. 생성을 요청한 Feature의 진행 상태와 시퀀스 데이터셋 파일이 저장된 Object Storage 버킷 이름, 파일 경로를 확인할 수 있으며, 생성이 완료된 Feature는 시퀀스 데이터셋의 라인 수와 토큰 수까지 조회할 수 있습니다. 생성 실패 시에는 오류 메시지를 확인할 수 있습니다.

요청

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

메서드 URI
GET /features/{feature_id}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
feature_id String Required Feature ID

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
feature_id String - Feature ID
feature_name String - Feature 이름
status String - Feature 상태
  • registered | pending | in_progress | completed | failed
    • registered: 등록됨
    • pending: 대기 중
    • in_progress: 생성 중
    • completed: 사용 가능
    • failed: 실패
created_at String - Feature 생성 요청 일시(ISO 8601 형식)
completed_at String - Feature 생성 완료 일시(ISO 8601 형식)
source_bucket String - 시퀀스 데이터셋 파일이 저장된 Object Storage 버킷 이름
source_file_path String - source_bucket 내 시퀀스 데이터셋 파일 경로
user_count Integer - 시퀀스 데이터셋의 사용자 수
token_count Integer - 시퀀스 데이터셋의 토큰 수
disk_usage Integer - Feature 용량(Byte)
fail_message String | null - 생성 실패 메시지
  • 생성 실패 시 메시지를 반환하며, 성공 시에는 null 리턴
  • 메시지별 해결 방법은 NCLUE 문제 해결 참조

응답 상태 코드

NCLUE에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 NCLUE 응답 상태 코드를 참조해 주십시오.

응답 예시

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

{
    "feature_id": "848c80c1-****-****-****-120a617b1f2e",
    "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
}