本文へジャンプします。

ニフクラ APIリファレンス

nifty-run-instances

処理概要

API「 RunInstances 」が実行されます。

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

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

処理が失敗した場合、サーバーは作成されず、エラーが返されます。

またファイアウォール機能を提供していない環境でファイアウォールグループを指定して実行した場合は、エラーが返されます。

Red Hat Enterprise Linux または Microsoft SPLAライセンスが必要なOSを指定した場合は、以下の利用規約と仕様をご確認の上、パラメーター「agreement」を指定します。「agreement」を指定しない場合、サーバーの作成はできません。

ニフクラ利用規約

ニフクラ ライセンス仕様

コマンド構文

nifty-run-instances OSイメージID [オプション]

オプション

オプション 短縮 説明 必須
--key KEYPAIR -k SSHキーを指定します。 (windows OS以外○)
--instance-type TYPE -t サーバータイプを指定します。
e-mini | mini | c-small | e-small | small | c-small2 | e-small2 | small2 | c-small4 | e-small4 | small4 | e-small8 | small8 | e-small16 | small16 | c-medium | e-medium | medium | c-medium4 | e-medium4 | medium4 | c-medium8 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | c-large | e-large | large | c-large8 | e-large8 | large8 | e-large16 | large16| e-large24 | large24 | e-large32 | large32 | e-extra-large8 | extra-large8 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-extra-large48 | extra-large48 | e-double-large16 | double-large16 | e-double-large24 | double-large24 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96 | triple-large48 | triple-large64 | triple-large96 | triple-large128 | quad-large128
--disable-api-termination BOOLEAN APIからのサーバー削除の可否情報を指定します。
true (削除不可)|false (削除可)
--accounting-type ACTYPE 利用料金タイプを指定します。
1 (月額課金)|2 (従量課金)
--instance-id INSTANCE サーバー名を指定します。
--admin ADMIN 管理者アカウントを指定します。 (windows OSのみ○)
--password PASSWORD 管理者アカウントのパスワードを指定します。 (windows OSのみ○)
--ip-type IPTYPE IPアドレスのタイプを指定します。
static(固定化)|elastic(付替)|none(グローバルIPなし)
--group GROUP -g 適用するファイアウォールグループを指定します。
--user-data-base64 スクリプト Base64エンコード済みのサーバー起動時スクリプトを指定します。
--user-data-plain スクリプト サーバー起動時スクリプトを指定します。
--user-data-fileファイル -f Base64エンコード済みのサーバー起動時スクリプトファイルを指定します。
--user-data-file-base64ファイル Base64エンコード済みのサーバー起動時スクリプトファイルを指定します。
--user-data-file-plainファイル サーバー起動時スクリプトファイルを指定します。
--availability-zone ZONE -z サーバーのゾーンを指定します。
--public-ip IPアドレス 付替グローバルIPアドレスを指定します。 (IPTYPEがelasticのみ○)
--description DESCRIPTION サーバーのメモを指定します。
--network "network-id=value, network-name=value, ip-address=value", [ --network " network-id=value, network-name=value, ip-address=value] サーバーに設定するネットワークID、ネットワーク名、IPアドレスを指定します。
(network-idとnetwork-nameはどちらか1つを指定します。)
・network-id
net-COMMON_GLOBAL (共通グローバル)|net-COMMON_PRIVATE (共通プライベート)|プライベートLANのネットワークID
・ip-address
1)指定されたネットワークが共通グローバル
値 : 付替グローバルIPアドレス
Default : DHCPによるIPアドレス自動発行
2)指定されたネットワークが共通プライベート
値 : 付替プライベートIPアドレス
Default : DHCPによるIPアドレス自動発行
3)指定されたネットワークがプライベートLANでDHCPが有効化されている
値 : IPアドレス|static(手動化)
Default : DHCPによるIPアドレス自動発行
4)指定されたnetworkがプライベートLANでDHCPが無効化されている
値 : static(手動化)
--license "lincense-name=xxx, license-num=xxx" ライセンス種別・ライセンス数を指定します。
--agreement BOOLEAN Red Hat Enterprise Linux または Microsoft SPLAライセンスが必要なOSを指定した場合の同意を指定します。
true (同意する)|false (同意しない)

出力要素

  • RESERVATION / reservationId
  • RESERVATION / ownerId
  • GROUP / groupId
  • INSTANCE / instanceId
  • INSTANCE / imageId
  • INSTANCE / instanceUniqueId
  • INSTANCE / dnsName
  • INSTANCE / privateDnsName
  • INSTANCE / instanceState.name
  • INSTANCE / keyName
  • INSTANCE / LaunchIndex
  • INSTANCE / productCodeId
  • INSTANCE / instanceType
  • INSTANCE / launchTime
  • INSTANCE / availabilityZone
  • INSTANCE / kernelId
  • INSTANCE / ramdiskId
  • INSTANCE / monitoring.status
  • INSTANCE / ipAddress
  • INSTANCE / privateIpAddress
  • INSTANCE / ipAddressV6
  • INSTANCE / privateIpAddressV6
  • INSTANCE / subnetId
  • INSTANCE / vpcId
  • INSTANCE / rootDeviceType
  • INSTANCE / admin
  • INSTANCE / accountingType
  • INSTANCE / ipType
  • INSTANCE / privateIpType
  • INSTANCE / architecture
  • INSTANCE / platform
  • BLOCKDEVICE / deviceName
  • BLOCKDEVICE / volumeId
  • BLOCKDEVICE / status
  • BLOCKDEVICE / deleteOnTermination
  • NETWORK_INTERFACE / niftyNetworkId
  • NETWORK_INTERFACE / niftyNetworkName
  • NETWORK_INTERFACE / status
  • NETWORK_INTERFACE / macAddress
  • NETWORK_INTERFACE / privateIpAddress
  • NETWORK_INTERFACE / privateIpAddressV6
  • NETWORK_INTERFACE_ATTACHMENT / deviceIndex
  • NETWORK_INTERFACE_ATTACHMENT / status
  • NETWORK_INTERFACE_ATTACHMENT / deleteOnTermination
  • NETWORK_INTERFACE_ASSOCIATION / publicIp
  • NETWORK_INTERFACE_ASSOCIATION / publicIpV6

実行サンプル

PROMPT>nifty-run-instances 1 --key keyname02 --instance-type mini --disable-api-termination true --accounting-type 1 --instance-id server02 --admin adminadmin --password password -availability-zone east-11
RESERVATION
INSTANCE server02 i-abfd1234 1 111.171.201.2 10.10.10.11 running keyname02 mini 2010-08-17T01:15:16.223Z east-11 monitoring-disabled 111.171.201.2 10.10.10.11 disk adminadmin 1 static static x86_64 centos
BLOCKDEVICE SCSI(0:0) disk01 attaching false
NETWORK_INTERFACE net-COMMON_GLOBAL available 00-00-00-00-00-00
NETWORK_INTERFACE_ATTACHMENT 0 attaching true
NETWORK_INTERFACE_ASSOCIATION 111.171.201.2
NETWORK_INTERFACE net-COMMON_PRIVATE available 00-00-00-00-00-00 10.10.10.11 2001:0db8:bd05:01d2:288a:1fc0:0001:10ee
NETWORK_INTERFACEATTACHMENT 0 attaching true

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

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