VPC環境で利用できます。
Search Engine(OpenSearch)クラスタバージョンの Rolling方式でアップグレードします。アップグレード前に次の2点を必ずご確認の上、アップグレードを行ってください。
- バージョンアップ可能かどうか
- スナップショットは存在するかどうか
- 直近6時間またはアップグレード前に作成したクラスタのスナップショットがないとアップグレードできない
- スナップショットの作成方法
- NAVERクラウドプラットフォームコンソールで作成: Search Engine Serviceご利用ガイドを参照
- APIを使用して作成: スナップショットの作成を参照
注意
アップグレード中にユーザーデータがデ消失した場合、復旧はできません。必ずスナップショットでデータをバックアップしてからアップグレードを行ってください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /api/v2/cluster/rollingUpgradeCluster (韓国リージョン) |
| POST | /api/sgn-v2/cluster/rollingUpgradeCluster (シンガポールリージョン) |
| POST | /api/jpn-v2/cluster/rollingUpgradeCluster (日本リージョン) |
リクエストヘッダ
Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceGroupInstanceNo |
String | Required | クラスタインスタンス番号
|
targetVersionCode |
String | Required | Search Engineバージョンコード
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
Integer | - | レスポンスコード |
message |
String | - | レスポンスメッセージ |
result |
Boolean | - | レスポンス結果
|
requestId |
String | - | リクエスト ID
|
レスポンスステータスコード
Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": 0,
"message": "SUCCESS",
"result": true,
"requestId": "62f28b98-****-****-****-0406c09d2741"
}