스냅샷 생성

Prev Next

Search Engine 클러스터 스냅샷을 생성합니다. 생성된 스냅샷은 Object Storage 버킷에 저장됩니다.

참고

Object Storage에 접근하려면 API 인증키가 필요합니다. API 인증키 설정 방법은 다음을 참조해 주십시오.

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

메서드 URI
POST /api/v2/snapshot/createSnapshot/{serviceGroupInstanceNo}

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

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

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

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
snapshotName String Required 스냅샷 이름
  • 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~30자 이내로 입력
  • 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성
  • 특수 문자 '-' 연속 사용 불가
bucketName String Required Object Storage 버킷 이름

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

curl --location --request POST 'https://fin-vpcsearchengine.apigw.fin-ntruss.com/api/v2/snapshot/createSnapshot/1037*****' \
--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' \
--data '{
    "snapshotName": "snapshot-20250324",
    "bucketName": "bk.ses.snapshot"
}'
Shell

응답 형식을 설명합니다.

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

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
result Boolean - 응답 결과
  • true | null
    • true: 성공
    • null: 실패
requestId String - 요청에 대한 아이디
  • UUID 형식

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

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "f1c17f0b-****-****-****-9c6d0dfd5ec2"
}
JSON