Change Search Engine Cluster node type
    • PDF

    Change Search Engine Cluster node type

    • PDF

    Article summary

    Available in VPC

    Description

    Change the node type of the Search Engine Cluster.

    Caution

    The following describes cautions related to type changes:

    • The types are provided from OpenSearch and support Hot, Warm, and Cold methods.
      • Note that the Cold method is planned to be converted to ObjectStorage method later.
    • The type of manager nodes cannot be changed. (only data nodes can change type)
    • If a problem occurs due to type change, be cautious as technical support can be difficult.

    Requests

    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]
    

    Request headers

    Header nameDescription
    x-ncp-apigw-timestamp
  • It indicates the time elapsed since January 1, 1970, 00:00:00 (UTC) in milliseconds
  • If the time difference compared to the API Gateway server is more than 5 minutes, the request is considered invalid
    x-ncp-apigw-timestamp:{Timestamp}
  • x-ncp-iam-access-keyValue of access key ID issued from 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 parameters

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

    Request examples

    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"
    }
    
    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"
    }'
    

    Response examples

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

    Failed examples

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

    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.