createServerInstances

Prev Next

VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名 要否 タイプ 制約事項 説明
regionCode No String - リージョンコード
サーバーインスタンスを作成するリージョン(Region)を決定できる
regionCodeは、getRegionListアクションを通じて取得可能
Default: getRegionList照会結果の最初のリージョンを選択
memberServerImageInstanceNo Conditional String - 会員サーバイメージのインスタンス番号
直接作成したサーバイメージからサーバを作成する場合に入力する
会員サーバイメージのインスタンス番号(memberServerImageInstanceNo)とサーバイメージ商品コード(serverImageProductCode)のうち、1つは必ず入力
memberServerImageInstanceNoは、getMemberServerImageInstanceListアクションを通じて取得可能
serverImageProductCode Conditional String - サーバイメージ商品コード
新しいサーバイメージを利用してサーバー作成時に入力する
会員サーバイメージのインスタンス番号(memberServerImageInstanceNo)とサーバイメージ商品コード(serverImageProductCode)のうち、1つは必ず入力
serverImageProductCodeは、getServerImageProductListアクションを通じて取得可能
serverImageNo Conditional String - サーバイメージ番号
新規サーバイメージを利用してサーバー作成時に入力する
会員サーバイメージのインスタンス番号(memberServerImageInstanceNo)とサーバイメージ商品コード(serverImageProductCode)と同時使用不可
serverImageNoは、getServerImageListアクションを通じて取得可能
vpcNo Yes String - VPC番号
サーバーインスタンスを作成する VPCを決定
vpcNoは、getVpcListアクションを通じて取得可能
subnetNo Yes String - Subnet番号
作成するサーバインスタンスで基本ネットワークインターフェースのサブネットを決定する
subnetNoは、getSubnetListアクションを通じて取得可能
serverProductCode No String - サーバ商品コード
作成するサーバのスペックを決定できる
serverProductCodeは、getServerProductListアクションを通じて取得可能
Default: 最小スペックが選択される
最小スペックの基準は
1. メモリ 2. CPU 3. 基本ブロックストレージサイズ 4. ディスクタイプ(NET)の手順に決定
serverSpecCode Conditional String - サーバ商品コード
作成するサーバのスペックを決定できる
serverProductCodeは、getServerProductListアクションを通じて取得可能
serverProductCodeと serverSpecCodeは同時使用不可。
Default: 最小スペックが選択される。最小スペックの基準は
1. メモリ 2. CPU 3. 基本ブロックストレージサイズ 4. ディスクタイプ(NET)の手順に決定
isEncryptedBaseBlockStorageVolume No Boolean - 基本ブロックストレージボリューム暗号化の有無
RHVサーバイメージ商品の場合、基本ブロックストレージ暗号化かどうかを決定可能
Options : true | false
Default : false
feeSystemTypeCode No String - 料金プランタイプコード
作成するサーバの料金プランを決定できる
Options: MTRAT(時間制/従量制) | FXSUM(月額制/定額制)
Default : MTRAT
serverCreateCount No Integer Min: 1、Max: 10個 - サーバー作成数
作成するサーバの数を決定できる
Default: 1台
serverCreateStartNo No Integer Min : 0, Max : 999
サーバ作成数とサーバ作成開始番号の合計が1000を超えることはできない
- サーバー作成開始番号
サーバー作成数が1より大きい場合、サーバ名にシリアル番号が付く
この場合、シリアル番号の開始番号を決定できる
Default : 1
serverName No String Min : 3, Max : 30
アルファベットの小文字、数字、特殊文字の「-」のみ入力許可し、先頭文字はアルファベットにすること
末尾文字はアルファベットまたは数字にする
- サーバ名
Default: NAVERクラウドプラットフォームが自動で付与
networkInterfaceList.N.networkInterfaceOrder Yes Integer Min : 0, Max : 2 - ネットワークインターフェースの順序
作成するサーバに割り当てられるネットワークインターフェースの順序を決定
その順序でデバイス名(eth0、eth1など)が決定
基本ネットワークインターフェースが必ず1つ存在する必要がある
基本ネットワークインターフェースに設定するには0を入力する
ネットワークインターフェースは最大3個まで割り当てできる
networkInterfaceList.N.networkInterfaceNo Conditional String - ネットワークインターフェース番号
ユーザーが直接作成したネットワークインターフェースを追加する場合、そのネットワークインターフェース番号を入力する
networkInterfaceNoは、getNetworkInterfaceListアクションを通じて取得可能
networkInterfaceList.N.subnetNo Conditional String - ネットワークインターフェースのサブネット番号
新しく作成するネットワークインターフェースのサブネットまたは追加する既存ネットワークインターフェースのサブネットを決定する
基本ネットワークインターフェースの場合、自動で割り当てられる
subnetNoは、getSubnetListアクションを通じて取得可能
networkInterfaceList.N.ip No String - ネットワークインターフェースの IPアドレス
新規ネットワークインターフェースを作成する場合、ネットワークインターフェースに割り当てる IPアドレスを直接入力できる
ネットワークインターフェースが作成されるサブネットの IPアドレスの範囲に含まれなければならない
Subnetの0~5番目、最後の IPアドレスは使用できず、Subnetの範囲で重複した IPアドレスは使用不可
Default: 条件を満たす IPアドレスが順次割り当てられる
networkInterfaceList.N.accessControlGroupNoList.N Conditional List<String> - ネットワークインターフェースに適用する ACG番号リスト
ネットワークインターフェースを新規作成する場合、必ず適用する ACGを決定する
最大3つの ACGを適用可能
accessControlGroupNoは、getAccessControlGroupListアクションを通じて取得可能
placementGroupNo No String - 物理配置グループ番号
サーバインスタンスの所属物理配置グループを決定できる
placementGroupNoは、getPlacementGroupListアクションを通じて取得可能
isProtectServerTermination No Boolean - 返却保護の有無
サーバを作成するときに返却保護するかどうかを設定することで、誤って返却する事故を防止できる
Options : true | false
Default : false
serverDescription No String Min : 0, Max : 1000 Bytes 作成するサーバの説明
initScriptNo No String - 初期化スクリプト番号
サーバの最初の起動時にユーザーが設定した初期化スクリプトを実行できる
initScriptNoは、getInitScriptListアクションを通じて取得可能
loginKeyName No String - ログインキー名
サーバインスタンスアクセス用のパスワードを暗号化・復号するキーを決定できる
loginKeyNameは、getLoginKeyListアクションを通じて取得可能
Default: 直近で作成されたログインキー名を使用する
associateWithPublicIp No Boolean - サーバの作成時にグローバル IPアドレスの割り当ての有無
サーバの作成時に新しいグローバル IPアドレスを作成してサーバに割り当てできる
サブネットタイプが Public Subnetの場合にのみ割り当て可能で、サーバの作成数が1台の場合にのみ有効
サーバの作成後、「実行中」状態の場合に正常に割り当てが完了される
申し込まれたグローバル IPアドレスは保有中に料金が課金されるため、使用しない時は返却することを推奨
Options : true | false
Default : false
raidTypeName Conditional String - RAIDタイプ名
BareMetalサーバーを作成するためには raidTypeNameが必修
raidTypeNameは、getRaidListアクションを通じて取得可能
blockDevicePartitionList.N.mountPoint No String 「/」(root)パスで始まるマウントポイントを入力
最初のマウントポイントは必ず「/」(root)パーティション
「/」(root)の下位名称は小文字と数字のみ入力可能で、先頭文字は小文字
OSの種類によって /root, /bin, /devなどの特定のキーワードは、使用不可
- マウントポイント
Bare Metalサーバを作成する場合はパーティションを指定。
サーバスペックによってはパーティション機能がサポートされない場合がある
blockDevicePartitionList.N.partitionSize No String Min : 50 GiB - パーティションのサイズ
マウントポイントのパーティションのサイズを決定
パーティションサイズの合計はサーバスペックの全体容量を超えてはいけない
最後のパーティションのサイズは残り容量が自動で割り当て
blockStorageMappingList.N.order No Integer Min : 20 GiB - 作成ストレージの順序
作成ストレージの順序を決定。
KVMのみ使用可能。
blockStorageMappingList.N.snapshotInstanceNo No String - 作成ストレージスナップショット番号
スナップショットから作成する場合。
KVMのみ使用可能。
blockStorageMappingList.N.blockStorageSize No String - 生成ストレージのサイズ
生成ストレージのサイズを決定。
KVMのみ使用可能。
blockStorageMappingList.N.blockStorageName No String - 作成ストレージ名
作成ストレージ名を決定。
KVMのみ使用可能。
blockStorageMappingList.N.blockStorageVolumeTypeCode No String - 作成ストレージボリュームタイプコード
作成ストレージボリュームタイプを決定。
KVMのみ使用可能。
blockStorageMappingList.N.encrypted No String - 作成ストレージ暗号化の有無
作成ストレージ暗号化をするかどうかを決定。
KVMのみ使用可能。

