Rolling Upgrade Pre Check
    • PDF

    Rolling Upgrade Pre Check

    • PDF

    기사 요약

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

    설명

    OpenSearch의 Version을 Rolling upgrade 진행 전 가능 여부를 체크합니다.

    참고

    RollingUpgrade는 직전 6시간 이내에 생성된 SnapShot이 있는 경우에만 진행이 가능합니다.

    요청

    요청 URL

    POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck [KR]
    POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/rollingUpgradePreCheck [SGN]
    POST https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/rollingUpgradePreCheck [JPN]
    

    요청 헤더

    헤더명설명
    x-ncp-apigw-timestamp- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄
    - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2Access Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeRequest body content type을 application/json으로 지정
    Content-Type: application/json

    요청 파라미터

    파라미터타입필수 여부설명
    targetVersionCodeStringY업그레이드할 Application 의 Version Code
    ServiceGroupInstanceNoStringY대상 Cluster의 번호

    요청 예시

    POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck
    HOST: vpcsearchengine.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: Qj8Jowjqu3MRMyEk/NKdagftTL/5/VhBJkTv1XKCMGQ=
    x-ncp-apigw-timestamp: 1709700150235
    x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2
    {
      "serviceGroupInstanceNo": "3427188",
      "targetVersionCode": "2111"
    }
    
    curl -X 'POST' \
      'https://vpcsearchengine.beta-apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -H 'x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2' \
      -H 'x-ncp-apigw-timestamp: 1709700150235' \
      -H 'x-ncp-apigw-signature-v2: Qj8Jowjqu3MRMyEk/NKdagftTL/5/VhBJkTv1XKCMGQ=' \
      -d '{
      "serviceGroupInstanceNo": "3427188",
      "targetVersionCode": "2111"
    }'
    

    응답

    응답 예시

    버전 업그레이드 진행이 가능한 경우

    다음 단계로 진행이 가능합니다.

    {
      "code": 0,
      "message": "SUCCESS",
      "result": true,
      "requestId": "1a8954a8-fd75-46e1-bc73-568e96c6d48c"
    }
    

    스냅샷 생성이 필요한 경우

    생성된 스냅샷이 없거나 6시간 이내 생성된 스냅샷이 없는 경우입니다. 스냅샷을 먼저 생성해 주십시오.

    {
      "code": 10154,
      "message": "생성된 SnapShot이 없습니다. 클러스터 업그레이드를 위해서 SnapShot을 먼저 생성해 주세요",
      "result": null,
      "requestId": "305653e0-4bf7-4f8b-8acd-3d719815b273"
    }
    

    TargetVersionCode 가 잘못된 경우

    getSearchEngineVersionList API를 통해 searchEngineVersionCode를 재확인 후 요청해 주십시오.

    {
      "code": 10154,
      "message": "잘못된 클러스터 버전입니다. 재 확인 하세요",
      "result": null,
      "requestId": "305653e0-4bf7-4f8b-8acd-3d719815b273"
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.