Classic/VPC 환경에서 이용 가능합니다.
서비스의 업데이트 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /services/{serviceId}/updates |
요청 헤더
AiTEMS API에서 공통으로 사용하는 헤더에 대한 정보는 AiTEMS 공통 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
serviceId |
String | Required | 서비스 ID
|
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
type |
String | Required | 학습 요청 타입
|
trainVersion |
String | Required | 학습 버전
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/49qkb******/updates
?type=personalRecommend
&trainVersion=9fn93******' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
updates[].updateVersion |
String | - | 업데이트 버전 |
updates[].status |
String | - | 업데이트 상태 |
updates[].type |
String | - | 학습 요청 타입
|
updates[].createdDate |
String | - | 업데이트 요청 일시 |
updates[].finishedDate |
String | - | 업데이트 완료 일시 |
updates[].updateResult |
Object | - | 업데이트 결과 |
updates[].updateResult.inputUsersCnt |
Integer | - | 업데이트를 요청한 User 수 |
updates[].updateResult.inputItemsCnt |
Integer | - | 업데이트를 요청한 Item 수 |
updates[].updateResult.inputRowsCnt |
Integer | - | 업데이트를 요청한 Interaction(로그) 수 |
updates[].updateResult.updatedItemsCnt |
Integer | - | 업데이트된 Item 수 |
updates[].updateResult.updatedUsersCnt |
Integer | - | 업데이트된 User 수 |
응답 상태 코드
AiTEMS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 AiTEMS API 공통 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"updates": [
{
"updateVersion": "sl3ao******",
"status": "completed",
"type": "personalRecommend",
"createdDate": "2024-08-16T15:37:34.720Z",
"finishedDate": "2024-08-16T15:37:34.720Z",
"updateResult": {
"inputUsersCnt": 2,
"inputItemsCnt": 0,
"inputRowsCnt": 2,
"updatedItemsCnt": 0,
"updatedUsersCnt": 2
}
}
]
}