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

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタのノード別に変更可能なサーバスペックを照会します。

参考

KVMハイパーバイザタイプの第3世代サーバ専用の APIです。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

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

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getServerSpecListForSpecChange' \
--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": "1009*****"
}'

レスポンスボディ

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

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

レスポンスボディのdataNodeは、ブローカーノードを意味します。

サーバタイプ情報

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

フィールド タイプ 必須の有無 説明
serverSpecCode String - サーバスペックコード
serverSpecTypeCode String - サーバ区分
serverSpecDescription String - サーバの説明
productCode String - サーバタイプコード
hypervisorCode String - ハイパーバイザコード
generationCode String - サーバの世代コード
cpuArchitectureCode String - CPUアーキテクチャタイプ
cpuCount Integer - CPU数
memorySize Integer - メモリ容量(GB)
blockStorageMaxCount Integer - 割り当て可能な最大ストレージ数
networkInterfaceMaxCount Integer - 割り当て可能な最大ネットワークインターフェース数
zoneNoList Array - ゾーン番号リスト
computeInstanceDetailTypeCode String - サーバの詳細タイプコード
isChangeSpec Boolean - サーバタイプは変更可能かどうか
  • true | false
    • true: 変更可能
    • false: 変更不可
isSelected Boolean - 現在使用中かどうか
  • true | false
    • true: 使用中
    • false: 使用中ではない
memorySizeToBytes Integer - メモリ容量(Byte)

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "managerNodeProductList": [
            {
                "serverSpecCode": "cdss.c2-g3",
                "serverSpecTypeCode": "HICPU",
                "serverSpecDescription": "[HICPU] vCPU 2EA, Memory 4GB",
                "productCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G003",
                "hypervisorCode": "KVM",
                "generationCode": "G3",
                "cpuArchitectureCode": "X86_64",
                "cpuCount": 2,
                "memorySize": 4,
                "blockStorageMaxCount": 20,
                "networkInterfaceMaxCount": 3,
                "zoneNoList": [
                    2,
                    3
                ],
                "computeInstanceDetailTypeCode": null,
                "isChangeSpec": true,
                "isSelected": true,
                "memorySizeToBytes": 4294967296
            },
            ...
        ],
        "dataNodeProductList": [
            {
                "serverSpecCode": "cdss.c2-g3",
                "serverSpecTypeCode": "HICPU",
                "serverSpecDescription": "[HICPU] vCPU 2EA, Memory 4GB",
                "productCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G003",
                "hypervisorCode": "KVM",
                "generationCode": "G3",
                "cpuArchitectureCode": "X86_64",
                "cpuCount": 2,
                "memorySize": 4,
                "blockStorageMaxCount": 20,
                "networkInterfaceMaxCount": 3,
                "zoneNoList": [
                    2,
                    3
                ],
                "computeInstanceDetailTypeCode": null,
                "isChangeSpec": true,
                "isSelected": true,
                "memorySizeToBytes": 4294967296
            },
            ...
        ]
    },
    "requestId": "3ad7ea22-****-****-****-9d0ee4c9ab2f"
}