createServerInstances

Prev Next

VPC環境で利用できます。

サーバインスタンス(VM)を作成します。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/createServerInstances
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
memberServerImageInstanceNo String Conditional サーバイメージインスタンス番号
  • ユーザーが作成したサーバイメージでサーバ作成時、入力
  • memberServerImageInstanceNoserverImageNoserverImageProductCodeのうち、いずれか1つは必ず入力
  • getMemberServerImageInstanceListを参照
serverImageNo String Conditional サーバイメージ番号
  • 新規サーバイメージでサーバ作成時、入力 (KVM、RHV、XEN)
  • memberServerImageInstanceNoserverImageNoserverImageProductCodeのうち、いずれか1つは必ず入力
  • getServerImageListを参照
serverImageProductCode String Conditional サーバイメージ商品コード
  • 新規サーバイメージでサーバ作成時、入力 (RHV、XEN)
  • memberServerImageInstanceNoserverImageNoserverImageProductCodeのうち、いずれか1つは必ず入力
  • getServerImageProductListを参照
serverSpecCode String Conditional サーバスペックコード
  • serverImageNo使用時、サーバスペックを設定
  • デフォルト: 最小スペック(メモリ、CPU、基本ブロックストレージ容量、ディスクタイプ(NET)の順)
  • getServerSpecListを参照
serverProductCode String Optional サーバ商品コード
  • serverImageProductCode使用時、サーバスペックを設定
  • デフォルト: 最小スペック(メモリ、CPU、基本ブロックストレージ容量、ディスクタイプ(NET)の順)
  • getServerProductListを参照
vpcNo String Required VPC番号
  • サーバインスタンスを作成する VPCを設定
  • getVpcListを参照
subnetNo String Required Subnet番号
  • デフォルトのネットワークインターフェースの Subnet設定
  • getSubnetListを参照
isEncryptedBaseBlockStorageVolume Boolean Optional 基本ブロックストレージボリュームを暗号化するか
  • true | false (デフォルト)
    • true: 暗号化
    • false: 暗号化しない
  • RHVサーバイメージでのみ設定可能
feeSystemTypeCode String Optional 料金プランのタイプコード
  • MTRAT (デフォルト) | FXSUM
    • MTRAT: 時間制料金プラン (従量制)
    • FXSUM: 月額料金プラン (定額制)
serverCreateCount Integer Optional サーバ作成数
  • 1~100 (デフォルト: 1)
serverCreateStartNo Integer Optional サーバ作成開始番号
  • 0~999 (デフォルト: 1)
  • 2台以上のサーバを作成する際、サーバ名に付与されるシリアル番号の開始番号を決定
  • serverCreateStartNoserverCreateCountの合計は1000以内
serverName String Optional サーバ名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 入力しないと自動作成 (デフォルト)
networkInterfaceList.N.networkInterfaceOrder Integer Required ネットワークインターフェースの順序
  • 0~2
    • デフォルトのネットワークインターフェース: 0
  • 最大3個まで入力可能
  • デバイス命名規則の基準として使用
    • <例> 順序が2の場合、デバイス名は eth2
networkInterfaceList.N.networkInterfaceNo String Conditional ネットワークインターフェース番号
  • ユーザーが直接作成したネットワークインターフェース追加時、必ず入力
  • getNetworkInterfaceListを参照
networkInterfaceList.N.subnetNo String Conditional ネットワークインターフェースの Subnet番号
  • 新規ネットワークインターフェースの作成またはnetworkInterfaceNo入力時、必ず入力
  • デフォルトのネットワークインターフェースの場合、自動割り当て
  • getSubnetListを参照
networkInterfaceList.N.ip String Optional ネットワークインターフェースの IPアドレス
  • 新規ネットワークインターフェース作成時、直接設定可能
  • ネットワークインターフェースが作成される Subnetの IPアドレス範囲内で入力
    • Subnetの0~5番目、最後の IPアドレスは使用不可
    • Subnet範囲内で IPアドレスは重複不可
  • 入力しないと条件を満たす値を順次自動割り当て (デフォルト)
networkInterfaceList.N.accessControlGroupNoList.N Array Conditional ネットワークインターフェースの ACG番号リスト
  • 新規ネットワークインターフェース作成時、必ず入力
  • 最大3個まで入力可能
  • <例> accessControlGroupNoList.1=1234&accessControlGroupNoList.2=2345
  • getAccessControlGroupListを参照
placementGroupNo String Optional 物理配置グループ番号
isProtectServerTermination Boolean Optional 返却保護にするか
  • 誤って返却する事故を防止
  • true | false (デフォルト)
    • true: 保護
    • false: 保護しない
serverDescription String Optional サーバの説明(Byte)
  • 0~1000
initScriptNo String Optional 初期化スクリプト番号
  • 最初の起動時、ユーザーが設定した初期化スクリプトを実行
  • getInitScriptListを参照
loginKeyName String Optional 認証キー名
associateWithPublicIp Boolean Optional 新規グローバル IPアドレスの作成・割り当て
  • true | false (デフォルト)
    • true: 割り当て
    • false: 割り当てしない
  • Public Subnetの場合、使用可能
  • serverCreateCountが1の場合、使用可能
  • サーバの作成後に運用中状態に変更時、割り当て完了
