createServerInstances

Prev Next

Classic環境で利用できます。

概要

サーバインスタンスの作成

説明

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

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
serverImageProductCode Conditional String 最小:1、最大:20 - 作成するサーバイメージを決めるためのサーバイメージ商品コード
getServerImageProductListアクションを通じて取得可能
サーバイメージ商品コード(serverImageProductCode)または会員サーバイメージ番号(memberServerImageNo)、これら2つのパラメータのうち、1つのパラメータは必須項目
serverProductCode No String 最小:1、最大:20 - 作成するサーバスペックを決めるためのサーバ商品コード
getServerProductListアクションを通じて取得可能
デフォルト:最小スペックが選択される
最小スペックの基準は、1. メモリ 2. CPU 3. 基本ブロックストレージサイズ 4. ディスクタイプ(NET、LOCAL)
memberServerImageNo Conditional String - 直接作成したサーバイメージからサーバを作成する際に必要な値
getMemberServerImageListアクションを通じて取得可能
serverName No String 最小:3、最大:30 - 作成するサーバ名
デフォルト:Ncloudが自動で割り当て
serverDescription No String 最小:1、最大:1000 作成するサーバの説明
loginKeyName No String 最小:3、最大:30 - 公開鍵で暗号化するログインキー名
デフォルト:直近で作成されたログインキー名を使用
isProtectServerTermination No Boolean 作成時に返却保護するかどうかを設定できる
デフォルト:false
serverCreateCount No Integer 最小:1、最大:20 - 一度に作成するサーバの作成数
一度に20台以上作成不可
デフォルト:1
serverCreateStartNo No Integer 一度に複数台のサーバを作成する場合、サーバ名にシリアル番号が付けられる
シリアル番号の開始番号を設定できる
サーバ作成数とサーバ作成開始番号の合計が1000を超えてはいけない
デフォルト:サーバ作成数(serverCreateCount)が1より大きい場合で、このパラメータ値がない場合は001から開始
feeSystemTypeCode No String 最小:1、最大:5 - 料金プラン区分コード
時間料金プラン(MTRAT)、定額料金プラン(FXSUM)が存在
デフォルト:時間料金プラン(MTRAT)
zoneNo No String サーバが作成されるゾーンを決定可能
getZoneListアクションを通じて取得可能
デフォルト:NAVERクラウドプラットフォームで自動で割り当て
accessControlGroupConfigurationNoList No List 最小:0、最大:5 作成時にユーザーが作成したACGを設定可能
getAccessControlGroupListアクションを通じてACG設定番号を取得可能
デフォルト:デフォルトACG番号
raidTypeName Conditional String ベアメタルサーバを作成するには、raidTypeName値の入力が必要
raidTypeNameはgetRaidListアクションを通じて取得可能
userData No String 最小:1、最大:21847 - ユーザーデータ
サーバの最初の起動時に実行されるデータスクリプトを設定可能
userDataは、スクリプト文字列をパラメータで取得する
userData値は、getServerInstanceListアクションを通じて特定のインスタンスを照会する場合にのみ返される
userData値を入力する前にBase64エンコーディング、URLエンコーディングは必須
Base64でエンコーディングされた結果を再度URLエンコーディングしないと、signature invalidエラーが発生
ユーザーデータ(userData)と初期化スクリプト番号(initScriptNo)の2つのパラメータを一緒に伝達すると、初期化スクリプトのみ実行される
スクリプト文字列を直接実行する以外にスクリプトが保存されたファイルパスをパラメータで取得可能
例) file://directory1/directory2/*.sh
例) https://{OBJECT_STORAGE_URL}/.sh
initScriptNo No String - 初期化スクリプト番号
サーバの最初の起動時、ユーザーが設定した初期化スクリプトを実行する
初期化スクリプトの初期化スクリプト番号をパラメータで伝達
ユーザーデータ(userData)と初期化スクリプト番号(initScriptNo)の2つのパラメータを一緒に伝達すると、初期化スクリプトのみ実行される
initScriptNoは、getInitScriptListアクションを通じて取得可能
instanceTagList.tagKey No String 作成するインスタンスのタグリスト(タグキー)
instanceTagList.tagValue No String 作成するインスタンスのタグリスト(タグ値)
isVaccineInstall No Boolean ウイルス対策ソフトをインストールするかどうかを設定できる(ベアメタルWindows Serverのみ)デフォルト値はtrue
blockDevicePartitionList.N.mountPoint No String 「/」(ルート)パスで始まるマウントポイントを入力する
最初のマウントポイントは必ず「/」(ルート)パーティションでなければならない
「/」(ルート)の下位名称はアルファベット小文字と数字のみ入力可能で、先頭文字はアルファベット小文字でなければならない
OSの種類によっては/root、/bin、/devなどの特定のキーワードは使用できないことがある
- マウントポイント
Bare Metalサーバを作成する場合はパーティションを指定可能
サーバスペックによってはパーティション機能がサポートされない場合がある
blockDevicePartitionList.N.partitionSize No String 最小: 50GiB - パーティションサイズ
マウントポイントのパーティションサイズを決定
パーティションサイズの合計はサーバスペックの全体容量を超えてはいけない
最後のパーティションのサイズは残り容量が自動で割り当て

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

  • ServerInstanceListタイプ
