Change node type

Available in VPC

Change the type of a search engine cluster data node. The types of master nodes and manager nodes can't be changed.

Caution

Technical support may not be available if problems arise due to type changes. Please make your decision carefully when changing the type.

Note

Hot, Warm, and Cold node types provided by OpenSearch are supported. Cold will be supported in the future using the Object Storage method.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/api/v2/cluster/setHotWarmNode (Korea Region)
POST	/api/sgn-v2/cluster/setHotWarmNode (Singapore Region)
POST	/api/jpn-v2/cluster/setHotWarmNode (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`serviceGroupInstanceNo`	String	Required	Cluster instance number See Get cluster list.
`nodeSpecList`	Array	Required	Node type list

`nodeSpecList`

The following describes nodeSpecList.

Field	Type	Required	Description
`computeInstanceNo`	String	Required	Node server instance number See Get node list.
`nodeStorageRole`	String	Required	Node type `HOT` \| `WARM` `HOT`: Hot node `WARM`: Warm node

Request example

The request example is as follows:

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/setHotWarmNode' \
--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*****",
    "nodeSpecList": [
        {
            "computeInstanceNo": "1037*****",
            "nodeStorageRole": "HOT"
        },
        {
            "computeInstanceNo": "1037*****",
            "nodeStorageRole": "WARM"
        },
        {
            "computeInstanceNo": "1037*****",
            "nodeStorageRole": "WARM"
        }
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	Integer	-	Response code
`message`	String	-	Response message
`result`	Boolean	-	Response result `true` \| `null` `true`: succeeded `null`: failed
`requestId`	String	-	ID for the request UUID format

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "bf431869-****-****-****-c6658cdb4658"
}