Rolling Upgrade Pre Check
- Print
- PDF
Rolling Upgrade Pre Check
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Description
Check availability before Rolling Upgrade of OpenSearch Version.
Note
RollingUpgrade can proceed only if there is a snapshot created within the previous 6 hours.
Requests
Request URL
POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck [KR]
POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/rollingUpgradePreCheck [SGN]
POST https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/rollingUpgradePreCheck [JPN]
Request headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | - This is the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 (UTC) - 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-key | Value of access key ID issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specify the request body content type as application/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| targetVersionCode | String | Y | Version code of the application to upgrade |
| ServiceGroupInstanceNo | String | Y | Target cluster number |
Request examples
POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: Qj8Jowjqu3MRMyEk/NKdagftTL/5/VhBJkTv1XKCMGQ=
x-ncp-apigw-timestamp: 1709700150235
x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2
{
"serviceGroupInstanceNo": "3427188",
"targetVersionCode": "2111"
}
curl -X 'POST' \
'https://vpcsearchengine.beta-apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2' \
-H 'x-ncp-apigw-timestamp: 1709700150235' \
-H 'x-ncp-apigw-signature-v2: Qj8Jowjqu3MRMyEk/NKdagftTL/5/VhBJkTv1XKCMGQ=' \
-d '{
"serviceGroupInstanceNo": "3427188",
"targetVersionCode": "2111"
}'
Responses
Response examples
If the version upgrade is available
It is possible to proceed with the following steps.
{
"code": 0,
"message": "SUCCESS",
"result": true,
"requestId": "1a8954a8-fd75-46e1-bc73-568e96c6d48c"
}
If it is necessary to create a snapshot
It is a case when there is no snapshot created or there is no snapshot created within the previous 6 hours. Create a snapshot in advance.
{
"code": 10154,
"message": "No snapshot created. For cluster upgrade, create a snapshot in advance",
"result": null,
"requestId": "305653e0-4bf7-4f8b-8acd-3d719815b273"
}
If TargetVersionCode is wrong
After you reconfirm searchEngineVersionCode through getSearchEngineVersionList API, request the upgrade.
{
"code": 10154,
"message": "It is a wrong cluster version. Please reconfirm",
"result": null,
"requestId": "305653e0-4bf7-4f8b-8acd-3d719815b273"
}
Was this article helpful?