버전 업그레이드

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

Search Engine(OpenSearch) 클러스터 버전을 Rolling 방식으로 업그레이드합니다. 업그레이드 전 반드시 다음 두 가지 사항을 확인한 후 진행해 주십시오.

버전 업그레이드 가능 여부
- 버전 업그레이드 사전 체크 참조
스냅샷 존재 여부
- 최근 6시간 또는 업그레이드 전 생성한 클러스터 스냅샷이 있어야 업그레이드 가능
- 스냅샷 생성 방법
  - 네이버 클라우드 플랫폼 콘솔에서 생성: Search Engine Service 사용 가이드 참조
  - API를 사용하여 생성: 스냅샷 생성 참조

주의

업그레이드 중 사용자 데이터 유실 시 복구가 불가능합니다. 반드시 스냅샷으로 데이터 백업 후 진행해 주십시오.

요청

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

메서드	URI
POST	/api/v2/cluster/rollingUpgradeCluster (수도권)
POST	/api/krs-v2/cluster/rollingUpgradeCluster (남부권)

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`serviceGroupInstanceNo`	String	Required	클러스터 인스턴스 번호 클러스터 목록 조회 참조
`targetVersionCode`	String	Required	Search Engine 버전 코드 버전 조회 참조

요청 예시

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

curl --location --request POST 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/rollingUpgradeCluster' \
--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 '{
  "serviceGroupInstanceNo": "1037*****",
  "targetVersionCode": "2150"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`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": "62f28b98-****-****-****-0406c09d2741"
}