MENU
      Change search engine cluster node type
        • PDF

        Change search engine cluster node type

        • PDF

        Article summary

        Available in VPC

        Description

        Change the type of each node in the search engine cluster.

        Caution

        The following are the precautions for the type and change of the type.

        • It is a type provided by OpenSearch and supports the hot, warm, and cold methods.
          • Note that the cold method will be provided as storage method in Object Storage in the future.
        • Manager nodes cannot be changed to a different type. (Only data nodes can be changed to a different type.)
        • Please be careful when changing the type, as technical support may be difficult if a problem occurs due to the change.

        Request

        Request URL

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

        Request headers

        Header nameDescription
        x-ncp-apigw-timestamp
      • It indicates the elapsed time in milliseconds since January 1, 1970 00:00:00 UTC
      • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
        x-ncp-apigw-timestamp:{Timestamp}
      • x-ncp-iam-access-keyValue of access key ID issued in the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecify the request body content type as application/json
        Content-Type: application/json

        Request parameter

        ParameterTypeRequiredDescription
        serviceGroupInstanceNoStringYserviceGroupInstanceNo of the cluster to change
        List<nodeSpecList>nodeSpecListYInformation of cluster node to change
        computeInstanceNoStringYinstanceNo of the node to change
        nodeStorageRoleStringYType [HOT, WARM] of the node to change

        Request example

        POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/setHotWarmNode
        HOST: vpcsearchengine.apigw.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"
        }
        HTTP
        curl -X 'POST' 'https://vpcsearchengine.beta-apigw.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"
        }'
        Bash

        Response example

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

        Failure example

        {
          "code": 10130,
          "message": "Invalid cluster number.",
          "result": null,
          "requestId": "cd8b84c9-5ff9-48d0-9ac1-8cc48acba49b"
        }
        JSON

        Was this article helpful?

        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.