Feature 생성

Prev Next

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

새로운 Feature를 생성합니다.

Feature 생성을 요청하면 다음 순서에 따라 생성 작업이 진행됩니다.

순서 생성 상태 설명
Step 1 registered: 등록됨 생성 작업이 NCLUE 시스템에 등록된 상태
Step 2 pending: 대기 중 생성 작업이 시스템 대기열에 올라간 상태
Step 3 in_progress: 생성 중 생성 작업이 서버에서 실행 중인 상태
Step 4
  • complete: 사용 가능
  • failed: 실패
 생성 작업이 완료된 상태
  • 생성 성공 시 complete 상태가 되며, 정상적으로 사용 가능
  • 작업 중 발생한 오류로 인해 생성 실패 시 failed 상태가 되며, 사용 불가
참고

Feature 생성 시 각 작업 시간은 데이터 양과 서비스 가용 자원 상황에 따라 달라집니다. 생성 진행 상태는 Feature 조회 API를 호출하여 응답 바디의 status 필드에서 확인해 주십시오.

요청

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

메서드 URI
POST /features

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
name String Required Feature 이름
  • 1~100자
source_bucket String Required 시퀀스 데이터셋 파일이 저장된 Object Storage 버킷 이름
source_file_path String Required source_bucket 내 시퀀스 데이터셋 파일 경로
  • 다음 특수 문자가 포함된 파일 경로는 입력 불가
    • &$@;:+,?*\{}^%`[]<>~#|"'
    • ASCII 코드가 0~31, 128~255인 문자
  • 파일이 여러 개 있는 경우, 디렉토리 경로 입력(Hadoop 작업으로 데이터가 디렉토리 단위로 사용될 때)

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
feature_id String - Feature ID
feature_name String - Feature 이름
created_at String - Feature 생성 요청 일시(ISO 8601 형식)
source_bucket String - 시퀀스 데이터셋 파일이 저장된 Object Storage 버킷 이름
source_file_path String - source_bucket 내 시퀀스 데이터셋 파일 경로

응답 상태 코드

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

응답 예시

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

{
    "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"
}