本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> コンピューティング> RunInstances
本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/RunInstances.htmへ移行しました。 今後は新ページをご参照ください。

RunInstances

処理概要

サーバーを新規作成します。1回のリクエストで、1つのサーバーを作成できます。

サーバーの作成には、時間がかかることがあります。このAPIのレスポンス「instanceState」を確認し「pending」が返ってきた、またはタイムアウトした場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。

APIのパラメーターに「IpType」、「NetworkInterface.n.NetworkId」両方を指定しなかった場合、「IpType」パラメーターのdefault値が適用されます。

UserDataを指定してリクエストする場合は、POSTのみの対応となりますので、ご注意ください。

指定するパラメーター

パラメーター 型 説明 必須
ImageId string OSイメージID
 ○
MinCount integer ※指定不可
MaxCount integer ※指定不可
KeyName string SSHキー名
 ○ (スタンダードイメージのWindows以外)
SecurityGroup.n string 適用するファイアウォールグループ名
UserData string サーバー起動時スクリプト
UserData.Encoding string サーバー起動時スクリプトのエンコード
Default: base64
使用可能文字: プレーンテキストの場合は空、base64の場合はbase64
AddressingType string ※指定不可
InstanceType string サーバータイプ
値:
  • e-mini
  • h2-mini
  • mini
  • c-small
  • e-small
  • h2-small
  • small
  • c-small2
  • e-small2
  • h2-small2
  • small2
  • c-small4
  • e-small4
  • h2-small4
  • small4
  • e-small8
  • h2-small8
  • small8
  • e-small16
  • h2-small16
  • small16
  • c-medium
  • e-medium
  • h2-medium
  • medium
  • c-medium4
  • e-medium4
  • h2-medium4
  • medium4
  • c-medium8
  • e-medium8
  • h2-medium8
  • medium8
  • e-medium16
  • h2-medium16
  • medium16
  • e-medium24
  • h2-medium24
  • medium24
  • c-large
  • e-large
  • h2-large
  • large
  • c-large8
  • e-large8
  • h2-large8
  • large8
  • e-large16
  • h2-large16
  • large16
  • e-large24
  • h2-large24
  • large24
  • e-large32
  • h2-large32
  • large32
  • e-extra-large8
  • h2-extra-large8
  • extra-large8
  • e-extra-large16
  • h2-extra-large16
  • extra-large16
  • e-extra-large24
  • h2-extra-large24
  • extra-large24
  • e-extra-large32
  • h2-extra-large32
  • extra-large32
  • e-extra-large48
  • h2-extra-large48
  • extra-large48
  • e-double-large16
  • h2-double-large16
  • double-large16
  • e-double-large24
  • h2-double-large24
  • double-large24
  • e-double-large32
  • h2-double-large32
  • double-large32
  • e-double-large48
  • h2-double-large48
  • double-large48
  • e-double-large64
  • h2-double-large64
  • double-large64
  • e-double-large96
  • h2-double-large96
  • double-large96
  • h2-triple-large32
  • triple-large32
  • h2-triple-large48
  • triple-large48
  • h2-triple-large64
  • triple-large64
  • h2-triple-large96
  • triple-large96
  • h2-triple-large128
  • triple-large128
  • h2-quad-large64
  • quad-large64
  • h2-quad-large96
  • quad-large96
  • h2-quad-large128
  • quad-large128
  • h2-septa-large128
  • septa-large128
Default: mini
Placement.GroupName string ※指定不可
Placement.AvailabilityZone string ゾーン情報
Default: ニフクラが決定
KernelId string ※指定不可
RamdiskId string ※指定不可
BlockDeviceMapping.n.DeviceName string ※指定不可
BlockDeviceMapping.n.VirtualName string ※指定不可
BlockDeviceMapping.n.Ebs.SnapshotId string ※指定不可
BlockDeviceMapping.n.Ebs.VolumeSize integer ※指定不可
BlockDeviceMapping.n.Ebs.DeleteOnTermination boolean ※指定不可
BlockDeviceMapping.n.Ebs.NoDevice boolean ※指定不可
Monitoring.Enabled boolean ※指定不可
Default: false (基本監視の設定なし)
SubnetId string ※指定不可
DisableApiTermination boolean APIからのサーバー削除の可否
値:
  • true (削除不可)
  • false (削除可)
Default: true (削除不可)
InstanceInitiatedShutdownBehavior string ※指定不可
AccountingType string 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
Default: 2 (従量課金)
InstanceId string サーバー名
Default: 英数8文字 (システム発行)
Admin string 管理者アカウント
※Windows OS選択時のみ必須
 ○ (スタンダードイメージのWindows)
Password string 管理者アカウントパスワード
 ○ (スタンダードイメージのWindows)