ServerInstanceList extends CommonResponse
private Integer totalRows;
private List serverInstanceList = new ArrayList();
ServerInstance
private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private Long baseBlockStorageSize;
private CommonCode platformType;
private String loginKeyName;
private Boolean isFeeChargingMonitoring;
private String publicIp;
private String privateIp;
private String serverImageName;
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 portForwardingPublicIp;
private Integer portForwardingExternalPort;
private Integer portForwardingInternalPort;
private Zone zone;
private Region region;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStorageDiskDetailType;
private CommonCode serverInstanceType
private String userData;
private List accessControlGroupList;
private List instanceTagList;
private List blockDevicePartitionList;

呼び出し

ncloud server createServerInstances --serverImageProductCode SPSW0LINUX000046 --serverProductCode SPSVRSTAND000003 --serverName ncloud-mktest

レスポンス

{
  "createServerInstancesResponse": {
    "requestId": "2ea6a22a-5ad0-4848-acae-308c817b4789",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "397255",
        "serverName": "ncloud-mktest",
        "serverDescription": "",
        "cpuCount": 1,
        "memorySize": 2147483648,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "ysw",
        "isFeeChargingMonitoring": false,
        "publicIp": "",
        "privateIp": "10.113.245.112",
        "serverImageName": "centos-7.3-64",
        "serverInstanceStatus": {
          "code": "INIT",
          "codeName": "Server INIT State"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "init",
        "createDate": "2018-02-23T13:55:34+0900",
        "uptime": "2018-02-23T13:55:34+0900",
        "serverImageProductCode": "SPSW0LINUX000046",
        "serverProductCode": "SPSVRSTAND000003",
        "isProtectServerTermination": false,
        "portForwardingPublicIp": "192.168.120.111",
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo": "1"
        },
        "region": {
          "regionNo": "1",
          "regionCode": "KR",
          "regionName": "Korea"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStroageDiskDetailType": {
          "code": "HDD",
          "codeName": "HDD"
        },
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "userData": "",
        "initScriptNo": "",
        "accessControlGroupList": []
      }
    ]
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<createServerInstancesResponse>
  <requestId>2ea6a22a-5ad0-4848-acae-308c817b4789</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstanceNo>397255</serverInstanceNo>
    <serverName>ncloud-mktest</serverName>
    <serverDescription></serverDescription>
    <cpuCount>1</cpuCount>
    <memorySize>2147483648</memorySize>
    <baseBlockStorageSize>53687091200</baseBlockStorageSize>
    <platformType>
      <code>LNX64</code>
      <codeName>Linux 64 Bit</codeName>
    </platformType>
    <loginKeyName>ysw</loginKeyName>
    <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
    <publicIp></publicIp>
    <privateIp>10.113.245.112</privateIp>
    <serverImageName>centos-7.3-64</serverImageName>
    <serverInstanceStatus>
      <code>INIT</code>
      <codeName>Server INIT State</codeName>
    </serverInstanceStatus>
    <serverInstanceOperation>
      <code>NULL</code>
      <codeName>Server NULL OP</codeName>
    </serverInstanceOperation>
    <serverInstanceStatusName>init</serverInstanceStatusName>
    <createDate>2018-02-23T13:55:34+0900</createDate>
    <uptime>2018-02-23T13:55:34+0900</uptime>
    <serverImageProductCode>SPSW0LINUX000046</serverImageProductCode>
    <serverProductCode>SPSVRSTAND000003</serverProductCode>
    <isProtectServerTermination>false</isProtectServerTermination>
    <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
    <zone>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zone>
    <region>
      <regionNo>1</regionNo>
      <regionCode>KR</regionCode>
      <regionName>Korea</regionName>
    </region>
    <baseBlockStorageDiskType>
      <code>NET</code>
      <codeName>Network Storage</codeName>
    </baseBlockStorageDiskType>
    <baseBlockStroageDiskDetailType>
      <code>HDD</code>
      <codeName>HDD</codeName>
    </baseBlockStroageDiskDetailType>
    <serverInstanceType>
      <code>STAND</code>
      <codeName>Standard</codeName>
    </serverInstanceType>
    <userData></userData>
    <initScriptNo></initScriptNo>
    <accessControlGroupList/>
  </serverInstanceList>
</createServerInstancesResponse>