Feature 조회
    • PDF

    Feature 조회

    • PDF

    The content is currently unavailable in Ja - 日本語. You are viewing the default Korean version.
    記事の要約

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

    생성한 Feature의 상세 정보를 조회합니다.

    생성 요청한 Feature의 진행 상태, 입력 데이터의 Object storage 버킷과 파일명, 그리고 생성 완료된 경우 입력 데이터의 라인수와 토큰수를 확인할 수 있습니다. 생성 실패했을 때 에러 메시지도 확인 가능합니다.

    요청

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

    메서드URI
    GET/api/v1/features/{feature_id}

    요청 헤더

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

    요청 경로 파라미터

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

    필드타입필수 여부설명
    feature_idStringRequiredFeature 아이디

    요청 예시

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

    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_idString-Feature ID
    feature_nameString-사용자가 입력한 Feature 이름
    statusString-생성 유형
    • 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 문제 해결 참조

    응답 예시

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

    성공

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

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

    실패

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


    この記事は役に立ちましたか?

    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.