IpType string IPアドレスのタイプ
値:
  • static (固定化)
  • elastic (付替)
  • none (グローバルIPなし)
Default: static (NetworkInterfaceの定義が指定されていれば、NetworkInterfaceの定義を適用)
PublicIp string 付替グローバルIPアドレス
 ○ (IpTypeがelasticの場合)
Agreement boolean Red Hat Enterprise Linux 5.8 64bit / 6.3 64bit、またはSPLAサーバーを指定した場合の同意
値:
  • true (同意する)
  • false (同意しない)
Default: false (同意しない)
Description string メモ
NetworkInterface.n.DeviceIndex integer ※指定不可
NetworkInterface.n.SecurityGroupId.n string ※指定不可
NetworkInterface.n.NetworkId string ネットワークID
使用可能文字: net-COMMON_GLOBAL(共通グローバル)、net-COMMON_PRIVATE(共通プライベート)、プライベートLAN のネットワークID
 ○ (ネットワーク名といずれか)
NetworkInterface.n.NetworkName string ネットワーク名
 ○ (ネットワークIDといずれか)
NetworkInterface.n.IpAddress string

IPアドレス

1）指定されたネットワークが共通グローバル 値 : 付替グローバルIPアドレス
Default : DHCPによるIPアドレス自動発行
2）指定されたネットワークが共通プライベート 値 : 付替プライベートIPアドレス
Default : DHCPによるIPアドレス自動発行
3）指定されたネットワークがプライベートLANでDHCPが有効化されている 値 : IPアドレス | static(手動化)
Default : DHCPによるIPアドレス自動発行
4）指定されたネットワークがプライベートLANでDHCPが無効化されている 値 : static(手動化)

License.n.LicenseName string ライセンス種別
値:
  • RDS
  • Office(Std) (Microsoft Office Standard)
  • Office(Pro Plus) (Microsoft Office Professional Plus)
License.n.LicenseNum string ライセンス数
使用可能文字: 1〜200の数値

応答フィールド

フィールド (項目) 型 説明
RunInstancesResponse - RunInstancesレスポンス
␣requestId string リクエスト識別子
␣reservationId string ※空を返却
␣ownerId string ※空を返却
␣groupSet - 適用したファイアウォールグループ情報
␣␣item - ファイアウォールグループ情報
␣␣␣groupId string ファイアウォールグループ名
␣instancesSet - 作成に成功したサーバーの情報セット
␣␣item - 作成に成功したサーバーの情報
␣␣␣instanceId string サーバー名
␣␣␣instanceUniqueId string サーバーユニークID
␣␣␣imageId string OSイメージ名
␣␣␣instanceState - サーバーの現在のステータス
␣␣␣␣code integer 現在のステータスコード
(A 16-bit unsigned)
備考: 返却値 0,16,80
␣␣␣␣name string 現在のステータス名
値:
  • pending (処理中)
  • running (起動済み)
  • stopped (停止済み)
␣␣␣privateDnsName string プライベートIPアドレス
␣␣␣dnsName string グローバルIPアドレス
␣␣␣reason string 異常時のエラーコード
※instanceStateで異常が発生した場合に返される。
␣␣␣keyName string SSHキー名
␣␣␣admin string 管理者アカウント
␣␣␣instanceType string サーバータイプ
値:
  • e-mini
  • h2-mini
  • mini
  • c-small
  • e-small
  • h2-small
  • small
  • c-small2
  • e-small2
  • h2-small2
  • small2
  • c-small4
  • e-small4
  • h2-small4
  • small4
  • e-small8
  • h2-small8
  • small8
  • e-small16
  • h2-small16
  • small16
  • c-medium
  • e-medium
  • h2-medium
  • medium
  • c-medium4
  • e-medium4
  • h2-medium4
  • medium4
  • c-medium8
  • e-medium8
  • h2-medium8
  • medium8
  • e-medium16
  • h2-medium16
  • medium16
  • e-medium24
  • h2-medium24
  • medium24
  • c-large
  • e-large
  • h2-large
  • large
  • c-large8
  • e-large8
  • h2-large8
  • large8
  • e-large16
  • h2-large16
  • large16
  • e-large24
  • h2-large24
  • large24
  • e-large32
  • h2-large32
  • large32
  • e-extra-large8
  • h2-extra-large8
  • extra-large8
  • e-extra-large16
  • h2-extra-large16
  • extra-large16
  • e-extra-large24
  • h2-extra-large24
  • extra-large24
  • e-extra-large32
  • h2-extra-large32
  • extra-large32
  • e-extra-large48
  • h2-extra-large48
  • extra-large48
  • e-double-large16
  • h2-double-large16
  • double-large16
  • e-double-large24
  • h2-double-large24
  • double-large24
  • e-double-large32
  • h2-double-large32
  • double-large32
  • e-double-large48
  • h2-double-large48
  • double-large48
  • e-double-large64
  • h2-double-large64
  • double-large64
  • e-double-large96
  • h2-double-large96
  • double-large96
  • h2-triple-large32
  • triple-large32
  • h2-triple-large48
  • triple-large48
  • h2-triple-large64
  • triple-large64
  • h2-triple-large96
  • triple-large96
  • h2-triple-large128
  • triple-large128
  • h2-quad-large64
  • quad-large64
  • h2-quad-large96
  • quad-large96
  • h2-quad-large128
  • quad-large128
  • h2-septa-large128
  • septa-large128
