Feature 목록 조회
    • PDF

    Feature 목록 조회

    • PDF

    기사 요약

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

    생성한 Feature의 목록을 조회합니다. 조회된 모든 Feature의 상세 정보를 확인할 수 있습니다.

    요청

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

    메서드URI
    GET/features

    요청 헤더

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

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    indexIntegerOptional목록 시작 위치
    • 기본값: 0
    limitIntegerOptional목록 출력 제한 값
    • 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}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    indexInteger-목록 시작 위치
    limitInteger-목록 출력 제한 값
    totalInteger-조회된 Feature 개수
    featuresArray-Feature 목록

    features

    features에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    feature_idString-Feature ID
    feature_nameString-Feature 이름
    statusString-Feature 상태
    • registered | pending | in_progress | completed | failed
      • registered: 등록됨
      • pending: 대기 중
      • in_progress: 생성 중
      • completed: 사용 가능
      • failed: 실패
    created_atString-Feature 생성 요청 일시(ISO 8601 형식)
    completed_atString-Feature 생성 완료 일시(ISO 8601 형식)
    source_bucketString-시퀀스 데이터셋 파일이 저장된 Object Storage 버킷 이름
    source_file_pathString-source_bucket 내 시퀀스 데이터셋 파일 경로
    user_countInteger-시퀀스 데이터셋의 사용자 수
    token_countInteger-시퀀스 데이터셋의 토큰 수
    disk_usageInteger-Feature 용량(Byte)
    fail_messageString-생성 실패 메시지

    응답 상태 코드

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

    응답 예시

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

    {
        "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
            },
            // (생략)
        ]
    }
    

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

    What's Next
    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.