MENU
      Custom Attributes 조회

        Custom Attributes 조회


        기사 요약

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

        생성한 Custom Attributes의 Profile 상세 정보를 조회합니다. 생성 요청한 Profile의 진행 상태, Profile 생성 시 사용한 Feature, 프로파일링 결과를 저장할 Object Storage의 버킷 이름과 파일 경로를 확인할 수 있습니다. 생성 실패 시에는 오류 메시지를 확인할 수 있습니다.

        요청

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

        메서드URI
        GET/profile/custom-attributes/{profile_id}

        요청 헤더

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

        요청 경로 파라미터

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

        필드타입필수 여부설명
        profile_idStringRequiredProfile ID

        요청 예시

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

        curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes/{profile_id}' \
        --header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
        --header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
        --header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

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

        필드타입필수 여부설명
        profile_idString-Profile ID
        profile_nameString-Profile 이름
        feature_idString-프로파일링한 Feature ID
        feature_nameString-프로파일링한 Feature 이름
        statusString-Profile 상태
        • registered | pending | in_progress | completed | failed
          • registered: 등록됨
          • pending: 대기 중
          • in_progress: 생성 중
          • completed: 사용 가능
          • failed: 실패
        created_atString-Profile 생성 요청 일시(ISO 8601 형식)
        completed_atString-Profile 생성 완료 일시(ISO 8601 형식)
        result_bucketString-프로파일링 결과가 저장된 Object Storage 버킷 이름
        result_file_pathString-프로파일링 결과가 저장된 result_bucket 내 파일 경로
        line_countInteger-프로파일링한 Feature의 라인 수
        fail_messageString-생성 실패 메시지

        응답 상태 코드

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

        응답 예시

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

        {
            "profile_id": "4d4522c7-****-****-****-a453cb89f055",
            "profile_name": "YOUR_PROFILE_NAME",
            "feature_id": "28bd06bb-****-****-****-9f2d6a9c3313",
            "feature_name": "YOUR_FEATURE_NAME",
            "keyword_set": "달리기,러닝,야외달리기,한강달리기,마라톤,달리기 동호회,10km 달리기,5km 달리기",
            "status": "completed",
            "created_at": "2024-10-18T01:33:06",
            "completed_at": "2024-10-18T01:34:20",
            "result_bucket": "YOUR_BUCKET_NAME",
            "result_file_path": "path/filename",
            "line_count": 93734,
            "fail_message": null
        }
        JSON

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

        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.