Custom Attributes 조회
- 인쇄
- PDF
Custom Attributes 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
생성한 Custom Attributes의 Profile 상세 정보를 조회합니다.
생성 요청한 Profile의 진행 상태, 속성 키워드, 프로파일링 할 Feature, 실행 결과파일을 저장할 Object storage 버킷을 확인할 수 있습니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /api/v1/profile/custom-attributes/{profile_id} |
요청 헤더
NCLUE API에서 공통으로 사용하는 헤더 정보는 NCLUE 공통 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
profile_id | String | Required | Profile 아이디
|
요청 예시
요청 예시는 다음과 같습니다.
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}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
profile_id | String | - | Profile ID |
profile_name | String | - | 사용자가 입력한 Custom Attributes의 Profile 이름 |
feature_id | String | - | 프로파일링할 Feature ID로, Custom Attributes 생성시 입력 |
feature_name | String | - | 프로파일링할 Feature 이름 |
keyword_set | String | - | 사용자가 입력한 속성 키워드 목록 (대상 사용자와 유사도를 확인할 키워드) |
status | String | - | 생성 유형
|
created_at | String | - | Custom Attributes 생성 요청 날짜 (ISO 8601 형식) |
completed_at | String | - | Custom Attributes 생성 작업 완료 날짜 (ISO 8601 형식) |
result_bucket | String | - | Custom Attributes 작업 결과를 저장할 Object Storage 버킷명 |
result_file_path | String | - | result_bucket 버킷 내 결과를 저장할 파일 경로 |
line_count | Integer | - | Custom Attributes 생성에 사용한 Feature의 라인수 |
fail_message | String | - | 생성 실패 시 메시지. NCLUE 문제 해결 참조 |
응답 예시
응답 예시는 다음과 같습니다.
성공
호출이 성공한 경우의 응답 예시는 다음과 같습니다.
{
"profile_id":"efc3f714-d267-44e2-a574-75497cc7712c",
"profile_name":"러닝/달리기 프로파일링",
"feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
"feature_name":"쇼핑 행동시퀀스 - 2024년",
"keyword_set":"러닝,달리기,마라톤,조깅,러닝화,러닝양말,러닝앱,런닝",
"status":"completed",
"created_at":"2024-11-05T11:42:53",
"completed_at":"2024-11-05T11:43:41",
"result_bucket":"your.bucket.name",
"result_file_path":"running_profiling",
"line_count": 1209478,
"fail_message":null
}
실패
호출이 실패한 경우의 응답 예시는 응답 상태 코드를 참고해 주십시오.
이 문서가 도움이 되었습니까?