버전 업그레이드 사전 체크

Prev Next

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

Search Engine(OpenSearch) 클러스터 버전의 Rolling 업그레이드 가능 여부를 확인합니다.

참고

최근 6시간 또는 업그레이드 전 생성한 클러스터 스냅샷이 있어야 업그레이드가 가능합니다.

요청

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

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

요청 헤더

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/rollingUpgradePreCheck' \
--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": "2180"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
  • 업그레이드 가능: SUCCESS 표시
  • 요청 구문에 오류가 있거나 업그레이드 불가능: 실패 이유 표시
result Boolean - 응답 결과
  • true | null
    • true: 성공
    • null: 실패
requestId String - 요청에 대한 아이디
  • UUID 형식

응답 상태 코드

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

응답 예시

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

체크 결과 업그레이드 가능한 경우

체크 결과 업그레이드 가능한 경우의 응답 예시는 다음과 같습니다.

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "d43c5717-****-****-****-7310a6f356fe"
}

체크 결과 업그레이드 불가한 경우

체크 결과 업그레이드 불가한 경우의 응답 예시는 다음과 같습니다.

{
    "code": 10155,
    "message": "targetVersionCode 는 현재 보다 상위 version 이 입력되어야 합니다.",
    "result": null,
    "requestId": "c926b283-****-****-****-26b0228155d3"
}