Search Engine Cluster 노드 타입 변경

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

설명

Search Engine Cluster의 노드별 타입을 변경합니다.

주의

타입 및 타입 변경 관련 주의 사항은 다음과 같습니다.

OpenSearch에서 제공하는 타입으로 Hot, Warm, Cold 방식을 지원합니다.
- Cold 방식은 향후 ObjectStorage 저장 방식으로 제공될 예정이므로 사전에 참고해 주십시오.
Manager Node는 타입을 변경할 수 없습니다. (Data Node만 타입 변경 가능)
타입 변경으로 인한 문제 발생 시 기술 지원이 어려울 수 있므로 변경 시 주의해 주십시오.

요청

요청 URL

POST https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/setHotWarmNode [수도권]
POST https://vpcsearchengine.apigw.gov-ntruss.com/api/krs-v2/cluster/setHotWarmNode [남부권]

요청 헤더

헤더명	설명
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-v2	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 파라미터

파라미터	타입	필수 여부	설명
serviceGroupInstanceNo	String	Y	변경할 Cluster의 ServiceGroupInstanceNo
List<nodeSpecList>	nodeSpecList	Y	변경할 Cluster Node 정보
computeInstanceNo	String	Y	변경할 Node의 instanceNo
nodeStorageRole	String	Y	변경할 Node의 Type [HOT, WARM]

요청 예시

POST https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/setHotWarmNode
HOST: vpcsearchengine.apigw.gov-ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1709709398936
x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2
{
    "nodeSpecList": [
        {
            "computeInstanceNo": "3427195",
            "nodeStorageRole": "HOT"
        },
        {
            "computeInstanceNo": "3427199",
            "nodeStorageRole": "HOT"
        },
        {
            "computeInstanceNo": "3427203",
            "nodeStorageRole": "WARM"
        }
    ],
    "serviceGroupInstanceNo": "3427188"
}

curl -X 'POST' 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/setHotWarmNode' 
  -H 'accept: application/json' 
  -H 'Content-Type: application/json' 
  -H 'x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2' 
  -H 'x-ncp-apigw-timestamp: 1709709398936' 
  -H 'x-ncp-apigw-signature-v2: PnjA1Rz+J77Jb6kKVBtXkGJRDnEM80fA4PKd9KKkoM4=' 
  -d '{
    "nodeSpecList": [
        {
            "computeInstanceNo": "3427195",
            "nodeStorageRole": "HOT"
        },
        {
            "computeInstanceNo": "3427199",
            "nodeStorageRole": "HOT"
        },
        {
            "computeInstanceNo": "3427203",
            "nodeStorageRole": "WARM"
        }
    ],
    "serviceGroupInstanceNo": "3427188"
}'

응답 예시

{
  "code": 0,
  "message": "SUCCESS",
  "result": true,
  "requestId": "dc0fe942-83b8-44bc-b895-5832659f99fa"
}

실패 예시

{
  "code": 10130,
  "message": "유효하지 않은 클러스터 번호입니다.",
  "result": null,
  "requestId": "cd8b84c9-5ff9-48d0-9ac1-8cc48acba49b"
}