レスポンス

レスポンスデータのタイプ

  • ServerInstanceListタイプ
ServerInstanceList extends CommonResponse
private Integer totalRows;
private List<ServerInstance> serverInstanceList = new ArrayList<>();
ServerInstance
private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private CommonCode platformType;
private String loginKeyName;
private String publicIpInstanceNo;
private String publicIp;
private CommonCode serverInstanceStatus;
private CommonCode serverInstanceOperation;
private String serverInstanceStatusName;
private Date createDate;
private Date uptime;
private String serverImageProductCode;
private String serverProductCode;
private Boolean isProtectServerTermination;
private String zoneCode;
private String regionCode;
private String vpcNo;
private String subnetNo;
private NetworkInterfaceNoList networkInterfaceNoList;
private String initScriptNo;
private CommonCode serverInstanceType;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStorageDiskDetailType;
private String placementGroupNo;
private String placementGroupName;
private String memberServerImageInstanceNo;
private List<BlockDevicePartition> blockDevicePartitionList;
BlockDevicePartition
private String mountPoint;
private String partitionSize;

リクエスト例

ncloud vserver createServerInstances --regionCode KR --serverImageProductCode SW.VSVR.OS.LNX64.CNTOS.0703.B050 --vpcNo ***04 --subnetNo ***43 --serverProductCode SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001 --feeSystemTypeCode MTRAT --serverCreateCount 1 --serverName test-*** --networkInterfaceList "networkInterfaceOrder='0', accessControlGroupNoList=['***63', '***64']" "networkInterfaceOrder='1', subnetNo='***43', accessControlGroupNoList=['***63', '***64']" --placementGroupNo ***61 --isProtectServerTermination false --initScriptNo ***44 --loginKeyName test-*** --associateWithPublicIp true

