스냅샷 스케줄링 설정

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

Search Engine 클러스터 스냅샷이 자동 생성되도록 스케줄링을 설정합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`serviceGroupInstanceNo`	Integer	Required	클러스터 인스턴스 번호 클러스터 목록 조회 참조

요청 바디

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

필드	타입	필수 여부	설명
`snapshotName`	String	Required	스냅샷 이름 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~15자 이내로 입력 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성 특수 문자 '-' 연속 사용 불가
`bucketName`	String	Required	Object Storage 버킷 이름 버킷 목록 조회 참조
`scheduledDay`	String	Required	스냅샷 생성 요일 `Everyday` \| `Sunday` \| `Monday` \| `Tuesday` \| `Wednesday` \| `Thursday` \| `Friday` \| `Saturday` `Everyday`: 매일 `Sunday`: 일요일 `Monday`: 월요일 `Tuesday`: 화요일 `Wednesday`: 수요일 `Thursday`: 목요일 `Friday`: 금요일 `Saturday`: 토요일
`scheduledHour`	Integer	Required	스냅샷 생성 시각(시) 0~23
`scheduledMinute`	Integer	Required	스냅샷 생성 시각(분) `0` \| `15` \| `30` \| `45`

요청 예시

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

curl --location --request POST 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/snapshot/setSnapshotScheduling/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": "snpsht",
    "bucketName": "bk.ses.snapshot",
    "scheduledDay": "Everyday",
    "scheduledHour": 12,
    "scheduledMinute": 30
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`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"
}