raidTypeName String Conditional RAIDタイプ名
  • ベアメタルサーバ作成時、必ず入力
  • getRaidListを参照
blockDevicePartitionList.N.mountPoint String Optional マウントポイント
  • /(root)パスで始まるマウントポイントを入力
  • 最初のマウントポイントは、必ず/(root)を入力
  • /配下パスは英字の小文字、数にのみ使用可能で、先頭文字は英字の小文字のみ使用
  • OSごとにシステムディレクトリとして使用中のパス名は入力不可
    • <例> /root、/bin、/dev
blockDevicePartitionList.N.partitionSize String Optional パーティション容量
  • 50GB以上
blockStorageMappingList.N.order Integer Optional 作成ストレージの順序
  • KVMのみ使用可能
blockStorageMappingList.N.snapshotInstanceNo String Optional 作成ストレージスナップショット番号
  • スナップショットで作成時、入力
  • KVMのみ使用可能
blockStorageMappingList.N.blockStorageSize String Optional 作成ストレージの容量
  • KVMのみ使用可能
blockStorageMappingList.N.blockStorageName String Optional 作成ストレージ名
  • KVMのみ使用可能
blockStorageMappingList.N.blockStorageVolumeTypeCode String Optional 作成ストレージのボリュームタイプコード
  • KVMのみ使用可能
blockStorageMappingList.N.encrypted String Optional 作成ストレージを暗号化するか
  • KVMのみ使用可能
fabricClusterPoolNo String Optional GPU Fabric Cluster Poolを指定
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json
参考

リクエストクエリパラメータの入力時、下記の内容をご確認ください。

  • 新規サーバイメージでサーバを作成する場合、作成するサーバのハイパーバイザタイプによって使用可能なフィールドが次のように異なります。
    • KVM: serverImageNoserverSpecCodeを使用
    • XEN: serverImageNoserverSpecCodeまたはserverImageProductCodeserverProductCodeを使用
    • RHV: serverImageNoserverSpecCodeまたはserverImageProductCodeserverProductCodeを使用
  • associateWithPublicIp: グローバル IPアドレスの割り当て後は料金が発生しますので、使用しない場合は返却してください。
  • blockDevicePartitionList.N.mountPoint: 作成するサーバスペックによってはパーティションをサポートしない場合があります。

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/createServerInstances
?regionCode=KR
&serverImageProductCode=SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050
&vpcNo=***75
&subnetNo=***36
&serverProductCode=SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002
&feeSystemTypeCode=MTRAT
&serverCreateCount=1
&serverName=test-***
&networkInterfaceList.1.networkInterfaceOrder=0
&networkInterfaceList.1.accessControlGroupNoList.1=***43
&isProtectServerTermination=false
&loginKeyName=test-***
&associateWithPublicIp=true
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
createServerInstancesResponse Object - レスポンス結果
createServerInstancesResponse.requestId String - リクエスト ID
  • UUID形式
createServerInstancesResponse.returnCode String - レスポンスコード
createServerInstancesResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
    "createServerInstancesResponse": {
        "totalRows": 1,
        "serverInstanceList": [
            {
                "serverInstanceNo": "*****9212",
                "serverName": "test-***",
                "serverDescription": "",
                "cpuCount": 2,
                "memorySize": 8589934592,
                "platformType": {
                    "code": "UBS64",
                    "codeName": "Ubuntu Server 64 Bit"
                },
                "loginKeyName": "test-***",
                "publicIpInstanceNo": "",
                "publicIp": "",
                "serverInstanceStatus": {
                    "code": "INIT",
                    "codeName": "サーバ INIT状態"
                },
                "serverInstanceOperation": {
                    "code": "NULL",
                    "codeName": "サーバ NULL OP"
                },
                "serverInstanceStatusName": "init",
                "createDate": "2025-06-13T17:01:34+0900",
                "uptime": "2025-06-13T17:01:33+0900",
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050",
                "serverProductCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002",
                "isProtectServerTermination": false,
                "zoneCode": "KR-1",
                "regionCode": "KR",
                "vpcNo": "",
                "subnetNo": "",
                "networkInterfaceNoList": [],
                "initScriptNo": "",
                "serverInstanceType": {
                    "code": "STAND",
                    "codeName": "Standard"
                },
                "baseBlockStorageDiskType": {
                    "code": "NET",
                    "codeName": "ネットワークストレージ"
                },
                "baseBlockStorageDiskDetailType": {
                    "code": "SSD",
                    "codeName": "SSD"
                },
                "placementGroupNo": "",
                "placementGroupName": "",
                "memberServerImageInstanceNo": "",
                "hypervisorType": {
                    "code": "XEN",
                    "codeName": "XEN"
                },
                "serverImageNo": "16187005",
                "serverSpecCode": "s2-g2-s50",
                "eventList": []
            }
        ],
        "requestId": "e4a3ca5e-9b81-4b3b-8011-ad0f0e2bf71a",
        "returnCode": "0",
        "returnMessage": "success",
    }
}