ノードタイプの変更

Prev Next

VPC環境で利用できます。

Search Engineクラスタデータノードのタイプを変更します。マスターノードとマネージャノードはタイプは変更できません。

注意

タイプ変更による問題発生時、テクニカルサポートが困難な場合があります。変更の際にはご注意ください。

参考

OpenSearchが提供する Hot、Warm、Coldノードタイプをサポートします。Coldは Object Storage保存方法として今後サポートする予定です。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v2/cluster/setHotWarmNode (韓国リージョン)
POST /api/sgn-v2/cluster/setHotWarmNode (シンガポールリージョン)
POST /api/jpn-v2/cluster/setHotWarmNode (日本リージョン)

リクエストヘッダ

Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo String Required クラスタインスタンス番号
nodeSpecList Array Required ノードタイプリスト

nodeSpecList

nodeSpecListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
computeInstanceNo String Required ノードサーバインスタンス番号
nodeStorageRole String Required ノードタイプ
  • HOT | WARM
    • HOT: Hotノード
    • WARM: Warmノード

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/setHotWarmNode' \
--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*****",
    "nodeSpecList": [
        {
            "computeInstanceNo": "1037*****",
            "nodeStorageRole": "HOT"
        },
        {
            "computeInstanceNo": "1037*****",
            "nodeStorageRole": "WARM"
        },
        {
            "computeInstanceNo": "1037*****",
            "nodeStorageRole": "WARM"
        }
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Boolean - レスポンス結果
  • true | null
    • true: 成功
    • null: 失敗
requestId String - リクエスト ID
  • UUID形式

レスポンスステータスコード

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "bf431869-****-****-****-c6658cdb4658"
}