␣␣␣launchTime timestamp サーバーの作成日時
値:
  • yyyy-mm-ddThh:mi:ss.sssZ
␣␣␣placement - ゾーン情報
␣␣␣␣availabilityZone string ゾーン情報
␣␣␣platform string OS情報
値:
  • windows
  • redhat
  • centos
  • ubuntu
␣␣␣monitoring - 監視情報
␣␣␣␣state string 監視ステータス
値:
  • monitoring-disabled (disabled)
␣␣␣privateIpAddress string プライベートIPアドレス
␣␣␣ipAddress string グローバルIPアドレス
␣␣␣privateIpAddressV6 string ※空を返却
プライベートIPアドレス（IPv6）
␣␣␣ipAddressV6 string ※空を返却
グローバルIPアドレス（IPv6）
␣␣␣architecture string OSイメージのアーキテクチャ
値:
  • i386
  • x86_64
␣␣␣rootDeviceType string ディスクの種類
値:
  • disk
␣␣␣blockDeviceMapping - 接続しているディスクの情報セット
␣␣␣␣item - 接続しているディスクの情報
␣␣␣␣␣deviceName string ディスクの接続デバイス
値:
  • SCSI (xx:xx)
␣␣␣␣␣ebs - 接続しているディスクの詳細情報
␣␣␣␣␣␣volumeId string ディスク名
␣␣␣␣␣␣volumeUniqueId string ディスクユニークID ※空を返却
␣␣␣␣␣␣status string 接続ステータス
␣␣␣␣␣␣deleteOnTermination string サーバー削除時のディスク消去
値:
  • true (消去)
  • false (消去しない)
␣␣␣accountingType string 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
␣␣␣ipType string グローバルIPアドレスのタイプ
値:
  • static (固定)
  • elastic (付替)
  • snone (グローバルIPなし)
␣␣␣niftyPrivateIpType string プライベートIPアドレスのタイプ
値:
  • static (固定)
  • elastic (付替)
␣␣␣description string メモ
␣␣␣networkInterfaceSet - ネットワークインターフェース情報セット
␣␣␣␣item - ネットワークインターフェース情報
␣␣␣␣␣networkInterfaceId string ※空を返却
␣␣␣␣␣subnetId string ※空を返却
␣␣␣␣␣vpcId string ※空を返却
␣␣␣␣␣description string ※空を返却
␣␣␣␣␣ownerId string ※空を返却
␣␣␣␣␣niftyNetworkId string ネットワークユニークID
␣␣␣␣␣niftyNetworkName string ネットワーク名
␣␣␣␣␣status string ネットワークインターフェースのステータス
値:
  • available (利用可能)
  • in-use (使用中)
  • processing (処理中)
␣␣␣␣␣privateDnsName string ※空を返却
␣␣␣␣␣sourceDestCheck string ※空を返却
␣␣␣␣␣groupSet - 適用しているファイアウォール情報 ※空を返却
␣␣␣␣␣␣item - ファイアウォール情報
␣␣␣␣␣␣␣groupId string ファイアウォールグループ名
␣␣␣␣␣attachment - ネットワークインターフェースの接続情報
␣␣␣␣␣␣attachmentID string ※空を返却
␣␣␣␣␣␣deviceIndex string デバイス番号
␣␣␣␣␣␣status string 接続状態
␣␣␣␣␣␣attachTime string ※空を返却
␣␣␣␣␣␣deleteOnTermination string サーバー削除時のネットワークインターフェース消去
値:
  • true (消去)
