Pre-check version upgrade

Prev Next

Available in VPC

Check whether rolling upgrades are possible for a cluster version of search engine (OpenSearch).

Note

You must have a cluster snapshot created within the last 6 hours or before the upgrade for the upgrade to be possible.

Request

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

Method URI
POST /api/v2/cluster/rollingUpgradePreCheck (Korea Region)
POST /api/sgn-v2/cluster/rollingUpgradePreCheck (Singapore Region)
POST /api/jpn-v2/cluster/rollingUpgradePreCheck (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
targetVersionCode String Required Search engine version code

Request example

The request example is as follows:

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck' \
--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": "2180"
}'

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
  • Upgrade available: SUCCESS is displayed.
  • Request syntax error or upgrade unavailable: Failure cause is displayed.
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:

If upgrade is possible based on check results

The following is a sample response if the upgrade is available based on the check results.

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "d43c5717-****-****-****-7310a6f356fe"
}

If upgrade is not possible based on check results

The following is a sample response when the upgrade can't be performed based on the check results.

{
    "code": 10155,
    "message": "targetVersionCode must be entered as a version higher than the current version.",
    "result": null,
    "requestId": "c926b283-****-****-****-26b0228155d3"
}