ノードの変更可能なスペックの照会

Prev Next

VPC環境で利用できます。

Search Engineクラスタのノードごとに変更可能なサーバスペックを照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエストボディ

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

フィールド タイプ 必須の有無 説明
softwareProductCode String Required OSタイプコード

リクエスト例

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

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getNodeProductListForSpecChange/1037*****' \
--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 '{
    "softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0708.B050"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.managerNodeProductList Array - マネージャノードのサーバタイプリスト: サーバタイプ情報
result.dataNodeProductList Array - データノードのサーバタイプリスト: サーバタイプ情報
result.masterNodeProductList Array - マスターノードのサーバタイプリスト: サーバタイプ情報
requestId String - リクエスト ID
  • UUID形式

サーバタイプ情報

サーバタイプ情報の説明は次の通りです。

フィールド タイプ 必須の有無 説明
productCode String - サーバタイプコード
productName String - サーバタイプ名
productKoreanName String - サーバタイプ名(韓国語)
productEnglishName String - サーバタイプ名(英語)
productJapaneseName String - サーバタイプ名(日本語)
productDesc String - サーバの説明
productKoreanDesc String - サーバの説明(韓国語)
productEnglishDesc String - サーバの説明(英語)
productJapaneseDesc String - サーバの説明(日本語)
productType2Code String - サーバ区分
infraResourceTypeCode String - インフラリソースタイプ
infraResourceDetailTypeCode String - インフラリソースの詳細タイプ
cpuCount String - CPU数
memorySize Integer - メモリ容量(Byte)
baseBlockStorageProductCode Integer - 基本ブロックストレージタイプ
diskType2Code String - ディスクタイプ
isChangeSpec Boolean - サーバタイプは変更可能かどうか
  • true | false
    • true: 変更可能
    • false: 変更不可
isSelected Boolean - 現在使用中かどうか
  • true | false
    • true: 使用中
    • false: 使用中ではない

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "managerNodeProductList": [
            {
                "productCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
                "productName": "[STAND] vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productKoreanName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productEnglishName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productJapaneseName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productDesc": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productKoreanDesc": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productEnglishDesc": "[STAND] vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productJapaneseDesc": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productType2Code": "STAND",
                "infraResourceTypeCode": "VELST",
                "infraResourceDetailTypeCode": null,
                "cpuCount": "2",
                "memorySize": 8589934592,
                "baseBlockStorageProductCode": "SPBSTBSTBS000005",
                "diskType2Code": "NET",
                "isChangeSpec": true,
                "isSelected": true
            },
            ...
        ],
        "dataNodeProductList": [
            {
                "productCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
                "productName": "[STAND] vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productKoreanName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productEnglishName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productJapaneseName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productDesc": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productKoreanDesc": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productEnglishDesc": "[STAND] vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productJapaneseDesc": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productType2Code": "STAND",
                "infraResourceTypeCode": "VELST",
                "infraResourceDetailTypeCode": null,
                "cpuCount": "2",
                "memorySize": 8589934592,
                "baseBlockStorageProductCode": "SPBSTBSTBS000005",
                "diskType2Code": "NET",
                "isChangeSpec": true,
                "isSelected": true
            },
            ...
        ],
        "masterNodeProductList": [
            {
                "productCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
                "productName": "[STAND] vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productKoreanName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productEnglishName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productJapaneseName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productDesc": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productKoreanDesc": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "productEnglishDesc": "[STAND] vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productJapaneseDesc": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "productType2Code": "STAND",
                "infraResourceTypeCode": "VELST",
                "infraResourceDetailTypeCode": null,
                "cpuCount": "2",
                "memorySize": 8589934592,
                "baseBlockStorageProductCode": "SPBSTBSTBS000005",
                "diskType2Code": "NET",
                "isChangeSpec": true,
                "isSelected": false
            },
            ...
        ]
    },
    "requestId": "4d16abf0-****-****-****-1a1e60d5ee68"
}