Upgrade version

Available in VPC

Upgrade a search engine (OpenSearch) cluster version using the rolling method. Before upgrading, make sure to check the following two items.

• Version upgrade availability
  • See Pre-check version upgrade.
• Whether a snapshot exists
  • You must have a cluster snapshot created within the last 6 hours or before the upgrade for the upgrade to be possible.
  • Snapshot creation method
    • Create from NAVER Cloud Platform console: See Search Engine Service User Guide.
    • Create using API: See Create snapshot.

Request

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

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:

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

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": "62f28b98-****-****-****-0406c09d2741"
}