버전 업그레이드 상태 조회

Prev Next

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

Search Engine(OpenSearch) 클러스터 버전의 Rolling 업그레이드 진행 상태를 조회합니다.

요청

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

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

요청 헤더

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

요청 바디

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

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

요청 예시

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

curl --location --request POST 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/getRollingUpgradeProgress' \
--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*****"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.name String - 클러스터 이름
result.nodeCount Integer - 클러스터 내 총 노드 수
result.versionVo Object - Search Engine 버전 정보
result.versionVo.currentVersionCode String - 업그레이드 전 Search Engine 버전 코드
result.versionVo.targetVersionCode String - 업그레이드 후 Search Engine 버전 코드
result.versionVo.actionDate String - 작업 일시
  • yyyy-MM-dd HH:mm:ss 형식
result.nodeStatusVoList Array - 노드별 상태 정보
requestId String - 요청에 대한 아이디
  • UUID 형식

result.nodeStatusVoList

result.nodeStatusVoList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
hostname String - 서버 이름
status String - 상태
nodeRoleCode String - 노드 타입 코드
  • M | D | DO | MO
    • M: 매니저 노드
    • D, DO: 데이터 노드
    • MO: 마스터 노드
updatedDate String - 마지막 업데이트 일시
  • yyyy-MM-dd HH:mm:ss 형식

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "name": "cluster000",
        "nodeCount": 8,
        "versionVo": {
            "currentVersionCode": "2140",
            "targetVersionCode": "2150",
            "actionDate": "2025-03-24 17:09:41"
        },
        "nodeStatusVoList": [
            {
                "hostname": "cluster000-mo-6tnk",
                "status": "complete",
                "nodeRoleCode": "MO",
                "updatedDate": "2025-03-24 17:11:28"
            },
            {
                "hostname": "cluster000-mo-6tnl",
                "status": "Upgrade_OpenSearch",
                "nodeRoleCode": "MO",
                "updatedDate": "2025-03-24 17:11:28"
            },
            {
                "hostname": "cluster000-do-6tnm",
                "status": "running",
                "nodeRoleCode": "DO",
                "updatedDate": "2025-03-24 16:35:53"
            },
            {
                "hostname": "cluster000-do-6tnn",
                "status": "running",
                "nodeRoleCode": "DO",
                "updatedDate": "2025-03-24 16:35:59"
            },
            {
                "hostname": "cluster000-do-6tno",
                "status": "running",
                "nodeRoleCode": "DO",
                "updatedDate": "2025-03-24 16:36:06"
            },
            {
                "hostname": "cluster000-m-6tnh",
                "status": "running",
                "nodeRoleCode": "M",
                "updatedDate": "2025-03-24 16:36:16"
            },
            {
                "hostname": "cluster000-m-6tni",
                "status": "running",
                "nodeRoleCode": "M",
                "updatedDate": "2025-03-24 16:36:21"
            },
            {
                "hostname": "cluster000-mo-6tnj",
                "status": "running",
                "nodeRoleCode": "MO",
                "updatedDate": "2025-03-24 16:36:11"
            }
        ]
    },
    "requestId": "da7b5fcb-****-****-****-63ed6f14d4b1"
}