レスポンス例

<createServerInstancesResponse>
  <requestId>63a6fdb1-5430-417f-98a8-d20cacc83581</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstance>
      <serverInstanceNo>***4299</serverInstanceNo>
      <serverName>test-***</serverName>
      <serverDescription></serverDescription>
      <cpuCount>2</cpuCount>
      <memorySize>4294967296</memorySize>
      <platformType>
        <code>LNX64</code>
        <codeName>Linux 64 Bit</codeName>
      </platformType>
      <loginKeyName>test-***</loginKeyName>
      <publicIpInstanceNo></publicIpInstanceNo>
      <publicIp></publicIp>
      <serverInstanceStatus>
        <code>INIT</code>
        <codeName>Server init state</codeName>
      </serverInstanceStatus>
      <serverInstanceOperation>
        <code>NULL</code>
        <codeName>Server NULL OP</codeName>
      </serverInstanceOperation>
      <serverInstanceStatusName>init</serverInstanceStatusName>
      <createDate>2020-08-24T09:41:23+0900</createDate>
      <uptime>2020-08-24T09:41:23+0900</uptime>
      <serverImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</serverImageProductCode>
      <serverProductCode>SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001</serverProductCode>
      <isProtectServerTermination>false</isProtectServerTermination>
      <zoneCode>KR-1</zoneCode>
      <regionCode>KR</regionCode>
      <vpcNo>***04</vpcNo>
      <subnetNo>***43</subnetNo>
      <networkInterfaceNoList>
        <networkInterfaceNo>***87</networkInterfaceNo>
      </networkInterfaceNoList>
      <initScriptNo>***44</initScriptNo>
      <serverInstanceType>
        <code>STAND</code>
        <codeName>Standard</codeName>
      </serverInstanceType>
      <baseBlockStorageDiskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </baseBlockStorageDiskType>
      <baseBlockStorageDiskDetailType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </baseBlockStorageDiskDetailType>
      <placementGroupNo>***61</placementGroupNo>
      <placementGroupName>test-***</placementGroupName>
    </serverInstance>
  </serverInstanceList>
</createServerInstancesResponse>