VPC環境で利用できます。
Search Engine(OpenSearch)クラスタバージョンの Rollingアップグレードは可能かどうか確認します。
参考
直近6時間またはアップグレード前に作成したクラスタのスナップショットがないとアップグレードできません。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /api/v2/cluster/rollingUpgradePreCheck (韓国リージョン) |
| POST | /api/sgn-v2/cluster/rollingUpgradePreCheck (シンガポールリージョン) |
| POST | /api/jpn-v2/cluster/rollingUpgradePreCheck (日本リージョン) |
リクエストヘッダ
Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionNo |
String | Required | リージョン番号
|
serviceGroupInstanceNo |
String | Required | クラスタインスタンス番号
|
targetVersionCode |
String | Required | Search Engineバージョンコード
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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 '{
"regionNo": "1",
"serviceGroupInstanceNo": "1037*****",
"targetVersionCode": "2180"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
Integer | - | レスポンスコード |
message |
String | - | レスポンスメッセージ
|
result |
Boolean | - | レスポンス結果
|
requestId |
String | - | リクエスト ID
|
レスポンスステータスコード
Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
チェックの結果、アップグレードできる場合
チェックの結果、アップグレードできる場合のレスポンスのサンプルコードは次の通りです。
{
"code": 0,
"message": "SUCCESS",
"result": true,
"requestId": "d43c5717-****-****-****-7310a6f356fe"
}
チェックの結果、アップグレードできない場合
チェックの結果、アップグレードできない場合のレスポンスのサンプルコードは次の通りです。
{
"code": 10155,
"message": "targetVersionCodeは現在より上位の versionを入力してください。",
"result": null,
"requestId": "c926b283-****-****-****-26b0228155d3"
}