스냅샷 생성 이력 조회

Prev Next

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

Search Engine 클러스터 스냅샷 생성 이력을 조회합니다.

요청

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

메서드 URI
GET /api/v2/snapshot/getSnapshotHistory/{serviceGroupInstanceNo} (수도권)
GET /api/krs-v2/snapshot/getSnapshotHistory/{serviceGroupInstanceNo} (남부권)

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
serviceGroupInstanceNo Integer Required 클러스터 인스턴스 번호

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
pageNo Integer Optional 페이지 번호
  • 1~N (기본값: 1)
pageSize Integer Optional 페이지 출력 수
  • 1~N (기본값: 10)

요청 예시

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

curl --location --request GET 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/snapshot/getSnapshotHistory/1037*****?pageNo=1&pageSize=10' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.currentPage Integer - 현재 페이지 번호
result.isFirst Boolean - 첫 페이지 여부
  • true | false
    • true: 첫 페이지
    • false: 첫 페이지 아님
result.isLast Boolean - 마지막 페이지 여부
  • true | false
    • true: 마지막 페이지
    • false: 마지막 페이지 아님
result.pageSize Integer - 페이지 출력 수
result.totalCount Integer - 응답 결과 수
result.totalPage Integer - 전체 페이지 수
result.snapshotHistoryResponseList Array - 스냅샷 생성 이력 목록
requestId String - 요청에 대한 아이디
  • UUID 형식

result.snapshotHistoryResponseList

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

필드 타입 필수 여부 설명
idx Integer - 이력 일련 번호
clusterName String - 클러스터 이름
snapshotName String - 스냅샷 이름
memberNo String - 사용자의 네이버 클라우드 플랫폼 회원 번호
serviceGroupInstanceNo Integer - 클러스터 인스턴스 번호
actionDate String - 작업 일시
  • yyyy-MM-dd HH:mm:ss 형식
duration String - 수행 시간
requestType String - 작업 유형
  • R | C
    • R: 요청
    • C: 완료
message String - 작업 내역
bucketName String - 대상 버킷 이름
hasErrorLog Boolean - 오류 발생 및 로그 생성 여부
  • true | false
    • true: 오류 발생 및 로그 존재
    • false: 오류 없음

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1,
        "snapshotHistoryResponseList": [
            {
                "idx": 7742,
                "clusterName": "cluster000",
                "snapshotName": "snapshot-20250324",
                "memberNo": "279****",
                "serviceGroupInstanceNo": 1037*****,
                "actionDate": "2025-03-24 16:49:33",
                "duration": "403ms",
                "requestType": "C",
                "message": "snapshot-20250324 스냅샷 생성 완료",
                "bucketName": "bk.ses.snapshot",
                "hasErrorLog": false
            },
            {
                "idx": 7741,
                "clusterName": "cluster000",
                "snapshotName": "snapshot-20250324",
                "memberNo": "279****",
                "serviceGroupInstanceNo": 1037*****,
                "actionDate": "2025-03-24 16:49:32",
                "duration": null,
                "requestType": "R",
                "message": "snapshot-20250324 스냅샷 생성 시작",
                "bucketName": "bk.ses.snapshot",
                "hasErrorLog": false
            }
        ]
    },
    "requestId": "835bee49-****-****-****-57a3ec4e85eb"
}