␣␣␣␣␣association - ネットワークインターフェースに関連付けられているパブリックIP（固定グローバルIPアドレス、付替IPアドレス）の情報
␣␣␣␣␣␣publicDnsName string ※空を返却
␣␣␣␣␣␣ipOwnerId string ※空を返却
␣␣␣␣␣privateIpAddressesSet - ※空を返却
␣␣␣␣␣␣item - インスタンスに付属するプライベートIP
␣␣␣␣␣␣␣association - 付替IPアドレスの関連付け情報
␣␣␣␣␣␣␣␣ipOwnerId string 付替IPアドレスのオーナーID
␣␣␣␣␣␣␣␣publicDnsName string パブリックDNS名
␣␣␣␣␣␣␣␣publicIp string ネットワークインターフェースのパブリックIP
␣␣␣␣␣␣␣primary boolean ネットワークインターフェースのプライマリープライベートIP情報
␣␣␣␣␣␣␣privateDnsName string プライベートDNS名
␣␣␣␣␣␣␣privateIpAddress string ネットワークインターフェースのプライベートIP
␣␣␣isoImage - ※空を返却
適用しているISOイメージの情報
␣␣␣␣item - 適用しているISOイメージの情報
␣␣␣␣␣isoImageId string 適用しているISOイメージユニークID
␣␣␣␣␣isoImageName string 適用しているISOイメージ名

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=RunInstances
  &ImageId=1
  &KeyName=sshkey01
  &InstanceType=medium
  &InstanceId=server04
  &Description=memo
  &NetworkInterface.1.IpAddress=111.111.111.111
  &NetworkInterface.1.NetworkId=net-COMMON_GLOBAL
  &NetworkInterface.2.IpAddress=192.168.0.1
  &NetworkInterface.2.NetworkName=network
  &SecurityGroup.1=group
  &CommonParams

応答サンプル

    <RunInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <reservationId></reservationId>
  <ownerId></ownerId>
  <groupSet>
    <item>
      <groupId>group</groupId>
    </item>
  </groupSet>
  <instancesSet>
    <item>
      <instanceId>server04</instanceId>
      <instanceUniqueId>i-efgh1234</instanceUniqueId>
      <imageId>customimage</imageId>
      <instanceState>
        <code>0</code>
        <name>pending</name>
      </instanceState>
      <privateDnsName>192.168.0.1</privateDnsName>
      <dnsName>111.111.111.111</dnsName>
      <admin></admin>
      <instanceType>medium</instanceType>
      <launchTime>2010-05-17T11:22:33.456+09:00</launchTime>
      <placement>
        <availabilityZone>east-11</availabilityZone>
      </placement>
      <platform>centos</platform>
      <monitoring>
        <state>monitoring-disable</state>
      </monitoring>
      <privateIpAddress>192.168.0.1</privateIpAddress>
      <ipAddress>111.111.111.111</ipAddress>
      <privateIpAddressV6></privateIpAddressV6>
      <ipAddressV6></ipAddressV6>
      <architecture>x86_64</architecture>
      <rootDeviceType>disk</rootDeviceType>
      <blockDeviceMapping>
        <item>
          <deviceName>SCSI (0:1)</deviceName>
          <ebs>
            <volumeId>disk0001</volumeId>
            <volumeUniqueId/>
            <status>attaching</status>
            <deleteOnTermination>false</deleteOnTermination>
          </ebs>
        </item>
      </blockDeviceMapping>
      <accountingType>2</accountingType>
      <ipType>elastic</ipType>
      <niftyPrivateIpType>static</niftyPrivateIpType>
      <description>memo</description>
      <networkInterfaceSet>
        <item>
          <networkInterfaceId></networkInterfaceId>
          <subnetId></subnetId>
          <vpcId></vpcId>
          <description></description>
          <ownerId></ownerId>
          <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
          <status>processing</status>
          <privateDnsName></privateDnsName>
          <sourceDestCheck></sourceDestCheck>
          <groupSet></groupSet>
          <attachment>
            <attachmentID></attachmentID>
            <deviceIndex>0</deviceIndex>
            <status>attached</status>
            <attachTime></attachTime>
            <deleteOnTermination>true</deleteOnTermination>
          </attachment>
          <association>
            <publicDnsName></publicDnsName>
            <ipOwnerId></ipOwnerId>
          </association>
          <privateIpAddressesSet></privateIpAddressesSet>
        </item>
        <item>
          <networkInterfaceId></networkInterfaceId>
          <subnetId></subnetId>
          <vpcId></vpcId>
          <description></description>
          <ownerId></ownerId>
          <niftyNetworkId>net-0glomv00</niftyNetworkId>
          <niftyNetworkName>network</niftyNetworkName>
          <status>processing</status>
          <privateDnsName></privateDnsName>
          <sourceDestCheck></sourceDestCheck>
          <groupSet></groupSet>
          <attachment>
            <attachmentID></attachmentID>
            <deviceIndex>0</deviceIndex>
            <status>attached</status>
            <attachTime></attachTime>
            <deleteOnTermination>true</deleteOnTermination>
          </attachment>
          <privateIpAddressesSet></privateIpAddressesSet>
        </item>
      </networkInterfaceSet>
      <isoImage/>
    </item>
  </instancesSet>
</RunInstancesResponse>

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

推奨画面サイズ　1024×768 以上

ページの先頭へ