createServerInstances

Prev Next

VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String - リージョンコード
サーバインスタンス作成対象のリージョン(Region)を決定
regionCodeはgetRegionListアクションを通じて取得可能
デフォルト: getRegionList照会結果の最初のリージョンを選択
memberServerImageInstanceNo Conditional String - 会員サーバイメージインスタンス番号
直接作成したサーバイメージからサーバを作成時に入力
会員サーバイメージインスタンス番号(memberServerImageInstanceNo)とサーバイメージ商品コード(serverImageProductCode)のうち、いずれか一方は必ず入力
memberServerImageInstanceNoはgetMemberServerImageInstanceListアクションを通じて取得可能
serverImageProductCode Conditional String - サーバイメージ商品コード
新しいサーバイメージからサーバを作成時に入力
会員サーバイメージインスタンス番号(memberServerImageInstanceNo)、サーバイメージ商品コード(serverImageProductCode)のうち、いずれか一方は必ず入力
serverImageProductCodeはgetServerImageProductListアクションを通じて取得可能
serverImageNo Conditional String - サーバイメージ番号
新しいサーバイメージからサーバを作成時に入力
会員サーバイメージインスタンス番号(memberServerImageInstanceNo)、サーバイメージ商品コード(serverImageProductCode)と同時に使用不可
serverImageNoはgetServerImageListアクションを通じて取得可能
vpcNo Yes String - VPC番号
サーバインスタンスが作成される VPCを決定
vpcNoはgetVpcListアクションを通じて取得可能
subnetNo Yes String - Subnet番号
作成するサーバインスタンスでデフォルトのネットワークインターフェースの Subnetを決定
subnetNoはgetSubnetListアクションを通じて取得可能
serverProductCode No String - サーバ商品コード
作成するサーバのスペックを決定
serverProductCodeはgetServerProductListアクションを通じて取得可能
デフォルト: 最小スペックが選択される
最小スペックの基準は
1. メモリ 2. CPU 3. 基本ブロックストレージサイズ 4. ディスクタイプ(NET)順に決定される
serverSpecCode Conditional String - サーバ商品コード
作成するサーバのスペックを決定
serverProductCodeはgetServerProductListアクションを通じて取得可能
serverProductCodeと serverSpecCodeは同時に使用不可。
デフォルト: 最小スペックが選択される。最小スペックの基準は
1. メモリ 2. CPU 3. 基本ブロックストレージ容量 4. ディスクタイプ(NET)順に決定
isEncryptedBaseBlockStorageVolume No Boolean - 基本ブロックストレージボリュームを暗号化するか
RHVサーバイメージ商品の場合、基本ブロックストレージを暗号化するかどうかを決定できる
オプション: true | false
デフォルト: false
feeSystemTypeCode No String - 料金プランタイプコード
作成するサーバの料金プランを決定
オプション:MTRAT (時間単位料金プラン / 従量制) | FXSUM (月額料金プラン / 定額制)
デフォルト: MTRAT
serverCreateCount No Integer 最小: 1、最大: 10個 - サーバ作成数
作成するサーバの数を決定
デフォルト: 1個
serverCreateStartNo No Integer 最小: 0、最大: 999
サーバ作成数とサーバ作成開始番号の合計が1000を超えることはできない
- サーバ作成開始番号
サーバの作成数が1より大きい場合、サーバ名にシリアル番号が付く
この場合、シリアル番号の開始番号を決定できる
デフォルト: 1
serverName No String 最小: 3、最大: 30
英字の小文字、数字、記号の「-」のみ入力可能で、先頭文字は英字のみ使用
末尾文字は英字または数字のみ使用
- サーバ名
デフォルト: NAVERクラウドプラットフォームが自動で付与
networkInterfaceList.N.networkInterfaceOrder Yes Integer 最小: 0, 最大: 2 - ネットワークインターフェースの順序
作成するサーバに割り当てられるネットワークインターフェースの順序を決定
この順序でデバイス名(eth0、eth1など)が決定される
デフォルトのネットワークインターフェースが必ず1つ存在する必要がある
デフォルトのネットワークインターフェースに設定するには、0を入力
ネットワークインターフェースは最大3個まで割り当てできる
networkInterfaceList.N.networkInterfaceNo Conditional String - ネットワークインターフェース番号
ユーザーが直接作成したネットワークインターフェースを追加する場合、そのネットワークインターフェース番号を入力
networkInterfaceNoはgetNetworkInterfaceListアクションを通じて取得可能
networkInterfaceList.N.subnetNo Conditional String - ネットワークインターフェースの Subnet番号
新規作成するネットワークインターフェースのサブネットまたは追加する既存のネットワークインターフェースのサブネットを決定
デフォルトのネットワークインターフェースの場合は自動的に割り当てられる
subnetNoはgetSubnetListアクションを通じて取得可能
networkInterfaceList.N.ip No String - ネットワークインターフェースの IPアドレス
ネットワークインターフェースの新規作成時、ネットワークインターフェースに割り当てる IPアドレスを直接入力できる
ネットワークインターフェースが作成される Subnetの IPアドレス範囲内で入力
Subnetの0~5番目、最後の IPアドレスは使用不可で、Subnet範囲内で IPアドレスは重複不可
デフォルト: 条件を満たす IPアドレスが順次割り当てられる
networkInterfaceList.N.accessControlGroupNoList.N Conditional List<String> - ネットワークインターフェース適用対象の ACG番号リスト
ネットワークインターフェースを新規作成する場合、適用対象 ACGを必ず決定
ACGは最大3個まで適用可能
accessControlGroupNoはgetAccessControlGroupListアクションを通じて取得可能
placementGroupNo No String - 物理配置グループ番号
サーバインスタンスの所属物理配置グループを決定
placementGroupNoはgetPlacementGroupListアクションを通じて取得可能
isProtectServerTermination No Boolean - 返却保護にするか
サーバの作成時に返却保護するかどうかを設定することで、誤って返却する事故を防止
オプション: true | false
デフォルト: false
serverDescription No String 最小: 0, 最大: 1000 Bytes 作成するサーバについての説明
initScriptNo No String - 初期化スクリプト番号
最初の起動時、ユーザーが設定した初期化スクリプトを実行できる
initScriptNoはgetInitScriptListアクションを通じて取得可能
loginKeyName No String - ログインキー名
サーバインスタンスアクセス用のパスワードを暗号化・復号化するキーを決定
loginKeyNameはgetLoginKeyListアクションを通じて取得可能
デフォルト: 直近で作成されたログインキー名を使用
associateWithPublicIp No Boolean - サーバの作成時、パブリック IPアドレスを割り当てするか
サーバの作成時に新しいパブリック IPアドレスを作成し、サーバに割り当てできる
サブネットタイプが Public Subnetの場合にのみ割り当て可能で、サーバの作成数が1つの場合にのみ有効
サーバの作成後、「運用中」状態で正常に割り当てが完了
申し込みのパブリック IPアドレスは、保有している間は料金が発生するため、使用しない場合は返却がお勧め
オプション: true | false
デフォルト: 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 最小: 50 GiB - パーティションサイズ
マウントポイントのパーティションサイズを決定
パーティションサイズの合計は、サーバスペックの全体容量を超えることはできない
最後のパーティションのサイズは残りの容量で自動的に割り当てられる
blockStorageMappingList.N.order No Integer 最小: 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のみ使用可能。
blockStorageMappingList.N.noBlockStorage Conditional Boolean - ストレージを除外するか
ストレージを除外するかどうかを決定
基本ストレージは変更不可。
オプション: true | false
falseの場合、ストレージスナップショットインスタンス番号(snapshotInstanceNo)を必ず入力
blockStorageMappingList.N.emptyBlockStorage Conditional Boolean - ストレージの新規作成
スナップショットからストレージを作成せず、ストレージを新規作成します。
基本ストレージは変更不可。
オプション: true | false
falseの場合、ストレージスナップショットインスタンス番号(snapshotInstanceNo)を必ず入力
fabricClusterPoolNo No String - GPU Fabric Cluster Poolを指定。
KVM GPUのみ使用可能。
fabricClusterPoolNoはgetFabricClusterPoolListアクションを通じて取得可能
isPreInstallGpuDriver No Boolean - GPU Driverを事前にインストールするか
  • デフォルト: false

レスポンス

レスポンスデータタイプ

  • 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;
private CommonCode hypervisorType;
private String serverImageNo;
private String serverSpecCode;
private List<String> eventList;
private String fabricClusterPoolNo;
private String fabricClusterPoolName;
private String fabricClusterMode;
private Long fabricClusterNo;
private String fabricClusterName;
private Boolean isPreInstallGpuDriver;
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>